Salome HOME
Mise à jour de la documentation
[modules/homard.git] / doc / en / tutorials.rst
1 Examples
2 ########
3 .. index:: single: example
4 .. index:: single: python
5
6 One will find here the instructions python for some characteristic configurations. The associated data files are downloadable. It is necessary to think of adapting the value of the variable ``data_dir``: it is the directory in which the files med will have been recorded.
7 It is in the directory ``dircase`` that the files will be written resulting from the successive adaptations. This directory is created by default in ``/tmp``.
8
9 Loading of the module HOMARD
10 ****************************
11 .. index:: single: yacs
12
13 The loading of the module HOMARD is done in a way similar to the other modules.
14
15  ::
16
17   import HOMARD
18   homard = salome.lcc.FindOrLoadComponent('FactoryServer','HOMARD')
19   homard.SetCurrentStudy(salome.myStudy)
20
21 To use the module HOMARD within a distributed scheme YACS, the loading is made as follows:
22
23  ::
24
25   import HOMARD
26   my_container.load_component_Library('HOMARD')
27   homard = my_container.create_component_instance('HOMARD',0)
28   homard.SetCurrentStudy(salome.myStudy)
29
30 Uniform refinement
31 ******************
32 .. index:: single: refinement;uniform
33
34 One will make here three successive uniform refinements of the mesh contained in the file ``tutorial_1.00.med``. Some notes:
35   * the same hypothesis is used with each iteration
36   * the produced mesh always bears the same name. That does not pose a problem because it is stored in different files.
37
38
39 .. literalinclude:: ../files/tutorial_1.py
40    :lines: 57-89
41
42 .. note::
43   Download the files
44
45   * :download:`initial mesh<../files/tutorial_1.00.med.gz>`
46   * :download:`python script<../files/tutorial_1.py>`
47
48
49 Refinement by zones
50 *******************
51 .. index:: single: zone
52
53 One proceeds here to refinement according to zones. To pass from the initial mesh to the mesh 'M_1', one uses a box framing the z=1 plane and a sphere centered on the origin with radius 1.05. Then to pass from the mesh 'M_1' to the mesh 'M_2', one replaces the sphere by a box framing the cube on side 0.5, pointing on the origin. It will be noted that the type of refinement was not specified; by default, it will be thus in conformity.
54
55 .. literalinclude:: ../files/tutorial_2.py
56    :lines: 57-101
57
58 .. note::
59   Download the files
60
61   * :download:`initial mesh<../files/tutorial_2.00.med.gz>`
62   * :download:`python script<../files/tutorial_2.py>`
63
64
65 Refinement driven by a field
66 ****************************
67 .. index:: single: field
68
69 One proceeds here to refinement according to a field. The hypotheses are used to define the name of the field and the thresholds of refinement/unefinement. The input of the file and the instants is made in the iteration. Fields on the nodes or the elements are interpolated.
70 To adapt the H_1 mesh resulting from the Iter_1 iteration, two alternatives are applied. In the first, Iter_2, the field is a scalar field of indicators of error and one cuts out the 1.5% of elements where the error is largest. In the second alternative, Iter_2_bis, one is based on a vector field and one examines the jump of this vector between an element and its neighbors: one will cut out where the infinite standard of this jump is higher than the absolute threshold of 0.0001.
71
72 .. literalinclude:: ../files/tutorial_3.py
73    :lines: 57-131
74
75 .. note::
76   Download the files
77
78   * :download:`mesh and field stage 0<../files/tutorial_3.00.med.gz>`
79   * :download:`mesh and field stage 1<../files/tutorial_3.01.med.gz>`
80   * :download:`python script<../files/tutorial_3.py>`
81
82
83 Non plane boundaries
84 ********************
85 .. index:: single: field
86 .. index:: single: yacs
87
88 One tests the follow-up of the curved borders here: analytical borders to describe various surfaces of the pipes and a discrete border to describe the intersecting lines of the two pipes. The driving of refinement is the following: uniform refinement of all the elements contained in indicated groups. One starts by refining the inner faces with the pipes; then, one refines continuation twice the external faces with the pipes.
89 Scheme YACS carrying out this adaptation is downloadable.
90
91 .. literalinclude:: ../files/tutorial_4.py
92    :lines: 57-115
93
94 .. note::
95   Download the files
96
97   * :download:`initial mesh<../files/tutorial_4.00.med.gz>`
98   * :download:`mesh of the discrete boundary<../files/tutorial_4.fr.med.gz>`
99   * :download:`python script<../files/tutorial_4.py>`
100   * :download:`YACS scheme<../files/tutorial_4.xml>`
101
102
103 Specific instructions for a 2D mesh
104 ***********************************
105 .. index:: single: 2D
106
107 The instructions to adapt a 2D mesh are exactly identical to those necessary to the adaptation of a 3D mesh. The only exception relates to refinement according to geometrical zones: different functions are used to be able to define 2D zones. One gives the 2D coordinates zones, by specifying the orientation of the plane of the mesh.
108 In the case presented here, one for the first time refines all the elements contained in a bored disk, then in one second iteration, all the elements contained in a rectangle. One will note the use of the follow-up of the circular borders of the field.
109
110 .. literalinclude:: ../files/tutorial_5.py
111    :lines: 57-101
112
113 .. note::
114   Download the files
115
116   * :download:`initial mesh<../files/tutorial_5.00.med.gz>`
117   * :download:`mesh of the discrete boundary<../files/tutorial_5.fr.med.gz>`
118   * :download:`python script<../files/tutorial_5.py>`
119
120
121 .. toctree::
122    :maxdepth: 2