doc/fr/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 | .. module:: CreateBoundaryConeA                                                        |
  50 |                                                                                        |
  51 | **CreateBoundaryConeA(boundary_name, Xaxe, Yaxe, Zaxe, Angle, Xcen, Ycen, Zcen)**      |
  52 |     Retourne une instance de la classe ``boundary`` analytique de type conique         |
  53 |     après sa création                                                                  |
  54 |                                                                                        |
  55 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cône          |
  56 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe (non nécessairement normé)       |
  57 |     - ``Angle`` : angle d'ouverture du cône en degre (entre 0 et 90)                   |
  58 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du cône                     |
  59 +----------------------------------------------------------------------------------------+
  60 | .. module:: CreateBoundaryConeR                                                        |
  61 |                                                                                        |
  62 | **CreateBoundaryConeR(boundary_name, Xc1, Yc1, Zc1, R1, Xc2, Yc2, Zc2, R2)**           |
  63 |     Retourne une instance de la classe ``boundary`` analytique de type conique         |
  64 |     après sa création                                                                  |
  65 |                                                                                        |
  66 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cône          |
  67 |     - ``Xc1``, ``Yc1``, ``Zc1`` : coordonnées du premier centre du cône                |
  68 |     - ``R1`` : rayon du cône à la hauteur du premier centre                            |
  69 |     - ``Xc2``, ``Yc2``, ``Zc2`` : coordonnées du second centre du cône                 |
  70 |     - ``R2`` : rayon du cône à la hauteur du second centre                             |
  71 +----------------------------------------------------------------------------------------+
  72 | .. module:: CreateBoundaryTorus                                                        |
  73 |                                                                                        |
  74 | **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
  75 |     Retourne une instance de la classe ``boundary`` analytique de type torique         |
  76 |     après sa création                                                                  |
  77 |                                                                                        |
  78 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un tore          |
  79 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du tore                     |
  80 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
  81 |     - ``RRev`` : rayon de révolution du tore                                           |
  82 |     - ``RPri`` : rayon primaire du tore                                                |
  83 +----------------------------------------------------------------------------------------+
  84
  85 +---------------------------------------------------------------+
  86 +---------------------------------------------------------------+
  87 | .. module:: GetBoundary                                       |
  88 |                                                               |
  89 | **GetBoundary(boundary_name)**                                |
  90 |     Retourne l'instance de la classe ``boundary`` connue par  |
  91 |     son nom                                                   |
  92 |                                                               |
  93 |     - ``boundary_name`` : le nom de la frontière              |
  94 +---------------------------------------------------------------+
  95 | .. module:: GetAllBoundarysName                               |
  96 |                                                               |
  97 | **GetAllBoundarysName()**                                     |
  98 |     Retourne la liste des noms de toutes les frontières       |
  99 |     existantes                                                |
 100 |                                                               |
 101 +---------------------------------------------------------------+
 102
 103 Méthodes de la classe cas
 104 *************************
 105 Voir également dans :ref:`tui_create_case`.
 106
 107 +---------------------------------------------------------------+
 108 +---------------------------------------------------------------+
 109 | .. module:: AddBoundaryGroup                                  |
 110 |                                                               |
 111 | **AddBoundaryGroup(boundary, group)**                         |
 112 |     Ajoute une frontière à la définition du cas               |
 113 |                                                               |
 114 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
 115 |                                                               |
 116 |     Pour une frontière discrète :                             |
 117 |                                                               |
 118 |     . si toutes les lignes courbes sont suivies, le second    |
 119 |     argument est une chaîne vide.                             |
 120 |                                                               |
 121 |     . si seulement certaines lignes courbes sont suivies,     |
 122 |     ``group`` est le nom d'un groupe de segments à suivre.    |
 123 |                                                               |
 124 |     Pour une frontière analytique :                           |
 125 |                                                               |
 126 |     - ``group`` : nom d'un groupe de faces placées sur la     |
 127 |       frontière                                               |
 128 +---------------------------------------------------------------+
 129
 130 Méthodes de la classe boundary
 131 ******************************
 132
 133 +---------------------------------------------------------------+
 134 +---------------------------------------------------------------+
 135 | .. module:: GetName                                           |
 136 |                                                               |
 137 | **GetName()**                                                 |
 138 |     Retourne le nom de la frontière                           |
 139 +---------------------------------------------------------------+
 140 | .. module:: GetType                                           |
 141 |                                                               |
 142 | **GetType()**                                                 |
 143 |     Retourne le type de la frontière :                        |
 144 |                                                               |
 145 |         * 0 : discrète                                        |
 146 |         * 1 : cylindre                                        |
 147 |         * 2 : sphère                                          |
 148 |         * 3 : cône défini par un axe et un angle              |
 149 |         * 4 : cône défini par deux rayons                     |
 150 |         * 5 : tore                                            |
 151 +---------------------------------------------------------------+
 152 | .. module:: GetCoords                                         |
 153 |                                                               |
 154 | **GetCoords()**                                               |
 155 |     Retourne un tableau contenant les coordonnées de la       |
 156 |     frontière dans l'ordre d'entrée dans le CreateBoundaryXXXX|
 157 |     associé                                                   |
 158 +---------------------------------------------------------------+
 159 | .. module:: Delete                                            |
 160 |                                                               |
 161 | **Delete()**                                                  |
 162 |     Detruit la frontière.                                     |
 163 |     Pour une frontière discrète, le fichier du maillage       |
 164 |     associé est conservé.                                     |
 165 |                                                               |
 166 |     Retourne un entier :                                      |
 167 |         * 0 : destruction réussie                             |
 168 |         * autre valeur : problème                             |
 169 +---------------------------------------------------------------+
 170
 171
 172 Exemple
 173 *******
 174 Création d'une frontière discrète, d'une frontière sphèrique, puis d'une frontière cylindrique : ::
 175
 176     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
 177     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
 178     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
 179
 180
 181 Saisie graphique correspondante
 182 *******************************
 183 Consulter :ref:`gui_create_boundary`