doc/tui_create_boundary.rst

   1 .. _tui_create_boundary:
   2
   3 La frontière
   4 ============
   5
   6 .. index:: single: boundary
   7 .. index:: single: frontière
   8 .. index:: single: cylindre
   9 .. index:: single: sphere
  10
  11 Les variables sont décrites dans :ref:`gui_create_boundary`.
  12
  13 Méthodes de la classe homard
  14 """"""""""""""""""""""""""""
  15 Ces méthodes retournent une instance de la classe boundary.
  16
  17 +----------------------------------------------------------------------------------------+
  18 +----------------------------------------------------------------------------------------+
  19 | .. module:: CreateBoundaryDi                                                           |
  20 |                                                                                        |
  21 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)**                              |
  22 |     Retourne une instance de la classe ``boundary`` de type discret après sa création  |
  23 |                                                                                        |
  24 |     - ``boundary_name`` : le nom de la frontière discrète                              |
  25 |     - ``mesh_name`` : le nom du maillage de la frontière                               |
  26 |     - ``mesh_file`` : le nom du fichier contenant ce maillage                          |
  27 +----------------------------------------------------------------------------------------+
  28 | .. module:: CreateBoundaryCylinder                                                     |
  29 |                                                                                        |
  30 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)**       |
  31 |     Retourne une instance de la classe ``boundary`` analytique de type cylindrique     |
  32 |     après sa création                                                                  |
  33 |                                                                                        |
  34 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cylindre      |
  35 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées d'un point sur l'axe du cylindre      |
  36 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
  37 |     - ``R`` : rayon du cylindre                                                        |
  38 +----------------------------------------------------------------------------------------+
  39 | .. module:: CreateBoundarySphere                                                       |
  40 |                                                                                        |
  41 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)**                           |
  42 |     Retourne une instance de la classe ``boundary`` analytique de type sphérique       |
  43 |     après sa création                                                                  |
  44 |                                                                                        |
  45 |     - ``boundary_name`` : le nom de la frontière analytique basée sur une sphere       |
  46 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère                |
  47 |     - ``R`` : rayon de la sphère                                                       |
  48 +----------------------------------------------------------------------------------------+
  49
  50 +---------------------------------------------------------------+
  51 +---------------------------------------------------------------+
  52 | .. module:: GetBoundary                                       |
  53 |                                                               |
  54 | **GetBoundary(boundary_name)**                                |
  55 |     Retourne l'instance de la classe ``boundary`` connue par  |
  56 |     son nom                                                   |
  57 |                                                               |
  58 |     - ``boundary_name`` : le nom de la frontière              |
  59 +---------------------------------------------------------------+
  60 | .. module:: GetAllBoundarysName                               |
  61 |                                                               |
  62 | **GetAllBoundarysName()**                                     |
  63 |     Retourne la liste des noms de toutes les frontières créées|
  64 |                                                               |
  65 +---------------------------------------------------------------+
  66
  67 Méthodes de la classe boundary
  68 """"""""""""""""""""""""""""""
  69
  70 +-------------------------------------------------------------------+
  71 +-------------------------------------------------------------------+
  72 | .. module:: GetName                                               |
  73 |                                                                   |
  74 | **GetName()**                                                     |
  75 |     Retourne le nom de la frontière                               |
  76 +-------------------------------------------------------------------+
  77 | .. module:: GetType                                               |
  78 |                                                                   |
  79 | **GetType()**                                                     |
  80 |     Retourne le type de la frontière :                            |
  81 |                                                                   |
  82 |         * 0 : discrète                                            |
  83 |         * 1 : cylindre                                            |
  84 |         * 2 : sphère                                              |
  85 +-------------------------------------------------------------------+
  86 | .. module:: GetCoords                                             |
  87 |                                                                   |
  88 | **GetCoords()**                                                   |
  89 |     Retourne un tableau contenant les coordonnées de la frontière |
  90 |     dans l'ordre d'entrée dans le CreateBoundaryXXXX associé      |
  91 +-------------------------------------------------------------------+
  92
  93
  94 Exemple
  95 """""""
  96 Création d'une frontière discrète, d'une frontière sphèrique, puis d'une frontière cylindrique : ::
  97
  98     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
  99     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
 100     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
 101
 102
 103 Saisie graphique correspondante
 104 """""""""""""""""""""""""""""""
 105 Consulter :ref:`gui_create_boundary`