Salome HOME
Merge branch 'V9_12_BR'
[modules/homard.git] / doc / en / gui_create_case.rst
1 .. _gui_create_case:
2
3 The creation of a case
4 ######################
5 .. index:: single: case
6
7 The definition of a case is done with the following data:
8
9   - A name
10   - A directory
11   - The file of the initial mesh
12   - The type of conformity for the serie of adaptations
13   - Some curved boundaries
14
15 .. image:: images/intro_32.png
16    :align: center
17
18
19 Name of the case
20 ****************
21 A name is automatically suggested for the case: Case_1, Case_2, etc. This name can be modified. It must be a new name.
22
23 The directory
24 *************
25 The directory will countain all the files producted by the successive adaptations. By default, nothing is suggested. The choice is made either by giving a name into the text zone or by a selection through the search window. In this directory, the MED files for the adapted mesh will be stored, with name ``maill.xx.med``, where ``xx`` is a rank number automatically created. These files can be seen into the object browser.
26
27 .. image:: images/create_case_2.png
28    :align: center
29
30 .. index:: single: mesh;initial
31 .. index:: single: MED
32
33 The initial mesh
34 ****************
35 The initial mesh must be stored into a MED file. Usually, it is produced by the software that solves the physical problem. But it also can be created by the module SMESH and exported with the MED format. The name of the file is choosen either by giving a name into the text zone or by a selection through the search window.
36
37
38 .. image:: images/create_case_3.png
39    :align: center
40
41 .. note::
42   Only one mesh into the file.
43
44 .. warning::
45   The initial mesh must not be itself the product of an adaptation by HOMARD. If it is, the coherence between the different levels of refinement will be lost.
46
47
48 .. index:: single: conformity
49
50 Type of conformity
51 ******************
52 The future iterations for this case must respect the the same behaviour regarding the type of conformity.
53
54 The default option, 'conformal', implies that the meshes produced by HOMARD will be conformal, as expected in the finite element method. This is a classical choice for most of the simulation software with the finite element method.
55
56 The treatment of non conformal meshes is possible.
57
58 .. image:: images/create_case_4.png
59    :align: center
60
61 Some extra options can be given by the advanced options.
62
63 .. index:: single: boundary
64
65 The boundaries
66 **************
67 If the limit of the domain is curved, HOMARD can put the new nodes onto these curved limits to avoid some artificial singularities. This technique is effective for external limits as well for internal limits.
68
69 Two situations:
70
71 - CAO: the CAO of the domain is available. The computtion will rely on it to project the nodes.
72 - No CAO: if no CAO is available, an approximative approach is possible:
73
74   * 1D curve: this curve may be defined into a plane, for example for a 2D calculation. It can also be defined into the 3D space, for example to describe the intersection of two surfaces. Such a line is defined with a discrete desription.
75   * a surface: such a surface is defined with an analytical description.
76
77 Check the button:
78
79 .. image:: images/create_boundary_1.png
80    :align: center
81
82 The definition of the boundaries is described in :doc:`gui_create_boundary`.
83
84 .. index:: single: pyramid
85
86 Advanced options
87 ****************
88 Default: no advanced option. Nevertheless, some advanced options can be defined :
89
90 The pyramids
91 ============
92
93 The first option is about the pyramids.
94
95 .. image:: images/create_case_7.png
96    :align: center
97
98 HOMARD is able to work with 2D or 3D meshes as well, including the following elements:
99    - nodal element
100    - segment
101    - triangle
102    - quadrangle
103    - tetrahedron
104    - hexahedron
105    - prism
106
107 If pyramids are present into the initial mesh, HOMARD stops with an error. However, if no refinement will be in contact with any edge of those pyramids, the "Authorized pyramids" whould be checked. The adaptation will go on and the pyramids will be back as they are into the initial mesh.
108 Nevertheless, if the computation is available with non conformal meshes, 3 possibilities are available:
109
110 Which conformity?
111 =================
112
113 With a conformal refinement, the choice is given between the standard conformal refinement, default option, and a refinement into boxes, e.g. without any staircases.
114
115 .. image:: images/create_case_8.png
116    :align: center
117
118 Which non conformity?
119 =====================
120
121 With a non conformal refinement, 4 choices are available:
122
123 * standard non conformal refinement, default option
124 * refinement into boxes, e.g. without any staircases
125 * 1 node per edge: every single edge of an element ban be split once while its neighbour is not.
126 * free: no limit for the number of hanging node.
127
128 .. image:: images/create_case_9.png
129    :align: center
130
131 The external format
132 ===================
133 .. index:: single: MED
134 .. index:: single: Saturne
135
136 By default, the external format is MED. When coupled with Saturne 2D, it is necessary to precise it to correctly deal with the pseudo 2D situation.
137
138 .. image:: ../images/create_case_1.png
139    :align: center
140
141 The pursuit of a case
142 *********************
143 .. index:: single: pursuit
144 .. index:: single: YACS
145
146 The pursuit of a case is interesting in the following situation. A list of adaptations was done for a case and, at the end, SALOME is closed. The directories for these iterations are kept. Then, the user wants to go on these iterations from the final point of the previous list. This function is useful with a schema YACS if a long list of adaptations is cut into small parts.
147
148 The compulsatory condition to pursue an iteration is to keep two files into the same directory:
149    - the configuration file that was a data for the binary module of HOMARD; this file looks like ``HOMARD.Configuration.(n).vers.(n+1)``
150    - the MED file that saves the history of th eprevious adaptations; this file looks like ``maill.(n).hom.med``
151
152 Either an iteration known by its directory or an iteration identified into the directory of a case can be selected.
153
154 To pursuit of an iteration known by its directory, the definition of the case is made by the following data:
155
156   - A name
157   - A directory
158   - The directory of the data base
159
160 .. image:: images/pursue_case_1.png
161    :align: center
162
163 The pursuit of an iteration into a previous case can be operated; the default starting iteration is the last iteration of the case.
164
165 .. image:: images/pursue_case_2.png
166    :align: center
167
168 If the starting iteration is not the last one, its number must be given:
169
170 .. image:: images/pursue_case_3.png
171    :align: center
172
173 .. note::
174   The governing parameters of the created case are the same as the ones of the strating iteration: same mode for the conformity, for instance.
175
176
177 Object browser
178 **************
179 At the end of the creation, the case is included into the object browser. The initial iteration, known by the name of the associated mesh, is shown.
180
181 .. image:: images/create_case_6.png
182    :align: center
183
184
185
186 Corresponding python functions
187 ******************************
188 Look :doc:`tui_create_case`
189