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 | .. 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
  73 +---------------------------------------------------------------+
  74 +---------------------------------------------------------------+
  75 | .. module:: GetBoundary                                       |
  76 |                                                               |
  77 | **GetBoundary(boundary_name)**                                |
  78 |     Retourne l'instance de la classe ``boundary`` connue par  |
  79 |     son nom                                                   |
  80 |                                                               |
  81 |     - ``boundary_name`` : le nom de la frontière              |
  82 +---------------------------------------------------------------+
  83 | .. module:: GetAllBoundarysName                               |
  84 |                                                               |
  85 | **GetAllBoundarysName()**                                     |
  86 |     Retourne la liste des noms de toutes les frontières créées|
  87 |                                                               |
  88 +---------------------------------------------------------------+
  89
  90 Méthodes de la classe cas
  91 """""""""""""""""""""""""
  92 Voir également dans dans :ref:`tui_create_case`.
  93
  94 +---------------------------------------------------------------+
  95 +---------------------------------------------------------------+
  96 | .. module:: AddBoundaryGroup                                  |
  97 |                                                               |
  98 | **AddBoundaryGroup(boundary, group)**                         |
  99 |     Ajoute une frontière à la définition du cas               |
 100 |                                                               |
 101 |     - ``boundary`` : nom d'une frontière courbe à suivre      |
 102 |                                                               |
 103 |     Pour une frontière discrète :                             |
 104 |                                                               |
 105 |     . si toutes les lignes courbes sont suivies, le second    |
 106 |       argument est une chaîne vide.                           |
 107 |     . si seulement certaines lignes courbes sont suivies,     |
 108 |       ``group`` est le nom d'un groupe de segments à suivre.  |
 109 |                                                               |
 110 |     Pour une frontière analytique :                           |
 111 |                                                               |
 112 |     - ``group`` : nom d'un groupe de faces placées sur la     |
 113 |       frontière                                               |
 114 +---------------------------------------------------------------+
 115
 116 Méthodes de la classe boundary
 117 """"""""""""""""""""""""""""""
 118
 119 +---------------------------------------------------------------+
 120 +---------------------------------------------------------------+
 121 | .. module:: GetName                                           |
 122 |                                                               |
 123 | **GetName()**                                                 |
 124 |     Retourne le nom de la frontière                           |
 125 +---------------------------------------------------------------+
 126 | .. module:: GetType                                           |
 127 |                                                               |
 128 | **GetType()**                                                 |
 129 |     Retourne le type de la frontière :                        |
 130 |                                                               |
 131 |         * 0 : discrète                                        |
 132 |         * 1 : cylindre                                        |
 133 |         * 2 : sphère                                          |
 134 |         * 3 : cône défini par un axe et un angle              |
 135 |         * 4 : cône défini par deux rayons                     |
 136 +---------------------------------------------------------------+
 137 | .. module:: GetCoords                                         |
 138 |                                                               |
 139 | **GetCoords()**                                               |
 140 |     Retourne un tableau contenant les coordonnées de la       |
 141 |     frontière dans l'ordre d'entrée dans le CreateBoundaryXXXX|
 142 |     associé                                                   |
 143 +---------------------------------------------------------------+
 144 | .. index:: single: Delete                                     |
 145 |                                                               |
 146 | **Delete()**                                                  |
 147 |     Detruit la frontière.                                     |
 148 |     Pour une frontière discrète, le fichier du maillage       |
 149 |     associé est conservé.                                     |
 150 |                                                               |
 151 |     Retourne un entier :                                      |
 152 |         * 0 : destruction réussie                             |
 153 |         * autre valeur : problème                             |
 154 +---------------------------------------------------------------+
 155
 156
 157 Exemple
 158 """""""
 159 Création d'une frontière discrète, d'une frontière sphèrique, puis d'une frontière cylindrique : ::
 160
 161     inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
 162     fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
 163     fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
 164
 165
 166 Saisie graphique correspondante
 167 """""""""""""""""""""""""""""""
 168 Consulter :ref:`gui_create_boundary`