From 396ecc379e094caa3afd59c2613c883932ce5a3a Mon Sep 17 00:00:00 2001 From: nicolas Date: Tue, 27 Aug 2013 14:26:04 +0000 Subject: [PATCH] menage --- doc/en/tui_create_iteration.rst | 43 +++++++++++--- doc/en/yacs.rst | 22 +++---- doc/files/yacs_01.xml | 100 ++++++++++++++++---------------- doc/fr/tui_create_iteration.rst | 27 +++++++++ doc/fr/yacs.rst | 22 +++---- 5 files changed, 133 insertions(+), 81 deletions(-) diff --git a/doc/en/tui_create_iteration.rst b/doc/en/tui_create_iteration.rst index 85e91e5f..3b57984b 100644 --- a/doc/en/tui_create_iteration.rst +++ b/doc/en/tui_create_iteration.rst @@ -1,7 +1,7 @@ .. _tui_create_iteration: The iteration -############# +============= .. index:: single: iteration .. index:: single: hypothesis @@ -10,7 +10,7 @@ The iteration The variables are described in :ref:`gui_create_iteration`. Methods of the class homard -*************************** +""""""""""""""""""""""""""" +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -31,7 +31,7 @@ Methods of the class homard +---------------------------------------------------------------+ Methods of both classes cas and iteration -***************************************** +""""""""""""""""""""""""""""""""""""""""" +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -66,10 +66,10 @@ Methods of both classes cas and iteration +---------------------------------------------------------------+ Methods of the class iteration -****************************** +"""""""""""""""""""""""""""""" General methods -=============== +^^^^^^^^^^^^^^^ +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -174,7 +174,7 @@ General methods +---------------------------------------------------------------+ Information about the meshes -============================ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -220,7 +220,7 @@ Information about the meshes +---------------------------------------------------------------+ Information about the field -=========================== +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -265,8 +265,33 @@ Information about the field | Returns the selected rank for the field | +---------------------------------------------------------------+ +Miscellenaous +^^^^^^^^^^^^^ + ++---------------------------------------------------------------+ ++---------------------------------------------------------------+ +| .. module:: SetInfoCompute | +| | +| **SetInfoCompute(MessInfo)** | +| Defines options to track the computation of the iteration | +| | +| - ``MessInfo`` : integer that drives prints, as a multiple| +| of 2, 3 and 5 | +| | +| * 1 : nothing (default) | +| * 2x : computational time | +| * 3x : MED files | +| * 5x : memory | ++---------------------------------------------------------------+ +| .. module:: GetInfoCompute | +| | +| **GetInfoCompute()** | +| Returns the options to track the computation | ++---------------------------------------------------------------+ + + Example -******* +""""""" .. index:: single: mesh;initial To create the first iteration, the starting point is the iteration associated to the initial mesh. It is the one that defines the case. @@ -295,5 +320,5 @@ Then, the next iteration is created from the current iteration. Similar graphical input -*********************** +""""""""""""""""""""""" Look at :ref:`gui_create_iteration` diff --git a/doc/en/yacs.rst b/doc/en/yacs.rst index 603af3ee..1eb77788 100644 --- a/doc/en/yacs.rst +++ b/doc/en/yacs.rst @@ -41,7 +41,7 @@ DataInit This box is type PresetNode's elementary node. Its only function is to initialize the variable MeshFile that contains the name of the file of the initial mesh. .. literalinclude:: ../files/yacs_01.xml - :lines: 70-74 + :lines: 38-42 Etude_Initialisation ==================== @@ -59,12 +59,12 @@ The box Etude_Initialisation launches the component HOMARD inside SALOME. It is The python node StudyCreation initialize the SALOME study that is given through the output: .. literalinclude:: ../files/yacs_01.xml - :lines: 39-57 + :lines: 44-62 The service SetCurrentStudy connects this study to an instance of HOMARD. .. literalinclude:: ../files/yacs_01.xml - :lines: 58-63 + :lines: 63-68 Tant_que_le_calcul_n_a_pas_converge @@ -112,7 +112,7 @@ Calcul This box is a node python that is going to drive the calculation. In input, we find the number of the calculation (0 at first) and the name of the file which contains the mesh on which to calculate. In output, we find an integer which represents the error on this calculation (0 so everything goes well) and a dictionary python gathering the results of the calculation. The body of the node is established by the launch of a script python that activates the calculation. .. literalinclude:: ../files/yacs_01.xml - :lines: 155-182 + :lines: 77-104 In this example, we must define: @@ -248,37 +248,37 @@ Analyse The Analyse block is a script python which ensures the complete control of the process by examining the causes of possible error successively. .. literalinclude:: ../files/yacs_01.xml - :lines: 77-90 + :lines: 105-118 ../.. .. literalinclude:: ../files/yacs_01.xml - :lines: 145-154 + :lines: 173-182 One starts by analyzing the return of the computer code: .. literalinclude:: ../files/yacs_01.xml - :lines: 92-97 + :lines: 120-125 Checking of the presence of the name of the mesh in the dictionary of the results: .. literalinclude:: ../files/yacs_01.xml - :lines: 99-106 + :lines: 127-134 Checking of the presence of the name of the result file in the dictionary of the results: .. literalinclude:: ../files/yacs_01.xml - :lines: 108-115 + :lines: 136-143 Checking of convergence. That supposes that the value to be tested is present in the dictionary under the key 'V00'. Here, one set up a test on the variation of the value of one calculation at the other. With the first passage, nothing is tested. In the following passing, one tests if the relative variation is lower than 1 thousandths. One could have set up an absolute test if one had recovered a total level of error for example. .. literalinclude:: ../files/yacs_01.xml - :lines: 117-135 + :lines: 145-163 Lastly, it is checked that a maximum nomber of adaptations is not exceeded: .. literalinclude:: ../files/yacs_01.xml - :lines: 137-142 + :lines: 165-170 Use this scheme diff --git a/doc/files/yacs_01.xml b/doc/files/yacs_01.xml index 8d5ba365..42358545 100644 --- a/doc/files/yacs_01.xml +++ b/doc/files/yacs_01.xml @@ -35,6 +35,11 @@ + + + /scratch/D68518/HOMARD_SVN/trunk/training/tet_aster_ther/maill.00.med + + + + + + + - - - - - @@ -365,8 +365,8 @@ else : - Analyse Adaptation Calcul Analyse + Analyse Adaptation Analyse Error Adaptation select @@ -435,8 +435,8 @@ else : ]]> - Etude_Initialisation Tant_que_le_calcul_n_a_pas_converge DataInit Etude_Initialisation + Etude_Initialisation Tant_que_le_calcul_n_a_pas_converge Tant_que_le_calcul_n_a_pas_converge Bilan DataInit MeshFile @@ -498,27 +498,27 @@ else : Tant_que_le_calcul_n_a_pas_converge.Alternance_Calcul_HOMARD.AnalyseErrCalc 0 - - - - + - + + + + + - + + + + + + - - + - - - - - - - + + diff --git a/doc/fr/tui_create_iteration.rst b/doc/fr/tui_create_iteration.rst index bafdd62b..9cb3c531 100644 --- a/doc/fr/tui_create_iteration.rst +++ b/doc/fr/tui_create_iteration.rst @@ -264,6 +264,33 @@ Informations sur le champ | Retourne le numéro d'ordre où est pris le champ | +---------------------------------------------------------------+ +Divers +^^^^^^ + ++---------------------------------------------------------------+ ++---------------------------------------------------------------+ +| .. module:: SetInfoCompute | +| | +| **SetInfoCompute(MessInfo)** | +| Précise des options d'informations sur le déroulement du | +| calcul de l'itération | +| | +| - ``MessInfo`` : entier pilotant des écritures, sous la | +| forme d'un entier multiple de 2, 3 et 5 | +| | +| * 1 : aucune écriture (défaut) | +| * 2x : temps de calcul | +| * 3x : fichiers MED | +| * 5x : mémoire | ++---------------------------------------------------------------+ +| .. module:: GetInfoCompute | +| | +| **GetInfoCompute()** | +| Retourne les options d'informations sur le déroulement du | +| calcul de l'itération | ++---------------------------------------------------------------+ + + Exemple """"""" .. index:: single: maillage;initial diff --git a/doc/fr/yacs.rst b/doc/fr/yacs.rst index 6a830d41..c45f8340 100644 --- a/doc/fr/yacs.rst +++ b/doc/fr/yacs.rst @@ -41,7 +41,7 @@ DataInit Cette boîte est un noeud élémentaire de type PresetNode. Sa seule fonction est d'initialiser la variable MeshFile qui contient le nom du fichier du maillage initial. .. literalinclude:: ../files/yacs_01.xml - :lines: 70-74 + :lines: 38-42 Etude_Initialisation ==================== @@ -59,12 +59,12 @@ La bo Le noeud python StudyCreation sert à initialiser l'étude SALOME qui est fournie en sortie : .. literalinclude:: ../files/yacs_01.xml - :lines: 39-57 + :lines: 44-62 Le service SetCurrentStudy affecte cette étude à une instance de HOMARD. .. literalinclude:: ../files/yacs_01.xml - :lines: 58-63 + :lines: 63-68 Tant_que_le_calcul_n_a_pas_converge @@ -112,7 +112,7 @@ Calcul Cette boîte est un noeud python qui va piloter le calcul. En entrée, on trouve le numéro du calcul (0 au départ) et le nom du fichier qui contient le maillage sur lequel calculer. En sortie, on trouve un entier qui représente l'erreur sur ce calcul (0 si tout va bien) et un dictionnaire python rassemblant les résultats du calcul. Le corps du noeud est constitué par le lancement d'un script python qui active le calcul. .. literalinclude:: ../files/yacs_01.xml - :lines: 155-182 + :lines: 77-104 Dans cet exemple, il faut définir : @@ -248,37 +248,37 @@ Analyse Le bloc Analyse est un script python qui assure le contrôle complet du processus en examinant successivement les causes d'erreur possible. .. literalinclude:: ../files/yacs_01.xml - :lines: 77-90 + :lines: 105-118 ../.. .. literalinclude:: ../files/yacs_01.xml - :lines: 145-154 + :lines: 173-182 On commence par analyser le retour du code de calcul : .. literalinclude:: ../files/yacs_01.xml - :lines: 92-97 + :lines: 120-125 Vérification de la présence du nom du maillage dans le dictionnaire des résultats : .. literalinclude:: ../files/yacs_01.xml - :lines: 99-106 + :lines: 127-134 Vérification de la présence du nom du fichier de résultats dans le dictionnaire des résultats : .. literalinclude:: ../files/yacs_01.xml - :lines: 108-115 + :lines: 136-143 Vérification de la convergence. Cela suppose que la valeur à tester est présente dans le dictionnaire sous la clé 'V00'. Ici, on a mis en place un test sur la variation de la valeur d'un calcul à l'autre. Au premier passage, on ne teste rien. Aux passages suivants, on teste si la variation relative est inférieure à 1 millième. On aurait pu mettre en place un test absolu si on avait récupéré un niveau global d'erreur par exemple. .. literalinclude:: ../files/yacs_01.xml - :lines: 117-135 + :lines: 145-163 Enfin, on vérifie que l'on ne dépasse pas un nomber maximal d'adaptations : .. literalinclude:: ../files/yacs_01.xml - :lines: 137-142 + :lines: 165-170 Utiliser ce schéma -- 2.39.2