Salome HOME
Suppression de composantes dans les hypothèses.
[modules/homard.git] / doc / en / tui_create_hypothese.rst
index eb67f2f22086f2565e4f74dc3c5b93e9830f220d..2683b6f6efec02c49e2205cc0f80f508c5719e8b 100644 (file)
@@ -195,11 +195,23 @@ The components of the field
 |        * 1: infinite norm                                     |
 |        * 2: relative value, if only one component             |
 +---------------------------------------------------------------+
-| .. module:: GetListComp                                       |
+| .. module:: GetComps                                          |
 |                                                               |
-| **GetListComp()**                                             |
+| **GetComps()**                                                |
 |     Returns the list of the used components                   |
 +---------------------------------------------------------------+
+| .. module:: SupprComp                                         |
+|                                                               |
+| **SupprComp(comp_name)**                                      |
+|     Eliminates a component of the field                       |
+|                                                               |
+|     - ``comp_name``: name of a component to eliminate         |
++---------------------------------------------------------------+
+| .. module:: SupprComps                                        |
+|                                                               |
+| **SupprComps()**                                              |
+|     Eliminates all the components of the field                |
++---------------------------------------------------------------+
 
 
 The zones
@@ -217,6 +229,27 @@ The zones
 |         * 1: refinement                                       |
 |         * -1: unrefinement                                    |
 +---------------------------------------------------------------+
+| .. module:: GetZones                                          |
+|                                                               |
+| **GetZones()**                                                |
+|     Returns the list of the used zones with their uses        |
+|     Warning: the use is stored as a string in the list and    |
+|     not as an integer.                                        |
+|                                                               |
+|     Example: ['Zone_A', '1', 'Zone_B', '1', 'Zone_C', '1']    |
++---------------------------------------------------------------+
+| .. module:: SupprZone                                         |
+|                                                               |
+| **SupprZone(zone_name)**                                      |
+|     Eliminates a zone from the hypothesis                     |
+|                                                               |
+|     - ``zone_name``: name of a zone to eliminate              |
++---------------------------------------------------------------+
+| .. module:: SupprZones                                        |
+|                                                               |
+| **SupprZones()**                                              |
+|     Eliminates all the zones from the hypothesis              |
++---------------------------------------------------------------+
 
 
 The filtering by the groups