doc/fr/tui_create_zone.rst

   1 .. _tui_create_zone:
   2
   3 La zone
   4 #######
   5
   6 .. index:: single: zone
   7 .. index:: single: boite
   8 .. index:: single: sphere
   9 .. index:: single: cylindre
  10 .. index:: single: tuyau
  11 .. index:: single: disque
  12 .. index:: single: disque avec trou
  13 .. index:: single: 2D
  14
  15 Les variables sont décrites dans :ref:`gui_create_zone`.
  16
  17 Méthodes de la classe homard
  18 ****************************
  19
  20 Ces méthodes retournent une instance de la classe zone.
  21
  22 +----------------------------------------------------------------------------------+
  23 +----------------------------------------------------------------------------------+
  24 | .. module:: CreateZoneBox                                                        |
  25 |                                                                                  |
  26 | **CreateZoneBox(zone_name, Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)**                 |
  27 |     Retourne une instance de la classe ``zone`` de type parallélépipèdique       |
  28 |     après sa création                                                            |
  29 |                                                                                  |
  30 |     - ``zone_name`` : le nom de la zone basée sur un parallélépipède             |
  31 |     - ``Xmin``, ``Xmax`` : coordonnées extrêmes selon X                          |
  32 |     - ``Ymin``, ``Ymax`` : coordonnées extrêmes selon Y                          |
  33 |     - ``Zmin``, ``Zmax`` : coordonnées extrêmes selon Z                          |
  34 +----------------------------------------------------------------------------------+
  35 | .. module:: CreateZoneCylinder                                                   |
  36 |                                                                                  |
  37 | **CreateZoneCylinder(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H)**   |
  38 |     Retourne une instance de la classe ``zone`` de type cylindrique              |
  39 |     après sa création                                                            |
  40 |                                                                                  |
  41 |     - ``zone_name`` : le nom de la zone basée sur un cylindre                    |
  42 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
  43 |       positionné sur l'axe                                                       |
  44 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                            |
  45 |     - ``R`` : rayon du cylindre                                                  |
  46 |     - ``H`` : hauteur du cylindre                                                |
  47 +----------------------------------------------------------------------------------+
  48 | .. module:: CreateZonePipe                                                       |
  49 |                                                                                  |
  50 | **CreateZonePipe(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H, Rint)** |
  51 |     Retourne une instance de la classe ``zone`` de type tuyau                    |
  52 |     après sa création                                                            |
  53 |                                                                                  |
  54 |     - ``zone_name`` : le nom de la zone basée sur un tuyau                       |
  55 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
  56 |       positionné sur l'axe                                                       |
  57 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                            |
  58 |     - ``R`` : rayon externe du tuyau                                             |
  59 |     - ``H`` : hauteur du tuyau                                                   |
  60 |     - ``R`` : rayon interne du tuyau                                             |
  61 +----------------------------------------------------------------------------------+
  62 | .. module:: CreateZoneSphere                                                     |
  63 |                                                                                  |
  64 | **CreateZoneSphere(zone_name, Xcen, Ycen, Zcen, R)**                             |
  65 |     Retourne une instance de la classe ``zone`` de type sphérique                |
  66 |     après sa création                                                            |
  67 |                                                                                  |
  68 |     - ``zone_name`` : le nom de la zone basée sur une sphère                     |
  69 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère          |
  70 |     - ``R`` : rayon de la sphère                                                 |
  71 +----------------------------------------------------------------------------------+
  72 | .. module:: CreateZoneBox2D                                                      |
  73 |                                                                                  |
  74 | **CreateZoneBox2D(zone_name, Umin, Umax, Vmin, Vmax, Orient)**                   |
  75 |     Retourne une instance de la classe ``zone`` de type rectangulaire            |
  76 |     après sa création                                                            |
  77 |                                                                                  |
  78 |     - ``zone_name`` : le nom de la zone basée sur un rectangle                   |
  79 |     - ``Umin``, ``Umax`` : coordonnées extrêmes pour la 1ère dimension           |
  80 |     - ``Vmin``, ``Vmax`` : coordonnées extrêmes pour la 2nde dimension           |
  81 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
  82 +----------------------------------------------------------------------------------+
  83 | .. module:: CreateZoneDisk                                                       |
  84 |                                                                                  |
  85 | **CreateZoneDisk(zone_name, Ucen, Vcen, R, Orient)**                             |
  86 |     Retourne une instance de la classe ``zone`` de type disque                   |
  87 |     après sa création                                                            |
  88 |                                                                                  |
  89 |     - ``zone_name`` : le nom de la zone basée sur un disque plein                |
  90 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
  91 |     - ``R`` : rayon du disque                                                    |
  92 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
  93 +----------------------------------------------------------------------------------+
  94 | .. module:: CreateZoneDiskWithHole                                               |
  95 |                                                                                  |
  96 | **CreateZoneDiskWithHole(zone_name, Ucen, Vcen, R, Rint, Orient)**               |
  97 |     Retourne une instance de la classe ``zone`` de type disque troué             |
  98 |     après sa création                                                            |
  99 |                                                                                  |
 100 |     - ``zone_name`` : le nom de la zone basée sur un disque troué                |
 101 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
 102 |     - ``R`` : rayon externe du disque                                            |
 103 |     - ``Rint`` : rayon interne du disque                                         |
 104 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
 105 +----------------------------------------------------------------------------------+
 106
 107
 108
 109 +---------------------------------------------------------------+
 110 +---------------------------------------------------------------+
 111 |   La convention d'orientation du plan est la même que celle   |
 112 |   appliquée dans les autres modules de SALOME, en particulier |
 113 |   GEOM :                                                      |
 114 |                                                               |
 115 |     1. plan XY ; U <==> X et V <==> Y                         |
 116 |     2. plan YZ ; U <==> Y et V <==> Z                         |
 117 |     3. plan ZX ; U <==> Z et V <==> X                         |
 118 +---------------------------------------------------------------+
 119
 120
 121 .. note::
 122   Les fonctions définissant des zones 2D ne doivent être utilisées que si l'intégralité du
 123   maillage est 2D, dans un des plans de coordonnées.
 124
 125
 126 +---------------------------------------------------------------+
 127 +---------------------------------------------------------------+
 128 | .. module:: GetZone                                           |
 129 |                                                               |
 130 | **GetZone(zone_name)**                                        |
 131 |     Retourne l'instance de la classe ``zone`` connue par      |
 132 |     son nom                                                   |
 133 |                                                               |
 134 |     - ``zone_name`` : le nom de la zone                       |
 135 +---------------------------------------------------------------+
 136 | .. module:: GetAllZonesName                                   |
 137 |                                                               |
 138 | **GetAllZonesName()**                                         |
 139 |     Retourne la liste des noms de toutes les zones créées     |
 140 |                                                               |
 141 +---------------------------------------------------------------+
 142
 143
 144 Méthodes de la classe zone
 145 **************************
 146
 147 +---------------------------------------------------------------+
 148 +---------------------------------------------------------------+
 149 | .. module:: GetName                                           |
 150 |                                                               |
 151 | **GetName()**                                                 |
 152 |     Retourne le nom de la zone                                |
 153 +---------------------------------------------------------------+
 154 | .. module:: GetType                                           |
 155 |                                                               |
 156 | **GetType()**                                                 |
 157 |     Retourne le type de la zone                               |
 158 |                                                               |
 159 |         * 2 : parallélépipède                                 |
 160 |         * 3 : sphère                                          |
 161 |         * 5 : cylindre                                        |
 162 |         * 7 : tuyau                                           |
 163 |         * 11, 12, 13 : rectangle et orientation 1, 2 ou 3     |
 164 |         * 31, 32, 33 : disque et orientation 1, 2 ou 3        |
 165 |         * 61, 62, 63 : disque percé et orientation 1, 2 ou 3  |
 166 +---------------------------------------------------------------+
 167 | .. module:: GetCoords                                         |
 168 |                                                               |
 169 | **GetCoords()**                                               |
 170 |     Retourne un tableau contenant les coordonnées de la zone  |
 171 |     dans l'ordre d'entrée dans le CreateZoneXXXX associé      |
 172 +---------------------------------------------------------------+
 173 | .. module:: Delete                                            |
 174 |                                                               |
 175 | **Delete()**                                                  |
 176 |     Detruit la zone                                           |
 177 |                                                               |
 178 |     Retourne un entier :                                      |
 179 |         * 0 : destruction réussie                             |
 180 |         * autre valeur : problème                             |
 181 +---------------------------------------------------------------+
 182
 183
 184 Exemple
 185 *******
 186 La création d'une boîte 3D se fait ainsi :
 187 ::
 188
 189     zone_1 = homard.CreateZoneBox ("BLOC", -1., 1., -30., 40., 10.5, 20.8)
 190
 191
 192 La création d'un disque dans le plan XY se fait ainsi :
 193 ::
 194
 195     zone_2 = homard.CreateZoneDisk ("disque", 1., 3., 43.25, 1)
 196
 197
 198 Saisie graphique correspondante
 199 *******************************
 200 Consulter :ref:`gui_create_zone`
 201
 202 .. warning::
 203   En mode graphique, si on édite une zone et que l'on modifie une des dimensions, toutes les itérations qui ont été calculées précédemment avec cette zone sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles.
 204
 205
 206