Salome HOME
Revert "Synchronize adm files"
[modules/homard.git] / doc / fr / tui_create_iteration.rst
index 6fbb9c030d18f495bf8c9c4387cfa937a14e940d..fce47b004216e6e666ad06968a3d554f0de3436a 100644 (file)
@@ -217,8 +217,11 @@ Informations sur les maillages
 |     - ``Inte`` : interpénétration des mailles, par dimension  |
 +---------------------------------------------------------------+
 
-Informations sur le champ
-=========================
+Informations sur les champs
+===========================
+
+Le fichier des champs
+---------------------
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -227,18 +230,35 @@ Informations sur le champ
 | **SetFieldFile(field_file)**                                  |
 |     Définit le fichier MED des champs utiles                  |
 |                                                               |
-|     - ``field_file`` : le nom du fichier MED contenant le     |
-|       champ                                                   |
+|     - ``field_file`` : le nom du fichier MED contenant les    |
+|       champs : champ de pilotage de l'adaptation ou champs    |
+|       à interpoler                                            |
 +---------------------------------------------------------------+
-| .. module:: SetTimeStepRank                                   |
+| .. module:: GetFieldFileName                                  |
 |                                                               |
-| **SetTimeStepRank(TimeStep, Rank)**                           |
-|     Définit les instants pour le champ                        |
+| **GetFieldFileName()**                                        |
+|     Retourne le nom du fichier MED des champs                 |
++---------------------------------------------------------------+
+
+Les instants pour le champ de pilotage
+--------------------------------------
+Si une seule occurence du champ de pilotage de l'adaptation est présente dans le fichier des champs, il est inutile de préciser le pas de temps. Sinon, il faut préciser quel pas de temps est retenu.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetTimeStep                                       |
 |                                                               |
-|     Inutile si aucun instant n'est défini pour le champ       |
+| **SetTimeStep(TimeStep)**                                     |
+|     Définit l'instant pour le champ de pilotage. Le numéro    |
+|     d'ordre sera ignoré.                                      |
 |                                                               |
-|     Si un seul instant est défini pour le champ, il est pris  |
-|     par défaut.                                               |
+|     - ``TimeStep`` : l'instant où est pris le champ           |
++---------------------------------------------------------------+
+| .. module:: SetTimeStepRank                                   |
+|                                                               |
+| **SetTimeStepRank(TimeStep, Rank)**                           |
+|     Définit l'instant et le numéro d'ordre pour le champ de   |
+|     pilotage                                                  |
 |                                                               |
 |     - ``TimeStep`` : l'instant où est pris le champ           |
 |     - ``Rank`` : le numéro d'ordre où est pris le champ       |
@@ -247,22 +267,59 @@ Informations sur le champ
 |                                                               |
 | **SetTimeStepRankLast()**                                     |
 |     Précise que le dernier instant enregistré pour le champ   |
-|     est utilisé                                               |
-+---------------------------------------------------------------+
-| .. module:: GetFieldFileName                                  |
-|                                                               |
-| **GetFieldFileName()**                                        |
-|     Retourne le nom du fichier MED du champ                   |
+|     de pilotage est utilisé                                   |
 +---------------------------------------------------------------+
 | .. module:: GetTimeStep                                       |
 |                                                               |
 | **GetTimeStep()**                                             |
-|     Retourne l'instant où est pris le champ                   |
+|     Retourne l'instant où est pris le champ de pilotage       |
 +---------------------------------------------------------------+
 | .. module:: GetRank                                           |
 |                                                               |
 | **GetRank()**                                                 |
-|     Retourne le numéro d'ordre où est pris le champ           |
+|     Retourne le numéro d'ordre où est pris le champ de        |
+|     pilotage                                                  |
++---------------------------------------------------------------+
+
+Les instants pour les champs à interpoler
+-----------------------------------------
+
+Les champs à interpoler sont définis dans l'hypothèse (voir :ref:`tui_create_hypothese`).
+Pour un champ donné, si aucune mention de pas de temps n'est précisé, tous les pas de temps seront pris en compte.
+Si on souhaite limiter l'interpolation à un ou plusieurs pas de temps, il faut le préciser ici.
+
++---------------------------------------------------------------+
++---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStep                            |
+|                                                               |
+| **SetFieldInterpTimeStep(FieldName, TimeStep)**               |
+|     Définit un instant pour le champ à interpoler. Le numéro  |
+|     d'ordre sera ignoré.                                      |
+|                                                               |
+|     - ``FieldName`` : le nom du champ à interpoler            |
+|     - ``TimeStep`` : l'instant où est pris le champ           |
++---------------------------------------------------------------+
+| .. module:: SetFieldInterpTimeStepRank                        |
+|                                                               |
+| **SetFieldInterpTimeStepRank(FieldName, TimeStep)**           |
+|     Définit l'instant et le numéro d'ordre pour le champ à    |
+|     interpoler.                                               |
+|                                                               |
+|     - ``FieldName`` : le nom du champ à interpoler            |
+|     - ``TimeStep`` : l'instant où est pris le champ           |
+|     - ``Rank`` : le numéro d'ordre où est pris le champ       |
++---------------------------------------------------------------+
+| .. module:: GetFieldInterpsTimeStepRank                       |
+|                                                               |
+| **GetFieldInterpsTimeStepRank()**                             |
+|     Retourne l'ensemble des triplets (nom du champ, pas de    |
+|     temps, numéro d'ordre)                                    |
+|                                                               |
+|     Attention : l'usage est stocké sous forme de chaîne de    |
+|     caractères et non pas d'entier dans la liste.             |
+|                                                               |
+|     Exemple : ['DEPL', '1', '1', 'DEPL', '2', '1', 'Masse',   |
+|     '2', '0', 'Masse', '3', '0']                              |
 +---------------------------------------------------------------+
 
 Divers