doc/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 |                                                                                  |
  28 |     - ``zone_name`` : le nom de la zone basée sur un parallélépipède             |
  29 |     - ``Xmin``, ``Xmax`` : coordonnées extrêmes selon X                          |
  30 |     - ``Ymin``, ``Ymax`` : coordonnées extrêmes selon Y                          |
  31 |     - ``Zmin``, ``Zmax`` : coordonnées extrêmes selon Z                          |
  32 +----------------------------------------------------------------------------------+
  33 | .. module:: CreateZoneCylinder                                                   |
  34 |                                                                                  |
  35 | **CreateZoneCylinder(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H)**   |
  36 |                                                                                  |
  37 |     - ``zone_name`` : le nom de la zone basée sur un cylindre                    |
  38 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
  39 |       positionné sur l'axe                                                       |
  40 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                            |
  41 |     - ``R`` : rayon du cylindre                                                  |
  42 |     - ``H`` : hauteur du cylindre                                                |
  43 +----------------------------------------------------------------------------------+
  44 | .. module:: CreateZonePipe                                                       |
  45 |                                                                                  |
  46 | **CreateZonePipe(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H, Rint)** |
  47 |                                                                                  |
  48 |     - ``zone_name`` : le nom de la zone basée sur un tuyau                       |
  49 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
  50 |       positionné sur l'axe                                                       |
  51 |     - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe                            |
  52 |     - ``R`` : rayon externe du tuyau                                             |
  53 |     - ``H`` : hauteur du tuyau                                                   |
  54 |     - ``R`` : rayon interne du tuyau                                             |
  55 +----------------------------------------------------------------------------------+
  56 | .. module:: CreateZoneSphere                                                     |
  57 |                                                                                  |
  58 | **CreateZoneSphere(zone_name, Xcen, Ycen, Zcen, R)**                             |
  59 |                                                                                  |
  60 |     - ``zone_name`` : le nom de la zone basée sur une sphère                     |
  61 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère          |
  62 |     - ``R`` : rayon de la sphère                                                 |
  63 +----------------------------------------------------------------------------------+
  64 | .. module:: CreateZoneBox2D                                                      |
  65 |                                                                                  |
  66 | **CreateZoneBox2D(zone_name, Umin, Umax, Vmin, Vmax, Orient)**                   |
  67 |                                                                                  |
  68 |     - ``zone_name`` : le nom de la zone basée sur un rectangle                   |
  69 |     - ``Umin``, ``Umax`` : coordonnées extrêmes pour la 1ère dimension           |
  70 |     - ``Vmin``, ``Vmax`` : coordonnées extrêmes pour la 2nde dimension           |
  71 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
  72 +----------------------------------------------------------------------------------+
  73 | .. module:: CreateZoneDisk                                                       |
  74 |                                                                                  |
  75 | **CreateZoneDisk(zone_name, Ucen, Vcen, R, Orient)**                             |
  76 |                                                                                  |
  77 |     - ``zone_name`` : le nom de la zone basée sur un disque plein                |
  78 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
  79 |     - ``R`` : rayon du disque                                                    |
  80 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
  81 +----------------------------------------------------------------------------------+
  82 | .. module:: CreateZoneDiskWithHole                                               |
  83 |                                                                                  |
  84 | **CreateZoneDiskWithHole(zone_name, Ucen, Vcen, R, Rint, Orient)**               |
  85 |                                                                                  |
  86 |     - ``zone_name`` : le nom de la zone basée sur un disque troué                |
  87 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
  88 |     - ``R`` : rayon externe du disque                                            |
  89 |     - ``Rint`` : rayon interne du disque                                         |
  90 |     - ``Orient`` : entier précisant la convention d'orientation du plan          |
  91 +----------------------------------------------------------------------------------+
  92
  93
  94
  95 +---------------------------------------------------------------+
  96 +---------------------------------------------------------------+
  97 |   La convention d'orientation du plan est la même que celle   |
  98 |   utilisée dans les autres modules de Salome, en particulier  |
  99 |   GEOM :                                                      |
 100 |                                                               |
 101 |     1. plan XY ; U <==> X et V <==> Y                         |
 102 |     2. plan YZ ; U <==> Y et V <==> Z                         |
 103 |     3. plan ZX ; U <==> Z et V <==> X                         |
 104 +---------------------------------------------------------------+
 105
 106
 107 .. note::
 108   Les fonctions définissant des zones 2D ne doivent être utilisées que si l'intégralité du
 109   maillage est 2D, dans un des plans de coordonnées.
 110
 111
 112 Méthodes de la classe zone
 113 """"""""""""""""""""""""""
 114
 115 +---------------------------------------------------------------+
 116 +---------------------------------------------------------------+
 117 | .. module:: GetName                                           |
 118 |                                                               |
 119 | **GetName()**                                                 |
 120 |     Retourne le nom de la zone                                |
 121 +---------------------------------------------------------------+
 122 | .. module:: GetZoneType                                       |
 123 |                                                               |
 124 | **GetZoneType()**                                             |
 125 |     Retourne le type de la zone                               |
 126 |                                                               |
 127 |         * 2 : parallélépipède                                 |
 128 |         * 3 : sphère                                          |
 129 |         * 5 : cylindre                                        |
 130 |         * 7 : tuyau                                           |
 131 |         * 11, 12, 13 : rectangle et orientation 1, 2 ou 3     |
 132 |         * 31, 32, 33 : disque et orientation 1, 2 ou 3        |
 133 |         * 61, 62, 63 : disque percé et orientation 1, 2 ou 3  |
 134 +---------------------------------------------------------------+
 135 | .. module:: GetCoords                                         |
 136 |                                                               |
 137 | **GetCoords()**                                               |
 138 |     Retourne un tableau contenant les coordonnées de la zone  |
 139 |     dans l'ordre d'entrée dans le CreateZoneXXXX associé      |
 140 +---------------------------------------------------------------+
 141
 142
 143 Exemple
 144 """""""
 145 La création d'une boîte 3D ou d'un disque dans le plan XY se fait ainsi : ::
 146
 147     zone_1 = homard.CreateZoneBox ("BLOC", -1., 1., -30., 40., 10.5, 20.8)
 148     zone_2 = homard.CreateZoneDisk ("disque", 1., 3., 43.25, 1)
 149
 150
 151 Saisie graphique correspondante
 152 """""""""""""""""""""""""""""""
 153 Consulter :ref:`gui_create_zone`
 154
 155
 156