6 .. index:: single: type of conformity
7 .. index:: single: mesh;initial
9 The variables are described in :doc:`gui_create_case`.
11 Methods of the class homard
12 ***************************
17 +---------------------------------------------------------------+
18 +---------------------------------------------------------------+
19 | .. module:: CreateCase |
21 | **CreateCase(case_name, mesh_name, mesh_file)** |
22 | Returns an instance of the class ``cas`` after its |
25 | - ``case_name``: the name of the case |
26 | - ``mesh_name``: the name of the initial mesh |
27 | - ``mesh_file``: the name of the MED file of this mesh |
31 | * the directory for the results is ``/tmp`` |
32 | * the adaptation is conformal |
33 +---------------------------------------------------------------+
34 | .. module:: GetCase |
36 | **GetCase(case_name)** |
37 | Returns an instance of the class ``cas`` known by its name|
39 | - ``case_name``: the name of the case |
40 +---------------------------------------------------------------+
41 | .. module:: GetAllCasesName |
43 | **GetAllCasesName()** |
44 | Returns the liste of the name of all the existing cases |
46 +---------------------------------------------------------------+
48 Creation of a case by pursuit of a computed iteration
49 =====================================================
51 +---------------------------------------------------------------+
52 +---------------------------------------------------------------+
53 | .. module:: CreateCaseFromIteration |
55 | **CreateCaseFromIteration(case_name, dir_name)** |
56 | Returns an instance of the class ``cas`` after its |
59 | - ``case_name``: the name of the case |
60 | - ``dir_name``: the name of the directory that contains |
63 +---------------------------------------------------------------+
64 | .. module:: CreateCaseFromCaseLastIteration |
66 | **CreateCaseFromCaseLastIteration(case_name, dir_name)** |
67 | Returns an instance of the class ``cas`` after its |
70 | - ``case_name``: the name of the case |
71 | - ``dir_name``: the name of the directory that contains |
74 +---------------------------------------------------------------+
75 | .. module:: CreateCaseFromCaseIteration |
77 | **CreateCaseFromCaseIteration(case_name, dir_name, number)** |
78 | Returns an instance of the class ``cas`` after its |
81 | - ``case_name``: the name of the case |
82 | - ``dir_name``: the name of the directory that contains |
84 | - ``number``: the number of the iteration of the case |
86 +---------------------------------------------------------------+
90 Methods of the class cas
91 ************************
92 .. index:: single: YACS
94 +---------------------------------------------------------------+
95 +---------------------------------------------------------------+
96 | .. module:: GetName |
99 | Returns the name of the case |
100 +---------------------------------------------------------------+
101 | .. module:: SetDirName |
103 | **SetDirName(dirname)** |
104 | Gives a directory for the results of the case. It can be |
105 | done only after the creation of the case and before the |
106 | first computation. |
108 | - ``dirname``: the name of the directory of the results |
109 +---------------------------------------------------------------+
110 | .. module:: GetDirName |
113 | Returns the name of the directory of the results of the |
115 +---------------------------------------------------------------+
116 | .. module:: SetConfType |
118 | **SetConfType(conf_type)** |
119 | Defines the type of conformity for the case |
121 | - ``conf_type``: integer as follows: |
124 | * 1: non conformal with at max 2 cut edges per element|
125 | * 2: non conformal with one hanging node per edge of |
127 | * 3: non conformal without any constraint |
128 | * -1: conformal with boxes (no staircases) |
129 | * -2: non-conformal with boxes (no staircases) |
130 +---------------------------------------------------------------+
131 | .. module:: GetConfType |
133 | **GetConfType()** |
134 | Returns the type of conformity |
135 +---------------------------------------------------------------+
136 | .. module:: GetIter0 |
139 | Returns the iteration linked to the initial mesh. |
140 | This iteration is automatically created by the module |
141 | HOMARD. It is used to connect the iterations. It is |
142 | connected to an initial mesh or to the iteration of a |
144 +---------------------------------------------------------------+
145 | .. module:: AddBoundaryGroup |
147 | **AddBoundaryGroup(boundary, group)** |
148 | Add a boundary to the definition of a case |
150 | - ``boundary``: name of the curved boundary |
152 | Discrete boundary: |
154 | . if all the curved lines are involved, the second |
155 | argument is an empty string. |
156 | . if only some curved lines are involved, ``group`` is |
157 | the name of the group of segments |
159 | Analytical boundary: |
161 | - ``group``: name of the group of faces located on the |
163 +---------------------------------------------------------------+
164 | .. module:: Delete |
166 | **Delete(option)** |
167 | Deletes the case and all the connected iterations. The MED|
168 | file of the first mesh is kept. |
170 | - ``option``: an integer to define what to do with the |
171 | MED file of the associated meshes |
173 | * 0: the files are kept |
174 | * 1: the files are removed |
176 | Returns an integer: |
177 | * 0: the destruction is done |
178 | * other value: problem |
179 +---------------------------------------------------------------+
180 | .. module:: GetState |
183 | Returns the state of the case: |
184 | * 0: corresponds to an initial mesh |
185 | * other value: pursuit of an iteration with number n |
186 +---------------------------------------------------------------+
187 | .. module:: WriteYACSSchema |
189 | **WriteYACSSchema(ScriptFile, DirName, MeshFile)** |
190 | Writes a schema YACS relative to the case. |
192 | - ``ScriptFile`` : name of the file that contains the |
193 | script to launch the computation |
194 | - ``DirName`` : the directory for the computation |
195 | - ``MeshFile`` : name of the file that contains the mesh |
196 | for the very first computation |
197 +---------------------------------------------------------------+
202 +---------------------------------------------------------------+
203 +---------------------------------------------------------------+
204 | .. module:: SetPyram |
206 | **SetPyram(option)** |
207 | Defines the status of the pyramids in this case |
209 | - ``option``: integer that defines the status of the |
210 | pyramids that could belongs to the initial mesh |
212 | * 0: rejected pyramids (default) |
213 | * 1: authorized pyramids |
214 +---------------------------------------------------------------+
215 | .. module:: GetPyram |
218 | Returns the status of the pyramids in this case |
219 +---------------------------------------------------------------+
221 Informations for the initial mesh
222 *********************************
224 +---------------------------------------------------------------+
225 +---------------------------------------------------------------+
226 | .. module:: MeshInfo |
228 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)** |
229 | Gives information about the current mesh. For every |
230 | option, the choice #0 corresponds to 'no action', while |
231 | the choice #1 launches the option. |
233 | - ``Qual``: quality of the elements |
234 | - ``Diam``: diametre of the elements |
235 | - ``Conn``: connexity of the domain; a single block, how |
237 | - ``Tail``: size of the parts of the domain, group by |
239 | - ``Inte``: staggered elements, by dimension |
240 +---------------------------------------------------------------+
245 The creation of the object case_1 is done as follows:
251 mesh_file = "/scratch/Salome/Adapt/m0.med"
252 case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
253 dirname = "/scratch/Salome/Adapt/resu"
254 case_1.SetDirName(dirname)
255 case_1.SetConfType(1)
256 case_1.AddBoundaryGroup( 'intersection', '' )
257 case_1.AddBoundaryGroup( 'cyl_1', 'T1_EXT' )
258 case_1.AddBoundaryGroup( 'cyl_1', 'T2_EXT' )
259 case_1.AddBoundaryGroup( 'cyl_2', 'T_INT' )
263 Similar graphical input
264 ***********************
265 Look at :doc:`gui_create_case`