.. image:: ../images/yacs_01.png
:align: center
:alt: yacs - allure générale
- :width: 535
- :height: 362
+ :width: 512
+ :height: 306
.. note::
Among all the treated data, certain are unchanging: the name of the directory of calculation, the name of the case, the name of the hypothesis of adaptation, etc. It was chosen to impose them 'hard' in the various parameters of service or within the scripts python. We could also define them a priori in a node PresetNode and then pass on them by links. We did not hold this solution because it increases strongly the number of parameters and links attached to every node. It is very penalizing for the legibility of the scheme. The only data which are going to circulate are the ones been imperative by the description of the service and those that evolve during the execution of the scheme.
- DataInit : initialisation of the initial mesh
- Etude_Initialisation : launching of the module HOMARD inside SALOME
-- Tant_que_le_calcul_n_a_pas_converge : gestion of the loop computation/adaptation
+- Boucle_de_convergence : gestion of the loop computation/adaptation
- Bilan : final information
DataInit
:lines: 63-68
-Tant_que_le_calcul_n_a_pas_converge
-===================================
-The box Tant_que_le_calcul_n_a_pas_converge is type WhileLoop. The condition is initialized in 1: the internal block Alternance_Calcul_HOMARD is executed. Within this block, we calculate and we adapt the mesh; when the process has to stop either as a result of error, or by convergence, the condition passes in 0. The loop ends and we pass in the following box, Bilan.
+Boucle_de_convergence
+=====================
+The box Boucle_de_convergence is type WhileLoop. The condition is initialized in 1: the internal block Alternance_Calcul_HOMARD is executed. Within this block, we calculate and we adapt the mesh; when the process has to stop either as a result of error, or by convergence, the condition passes in 0. The loop ends and we pass in the following box, Bilan.
.. image:: ../images/yacs_c_01.png
:align: center
:alt: Boucle
- :width: 195
- :height: 142
+ :width: 163
+ :height: 93
Bilan
=====
This box is a node python that takes in input a character string, MessInfo. If everything passed well, this message is empty. A window QT appears to confirm the convergence. If there was a problem, the message contains messages emitted during the calculations. The window QT shows this message.
.. literalinclude:: ../files/yacs_01.xml
- :lines: 424-437
+ :lines: 406-419
Loop for the calculations
.. image:: ../images/yacs_c_02.png
:align: center
:alt: Boucle
- :width: 323
- :height: 158
+ :width: 338
+ :height: 152
This box is a block that manages the computation, the adaptation and the analysis.
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: 77-104
+ :lines: 77-103
In this example, we must define:
- rep_calc : the directory in which will be executed the calculation.
-- rep_script : the directory in which is the python that will launch the calculation. This directory is to be added to the PATH. From this directory, we shall import LanceCas from the file LanceCas.py
+- rep_script : the directory in which is the python that will launch the calculation. This directory is to be added to the PATH. From this directory, we shall import Script from the file ScriptAster.py
-The python LanceCas is programmed as the user wishes it so that the calculation can be made on the current mesh. According to the mode of launch of the code of calculation, we can need other information, as the number of the calculation or the directory of the calculation for example. The freedom is total. In our case, the arguments of input are the name of the file of mesh, the number of the calculation and the directory of calculation. They are given in a list python: ["--rep_calc=rep_calc", "--numero=numCalc", "--mesh_file=MeshFile"]
+The python Script is programmed as the user wishes it so that the calculation can be made on the current mesh. According to the mode of launch of the code of calculation, we can need other information, as the number of the calculation or the directory of the calculation for example. The freedom is total. In our case, the arguments of input are the name of the file of mesh, the number of the calculation and the directory of calculation. They are given in a list python: ["--rep_calc=rep_calc", "--num=numCalc", "--mesh_file=MeshFile"]
].
On the other hand the output of the script has to obey the following rule. We get back a code of error, an error message and a dictionary. This dictionary contains necessarily the following keys:
- "FileName" : the name of the file that contains the results of the calculation
-- "MeshName" : the name of the used mesh
-- "V00" : the value the convergence of which we want to test
+- "V_TEST" : the value the convergence of which we want to test
Adaptation
==========
.. image:: ../images/yacs_c_04.png
:align: center
:alt: Adaptation
- :width: 672
- :height: 569
+ :width: 661
+ :height: 566
The box Adaptation is a Switch node driven by the code of error of the previous calculation. If this code is nil, YACS will activate the box Adaptation_HOMARD that will launch the adaptation. If the code is not nil, we pass directly in the box Arret_boucle.
Adaptation_HOMARD
-----------------
-The first task tries to execute concern the initialization of the data necessary for HOMARD in the box HOMARD_Initialisation. This box is a switch node driven by the number of the calculation. In the starting up, the number is nil and YACS activates the box Homard_init_au_debut.
+The first task tries to execute concern the initialization of the data necessary for HOMARD in the box HOMARD_Initialisation. This box is a switch node driven by the number of the calculation. In the starting up, the number is nil and YACS activates the box Iter_1.
-Homard_init_au_debut
-^^^^^^^^^^^^^^^^^^^^
+Iter_1
+^^^^^^
.. image:: ../images/yacs_c_06.png
:align: center
- :alt: Homard_init_au_debut
+ :alt: Iter_1
:width: 481
- :height: 150
+ :height: 151
This box begins by creating the case HOMARD by calling the CreateCase service.
.. literalinclude:: ../files/yacs_01.xml
- :lines: 220-227
+ :lines: 208-215
-The name of the case CaseName is imposed on "Calculation". The parameters of input MeshName and FileName arises from the output of the previous calculation. The parameter of output is an instance of case.
+The name of the case CaseName is imposed on "Calcul". The name of the case MeshName is imposed on "BOX". The parameters of input FileName arise from the output of the previous calculation. The parameter of output is an instance of case.
+
+.. literalinclude:: ../files/yacs_01.xml
+ :lines: 443-446
.. literalinclude:: ../files/yacs_01.xml
- :lines: 461-464
+ :lines: 483-486
The options of this case must be now given. It is made by the node python CaseOptions. It is imperative to give the directory of calculation. We shall look at the description of the functions in:ref: ' tui_create_case '. In output, we get back the instance of the iteration corresponding to the initial state of the case.
.. literalinclude:: ../files/yacs_01.xml
- :lines: 228-242
+ :lines: 216-228
Finally, a hypothesis is created by calling the CreateHypothèse service. The parameter of output is an instance of hypothese.
:width: 153
:height: 141
-The directory of calculation is recovered.
+The directory of calculation is recovered. The name of the mesh is given.
.. literalinclude:: ../files/yacs_01.xml
- :lines: 258-263
+ :lines: 245-250
../..
.. literalinclude:: ../files/yacs_01.xml
- :lines: 339-347
+ :lines: 325-333
The hypothesis transmitted in input parameter characterized (look :ref:`tui_create_hypothese`) :
.. literalinclude:: ../files/yacs_01.xml
- :lines: 267-291
+ :lines: 254-278
It is necessary to establish a name for the future iteration. To make sure that the name was never used, one installs a mechanism of incremental naming starting from the name of the initial iteration. As this initial name is the name of the initial mesh, one obtains a succession of names in the form: M_001, M_002, M_003, etc
.. literalinclude:: ../files/yacs_01.xml
- :lines: 293-303
+ :lines: 280-290
The iteration is supplemented : hypothesis, future mesh, field (look :ref:`tui_create_iteration`) :
.. literalinclude:: ../files/yacs_01.xml
- :lines: 305-325
+ :lines: 292-311
The iteration is calculated. If it were correct, variable OK equals 1: one will be able to continue the execution of the scheme. If there were a problem, variable OK equals 0 to mean that calculation must stop; an error message then is given.
.. literalinclude:: ../files/yacs_01.xml
- :lines: 327-338
+ :lines: 313-324
After this execution, the process leaves the Adaptation_HOMARD node, then Adaptation node. One arrives then at the node of analysis.
-Homard_init_ensuite
-^^^^^^^^^^^^^^^^^^^
+Iter_n
+^^^^^^
.. image:: ../images/yacs_c_07.png
:align: center
- :alt: Homard_init_ensuite
+ :alt: Iter_n
:width: 323
- :height: 97
+ :height: 92
For the following passing in the block of adaptation, it is necessary to recover:
The Arret_boucle block is present to only make forward variables because the input parameters of the nodes must always be filled. It is a very simple python:
.. literalinclude:: ../files/yacs_01.xml
- :lines: 185-196
+ :lines: 173-184
Analyse
=======
.. image:: ../images/yacs_c_05.png
:align: center
:alt: Analyse
- :width: 155
- :height: 169
+ :width: 156
+ :height: 139
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: 105-118
+ :lines: 104-116
../..
.. literalinclude:: ../files/yacs_01.xml
- :lines: 173-182
+ :lines: 162-170
One starts by analyzing the return of the computer code:
.. literalinclude:: ../files/yacs_01.xml
- :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: 127-134
+ :lines: 118-123
Checking of the presence of the name of the result file in the dictionary of the results:
.. literalinclude:: ../files/yacs_01.xml
- :lines: 136-143
+ :lines: 125-132
-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.
+Checking of convergence. That supposes that the value to be tested is present in the dictionary under the key 'V_TEST'. 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: 145-163
+ :lines: 134-152
Lastly, it is checked that a maximum nomber of adaptations is not exceeded:
.. literalinclude:: ../files/yacs_01.xml
- :lines: 165-170
+ :lines: 154-159
Use this scheme
***************
To reproduce this example, download:
* :download:`the scheme <../files/yacs_01.xml>`
- * :download:`an example of python script <../files/yacs_script.tgz>`
+ * :download:`an example of python script <../files/yacs_script.py>`
It should be adapted to simulation considered. In particular, it is necessary:
