Instants du champ de pilotage de l'adaptation

[modules/homard.git] / doc / en / tui_create_iteration.rst

diff --git a/doc/en/tui_create_iteration.rst b/doc/en/tui_create_iteration.rst
index 6862ff2dacb08027eb3b5c9d187b8aa6e5fa2e34..d75c4cb90737d8f2596ae62972babad76d03127f 100644 (file)
--- a/doc/en/tui_create_iteration.rst
+++ b/doc/en/tui_create_iteration.rst
@@ -223,24 +223,46 @@ Information about the meshes
 Information about the field
 ===========================
 
+The file of the fields
+----------------------
+
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
 | .. module:: SetFieldFile                                      |
 |                                                               |
 | **SetFieldFile(field_file)**                                  |
-|     Defines the MED file of the field                         |
+|     Defines the MED file of the fields                        |
 |                                                               |
-|     - ``field_file``: the name of the MED file of the field   |
+|     - ``field_file``: the name of the MED file of the fields: |
+|       the driving field for the adaptation, or the fields to  |
+|       be interpolated                                         |
 +---------------------------------------------------------------+
-| .. module:: SetTimeStepRank                                   |
+| .. module:: GetFieldFileName                                  |
 |                                                               |
-| **SetTimeStepRank(TimeStep, Rank)**                           |
-|     Defines the time steps for the fields                     |
+| **GetFieldFileName()**                                        |
+|     Returns the name of the MED file of the fields            |
++---------------------------------------------------------------+
+
+The time step for the driving field
+-----------------------------------
+
+If no time step is defined for the field or if a single time step is defined for the field, the definition of a time step is useless. That will be the default choice.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetTimeStep                                       |
+|                                                               |
+| **SetTimeStep(TimeStep)**                                     |
+|     Defines the time step for the driving field for the       |
+|     adaptation. The rank will be ignored.                     |
 |                                                               |
-|     Useless if no time step is defined for the field.         |
+|     - ``TimeStep``: the selected time step                    |
++---------------------------------------------------------------+
+| .. module:: SetTimeStepRank                                   |
 |                                                               |
-|     If a single time step is defined for the filed, it is the |
-|     default choice.                                           |
+| **SetTimeStepRank(TimeStep, Rank)**                           |
+|     Defines the time step and the rank for the driving field  |
+|     for the adaptation                                        |
 |                                                               |
 |     - ``TimeStep``: the selected time step                    |
 |     - ``Rank``: the selected rank                             |
@@ -248,22 +270,18 @@ Information about the field
 | .. module:: SetTimeStepRankLast                               |
 |                                                               |
 | **SetTimeStepRankLast()**                                     |
-|     The last time step will be used, whatever its value       |
-+---------------------------------------------------------------+
-| .. module:: GetFieldFileName                                  |
-|                                                               |
-| **GetFieldFileName()**                                        |
-|     Returns the name of the MED file of the field             |
+|     The last time step will be used for the driving field for |
+|     the adaptation, whatever its value                        |
 +---------------------------------------------------------------+
 | .. module:: GetTimeStep                                       |
 |                                                               |
 | **GetTimeStep()**                                             |
-|     Returns the selected time step for the field              |
+|     Returns the selected time step for the driving field      |
 +---------------------------------------------------------------+
 | .. module:: GetRank                                           |
 |                                                               |
 | **GetRank()**                                                 |
-|     Returns the selected rank for the field                   |
+|     Returns the selected rank for the driving field           |
 +---------------------------------------------------------------+
 
 Miscellenaous