mise a jour pour la poursuite d'iterations

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

diff --git a/doc/tui_create_iteration.rst b/doc/tui_create_iteration.rst
index 96db65ffa49de51d7a946352bc59810f19ff7a10..3e153d80f3a96b6c0669cec62b679cbe634748a9 100644 (file)
--- a/doc/tui_create_iteration.rst
+++ b/doc/tui_create_iteration.rst
@@ -79,15 +79,21 @@ G
 +---------------------------------------------------------------+
 | .. index:: single: Compute                                    |
 |                                                               |
-| **Compute(option)**                                           |
+| **Compute(option1, option2)**                                 |
 |     Calcule le maillage correspondant à l'itération           |
 |                                                               |
-|     - ``option`` : un entier précisant ce qui se passe quand  |
+|     - ``option1`` : un entier précisant ce qui se passe quand |
 |       des fichiers de résultats existent déjà                 |
 |                                                               |
 |         * 0 : arrêt en erreur                                 |
 |         * 1 : écrasement des anciens fichiers                 |
 |                                                               |
+|     - ``option2`` : un entier précisant ce qui est fait des   |
+|       résultats                                               |
+|                                                               |
+|         * 1 : aucune action particulière                      |
+|         * 2 : publication dans le module SMESH                |
+|                                                               |
 |     Retourne un entier :                                      |
 |         * 0 : adaptation réussie                              |
 |         * autre valeur : problème                             |
@@ -141,14 +147,16 @@ G
 | **GetState()**                                                |
 |     Retourne l'état de l'itération                            |
 |                                                               |
-|     - ``0`` : itération non calculée                          |
-|     - ``1`` : itération calculée correctement                 |
+|     - ``2`` : itération calculée correctement                 |
+|     - ``1`` : itération non calculée                          |
+|     - ``<=0`` : itération initiale à ne pas calculer, de      |
+|       numéro valant la valeur absolue de l'état               |
 +---------------------------------------------------------------+
 | .. module:: GetLogFile                                        |
 |                                                               |
 | **GetLogFile()**                                              |
 |     Retourne le nom du fichier retraçant le déroulement de    |
-|     l'exécuion de HOMARD                                      |
+|     l'exécution de HOMARD                                     |
 +---------------------------------------------------------------+
 | .. module:: GetFileInfo                                       |
 |                                                               |
@@ -157,9 +165,14 @@ G
 +---------------------------------------------------------------+
 | .. index:: single: Delete                                     |
 |                                                               |
-| **Delete()**                                                  |
-|     Detruit l'itération et toutes ses filles éventuelles. Les |
-|     fichiers des maillages associés sont supprimés.           |
+| **Delete(option)**                                            |
+|     Detruit l'itération et toutes ses filles éventuelles.     |
+|                                                               |
+|     - ``option`` : un entier précisant ce qui est fait des    |
+|       fichiers de maillage associés                           |
+|                                                               |
+|         * 0 : les fichiers sont conservés                     |
+|         * 1 : les fichiers sont détruits                      |
 |                                                               |
 |     Retourne un entier :                                      |
 |         * 0 : destruction réussie                             |
@@ -272,7 +285,7 @@ Pour la cr
     iter_1.SetMeshName("maill_01")
     iter_1.SetMeshFile("/local00/M.01.med")
     iter_1.AssociateHypo("HypoField")
-    codret = iter_1.Compute(1)
+    codret = iter_1.Compute(1, 2)
 
 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
 
@@ -283,7 +296,7 @@ Ensuite, on cr
     iter_2.SetMeshName("maill_02")
     iter_2.SetMeshFile("/local00/M.02.med")
     iter_2.AssociateHypo("HypoField")
-    codret = iter_2.Compute(1)
+    codret = iter_2.Compute(1, 2)
 
 
 Saisie graphique correspondante