Merge from V6_main 13/12/2012

[modules/homard.git] / doc / tui_create_zone.rst

diff --git a/doc/tui_create_zone.rst b/doc/tui_create_zone.rst
index 9911c413c5c7f4d12e50494c0ee91b3afae56ea1..ea36905d9f4e1c020a64526c2a8a942da8f43ddf 100644 (file)
--- a/doc/tui_create_zone.rst
+++ b/doc/tui_create_zone.rst
@@ -24,6 +24,8 @@ Ces m
 | .. module:: CreateZoneBox                                                        |
 |                                                                                  |
 | **CreateZoneBox(zone_name, Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)**                 |
+|     Retourne une instance de la classe ``zone`` de type parallélépipèdique       |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un parallélépipède             |
 |     - ``Xmin``, ``Xmax`` : coordonnées extrêmes selon X                          |
@@ -33,6 +35,8 @@ Ces m
 | .. module:: CreateZoneCylinder                                                   |
 |                                                                                  |
 | **CreateZoneCylinder(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H)**   |
+|     Retourne une instance de la classe ``zone`` de type cylindrique              |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un cylindre                    |
 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
@@ -44,6 +48,8 @@ Ces m
 | .. module:: CreateZonePipe                                                       |
 |                                                                                  |
 | **CreateZonePipe(zone_name, Xbase, Ybase, Zbase, Xaxe, Yaxe, Zaxe, R, H, Rint)** |
+|     Retourne une instance de la classe ``zone`` de type tuyau                    |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un tuyau                       |
 |     - ``Xbase``, ``Ybase``, ``Zbase`` : coordonnées d'un point de base           |
@@ -56,6 +62,8 @@ Ces m
 | .. module:: CreateZoneSphere                                                     |
 |                                                                                  |
 | **CreateZoneSphere(zone_name, Xcen, Ycen, Zcen, R)**                             |
+|     Retourne une instance de la classe ``zone`` de type sphérique                |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur une sphère                     |
 |     - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère          |
@@ -64,6 +72,8 @@ Ces m
 | .. module:: CreateZoneBox2D                                                      |
 |                                                                                  |
 | **CreateZoneBox2D(zone_name, Umin, Umax, Vmin, Vmax, Orient)**                   |
+|     Retourne une instance de la classe ``zone`` de type rectangulaire            |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un rectangle                   |
 |     - ``Umin``, ``Umax`` : coordonnées extrêmes pour la 1ère dimension           |
@@ -73,6 +83,8 @@ Ces m
 | .. module:: CreateZoneDisk                                                       |
 |                                                                                  |
 | **CreateZoneDisk(zone_name, Ucen, Vcen, R, Orient)**                             |
+|     Retourne une instance de la classe ``zone`` de type disque                   |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un disque plein                |
 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
@@ -82,6 +94,8 @@ Ces m
 | .. module:: CreateZoneDiskWithHole                                               |
 |                                                                                  |
 | **CreateZoneDiskWithHole(zone_name, Ucen, Vcen, R, Rint, Orient)**               |
+|     Retourne une instance de la classe ``zone`` de type disque troué             |
+|     après sa création                                                            |
 |                                                                                  |
 |     - ``zone_name`` : le nom de la zone basée sur un disque troué                |
 |     - ``Ucen``, ``Vcen`` : coordonnées du centre du disque                       |
@@ -109,6 +123,26 @@ Ces m
   maillage est 2D, dans un des plans de coordonnées.
 
 
+
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: GetZone                                           |
+|                                                               |
+| **GetZone(zone_name)**                                        |
+|     Retourne l'instance de la classe ``zone`` connue par      |
+|     son nom                                                   |
+|                                                               |
+|     - ``zone_name`` : le nom de la zone                       |
++---------------------------------------------------------------+
+| .. module:: GetAllZones                                       |
+|                                                               |
+| **GetAllZones()**                                             |
+|     Retourne la liste des noms de toutes les zones créées     |
+|                                                               |
++---------------------------------------------------------------+
+
+
 Méthodes de la classe zone
 """"""""""""""""""""""""""