Salome HOME
Correction of english mistakes
[modules/homard.git] / doc / en / gui_create_iteration.rst
1 .. _gui_create_iteration:
2
3 The iteration
4 #############
5 .. index:: single: iteration
6
7 The definition of an iteration is done by the following information:
8
9   - The previous iteration
10   - The name of the resulting mesh
11   - The used hypothesis
12   - Possibly, the file of the field of error indicators
13
14 .. image:: images/create_iteration_1.png
15    :align: center
16
17 Name of the iteration
18 *********************
19 A name of iteration is proposed automatically: Iter_1, Iter_2, etc This name can be modified. It must not have been used for a preceding iteration.
20
21 The preceding iteration
22 ***********************
23 The preceding iteration is selected in the object browser. The name of the corresponding mesh will be posted.
24
25 .. index:: single: mesh;result
26
27 The name of the resulting mesh
28 ******************************
29 The current iteration will produce a mesh. This mesh will be known under a name. This name is provided by typing it in the zone of text. By default, one proposes a name identical to that of the preceding iteration.
30
31 .. index:: single: field
32 .. index:: single: MED
33
34 The field
35 *********
36 To create or use a hypothesis of adaptation based on a field expressed on the mesh, one must provide the file where the field is. It is also the case if one wants to interpolate fields from mesh #N to the mesh #(N+1). This file is with format MED. Classically, it will have been produced by the computation software with which one works. The name of the file can be provided, either by typing the name in the zone of text, or by activating the function of research.
37
38 .. image:: images/create_iteration_2.png
39    :align: center
40
41 If steps of time were defined, a simple solution consists in treating the fields with the last step of time recorded in the file. If one wants to define another step of time, one notches the button "*Given time step*". The values of 'time' and 'Sequence number' are those corresponding to convention MED (time step/rank). These values depend on the logic which was retained by the software which wrote the file. Often these two values are identical but it happens that one disjoins the time steps and the intervals of saving.
42
43 .. image:: images/create_iteration_3.png
44    :align: center
45
46 .. index:: single: hypothesis
47
48 The hypothesis
49 **************
50 The iteration in progress will control the adaptation by HOMARD according to a scenario defined on a hypothesis. This one is selected in the list of the existing hypotheses.
51
52 With starting, it is necessary to create a first hypothesis by activation of the button "*New*" (see: :doc:`gui_create_hypothese`) :
53
54 .. image:: images/create_iteration_4.png
55    :align: center
56
57 Then, if a hypothesis previously defined is appropriate, it is enough to select it in the proposed list. If not, it is necessary to create a new hypothesis by activation of the button "*New*", then to select it in the proposed list:
58
59 .. image:: images/create_iteration_5.png
60    :align: center
61
62 .. note::
63   If one considers an adaptation according to the values of a field on the mesh, it is necessary to have given information about this field before creating a new hypothesis.
64
65 .. index:: single: object browser
66
67 Object browser
68 **************
69 At the conclusion of this creation of iteration, the object browser was enriched. One finds there the initial iteration, identified by the name of the mesh which was read in the provided file, the current iteration, identified by its name. One finds also the hypothesis which is attached to him. The icon compared to the iteration makes it possible to differentiate the iterations calculated or not.
70
71 .. image:: images/create_iteration_6.png
72    :align: center
73
74 When several iterations are connected, their hypothesis is visible in the object browser. One will notice in the figure hereafter that two iterations can share the same hypothesis.
75
76 .. image:: images/create_iteration_7.png
77    :align: center
78
79 Corresponding python functions
80 ******************************
81 Look :doc:`tui_create_iteration`