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 :doc:`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:: CreateBoundaryCAO                                                          |
  20 |                                                                                        |
  21 | **CreateBoundaryCAO(boundary_name, xao_file)**                                         |
  22 |     Retourne une instance de la classe ``boundary`` de type CAO après sa création      |
  23 |                                                                                        |
  24 |     - ``boundary_name`` : le nom de la frontière CAO                                   |
  25 |     - ``xao_file`` : le nom du fichier contenant cette CAO, au format XAO              |
  26 +----------------------------------------------------------------------------------------+
  27 | .. module:: CreateBoundaryDi                                                           |
  28 |                                                                                        |
  29 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)**                              |
  30 |     Retourne une instance de la classe ``boundary`` de type discret après sa création  |
  31 |                                                                                        |
  32 |     - ``boundary_name`` : le nom de la frontière discrète                              |
  33 |     - ``mesh_name`` : le nom du maillage de la frontière                               |
  34 |     - ``mesh_file`` : le nom du fichier contenant ce maillage, au format MED           |
  35 +----------------------------------------------------------------------------------------+
  36 | .. module:: CreateBoundaryCylinder                                                     |
  37 |                                                                                        |
  38 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)**       |
  39 |     Retourne une instance de la classe ``boundary`` analytique de type cylindrique     |
  40 |     après sa création                                                                  |
  41 |                                                                                        |
  42 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cylindre      |
  43 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées d'un point sur l'axe du cylindre      |
  44 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
  45 |     - ``R`` : rayon du cylindre                                                        |
  46 +----------------------------------------------------------------------------------------+
  47 | .. module:: CreateBoundarySphere                                                       |
  48 |                                                                                        |
  49 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)**                           |
  50 |     Retourne une instance de la classe ``boundary`` analytique de type sphérique       |
  51 |     après sa création                                                                  |
  52 |                                                                                        |
  53 |     - ``boundary_name`` : le nom de la frontière analytique basée sur une sphere       |
  54 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère                |
  55 |     - ``R`` : rayon de la sphère                                                       |
  56 +----------------------------------------------------------------------------------------+
  57 | .. module:: CreateBoundaryConeA                                                        |
  58 |                                                                                        |
  59 | **CreateBoundaryConeA(boundary_name, Xaxe, Yaxe, Zaxe, Angle, Xcen, Ycen, Zcen)**      |
  60 |     Retourne une instance de la classe ``boundary`` analytique de type conique         |
  61 |     après sa création                                                                  |
  62 |                                                                                        |
  63 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cône          |
  64 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe (non nécessairement normé)       |
  65 |     - ``Angle`` : angle d'ouverture du cône en degre (entre 0 et 90)                   |
  66 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du cône                     |
  67 +----------------------------------------------------------------------------------------+
  68 | .. module:: CreateBoundaryConeR                                                        |
  69 |                                                                                        |
  70 | **CreateBoundaryConeR(boundary_name, Xc1, Yc1, Zc1, R1, Xc2, Yc2, Zc2, R2)**           |
  71 |     Retourne une instance de la classe ``boundary`` analytique de type conique         |
  72 |     après sa création                                                                  |
  73 |                                                                                        |
  74 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un cône          |
  75 |     - ``Xc1``, ``Yc1``, ``Zc1`` : coordonnées du premier centre du cône                |
  76 |     - ``R1`` : rayon du cône à la hauteur du premier centre                            |
  77 |     - ``Xc2``, ``Yc2``, ``Zc2`` : coordonnées du second centre du cône                 |
  78 |     - ``R2`` : rayon du cône à la hauteur du second centre                             |
  79 +----------------------------------------------------------------------------------------+
  80 | .. module:: CreateBoundaryTorus                                                        |
  81 |                                                                                        |
  82 | **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
  83 |     Retourne une instance de la classe ``boundary`` analytique de type torique         |
  84 |     après sa création                                                                  |
  85 |                                                                                        |
  86 |     - ``boundary_name`` : le nom de la frontière analytique basée sur un tore          |
  87 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du tore                     |
  88 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                                  |
  89 |     - ``RRev`` : rayon de révolution du tore                                           |
  90 |     - ``RPri`` : rayon primaire du tore                                                |
  91 +----------------------------------------------------------------------------------------+
  92
  93 +---------------------------------------------------------------+
  94 +---------------------------------------------------------------+
  95 | .. module:: GetBoundary                                       |
  96 |                                                               |
  97 | **GetBoundary(boundary_name)**                                |
  98 |     Retourne l'instance de la classe ``boundary`` connue par  |
  99 |     son nom                                                   |
 100 |                                                               |
 101 |     - ``boundary_name`` : le nom de la frontière              |
 102 +---------------------------------------------------------------+
 103 | .. module:: GetAllBoundarysName                               |
 104 |                                                               |
 105 | **GetAllBoundarysName()**                                     |
 106 |     Retourne la liste des noms de toutes les frontières       |
 107 |     existantes                                                |
 108 |                                                               |
 109 +---------------------------------------------------------------+
 110
 111 Méthodes de la classe cas
 112 *************************
 113 Voir également dans :doc:`tui_create_case`.
 114
 115 +---------------------------------------------------------------+
 116 +---------------------------------------------------------------+
 117 | .. module:: AddBoundary                                       |
 118 |                                                               |
 119 | **AddBoundary(boundary)**                                     |
 120 |     Ajoute une frontière à la définition du cas               |
 121 |                                                               |
 122 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
 123 +---------------------------------------------------------------+
 124 | .. module:: AddBoundaryGroup                                  |
 125 |                                                               |
 126 | **AddBoundaryGroup(boundary, group)**                         |
 127 |     Ajoute une frontière à la définition du cas en précisant  |
 128 |     les groupes associés                                      |
 129 |                                                               |
 130 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
 131 |                                                               |
 132 |     Pour une frontière discrète ou CAO :                      |
 133 |                                                               |
 134 |     - ``group`` : nom d'un groupe de mailles à suivre         |
 135 |                                                               |
 136 |     Pour une frontière analytique :                           |
 137 |                                                               |
 138 |     - ``group`` : nom d'un groupe de faces placées sur la     |
 139 |       frontière                                               |
 140 +---------------------------------------------------------------+
 141
 142 Méthodes de la classe boundary
 143 ******************************
 144
 145 +---------------------------------------------------------------+
 146 +---------------------------------------------------------------+
 147 | .. module:: GetName                                           |
 148 |                                                               |
 149 | **GetName()**                                                 |
 150 |     Retourne le nom de la frontière                           |
 151 +---------------------------------------------------------------+
 152 | .. module:: GetType                                           |
 153 |                                                               |
 154 | **GetType()**                                                 |
 155 |     Retourne le type de la frontière :                        |
 156 |                                                               |
 157 |         * -1 : CAO                                            |
 158 |         * 0 : discrète                                        |
 159 |         * 1 : cylindre                                        |
 160 |         * 2 : sphère                                          |
 161 |         * 3 : cône défini par un axe et un angle              |
 162 |         * 4 : cône défini par deux rayons                     |
 163 |         * 5 : tore                                            |
 164 +---------------------------------------------------------------+
 165 | .. module:: GetCoords                                         |
 166 |                                                               |
 167 | **GetCoords()**                                               |
 168 |     Retourne un tableau contenant les coordonnées de la       |
 169 |     frontière dans l'ordre d'entrée dans le CreateBoundaryXXXX|
 170 |     associé                                                   |
 171 +---------------------------------------------------------------+
 172 | .. module:: Delete                                            |
 173 |                                                               |
 174 | **Delete()**                                                  |
 175 |     Détruit la frontière.                                     |
 176 |     Pour une frontière discrète, le fichier du maillage       |
 177 |     associé est conservé.                                     |
 178 |     Pour une frontière CAO, le fichier de la géométrie        |
 179 |     associée est conservé.                                    |
 180 |                                                               |
 181 |     Retourne un entier :                                      |
 182 |         * 0 : destruction réussie                             |
 183 |         * autre valeur : problème                             |
 184 +---------------------------------------------------------------+
 185
 186
 187 Exemple
 188 *******
 189 Création d'une frontière CAO : ::
 190
 191     la_cao = homard.CreateBoundaryCAO("BLOC", dircase+'/tutorial_6.xao')
 192
 193 Création d'une frontière discrète, d'une frontière sphérique, puis d'une frontière cylindrique : ::
 194
 195     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
 196     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
 197     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
 198
 199
 200 Saisie graphique correspondante
 201 *******************************
 202 Consulter :doc:`gui_create_boundary`