1 .. _tui_create_iteration:
6 .. index:: single: itération
7 .. index:: single: hypothèse
8 .. index:: single: zone
10 Les variables sont décrites dans :ref:`gui_create_iteration`.
12 Méthodes de la classe homard
13 """"""""""""""""""""""""""""
15 +---------------------------------------------------------------+
16 +---------------------------------------------------------------+
17 | .. module:: GetIteration |
19 | **GetIteration(iter_name)** |
20 | Retourne l'instance de la classe ``iteration`` connue par |
23 | - ``iter_name`` : le nom de l'itération |
24 +---------------------------------------------------------------+
25 | .. module:: GetAllIterationsName |
27 | **GetAllIterationsName()** |
28 | Retourne la liste des noms de toutes les itérations créées|
30 +---------------------------------------------------------------+
32 Méthodes de la classe cas
33 """""""""""""""""""""""""
35 +---------------------------------------------------------------+
36 +---------------------------------------------------------------+
37 | .. module:: NextIteration |
39 | **NextIteration(iter_name)** |
40 | Retourne une instance de la classe ``iteration`` après |
41 | sa création : elle suit immédiatement l'itération |
42 | initiale, correspondant au maillage définissant le cas |
44 | - ``iter_name`` : le nom à donner à la nouvelle itération |
48 | * le maillage produit a le même nom que l'itération |
49 +---------------------------------------------------------------+
50 | .. module:: LastIteration |
52 | **LastIteration()** |
53 | Retourne une instance de la classe ``iteration`` : la |
54 | dernière créée dans la descendance de l'itération initiale|
55 | du cas. C'est celle qui est sans fille. Il y a erreur s'il|
56 | existe plus d'une branche dans la descendance. |
58 +---------------------------------------------------------------+
60 Méthodes de la classe iteration
61 """""""""""""""""""""""""""""""
66 +---------------------------------------------------------------+
67 +---------------------------------------------------------------+
68 | .. module:: NextIteration |
70 | **NextIteration(iter_name)** |
71 | Retourne une instance de la classe ``iteration`` qui suit |
72 | l'itération courante |
74 | - ``iter_name`` : le nom à donner à la nouvelle itération |
78 | * le maillage produit a le même nom que l'itération |
79 +---------------------------------------------------------------+
80 | .. index:: single: Compute |
82 | **Compute(option1, option2)** |
83 | Calcule le maillage correspondant à l'itération |
85 | - ``option1`` : un entier précisant ce qui se passe quand |
86 | des fichiers de résultats existent déjà |
88 | * 0 : arrêt en erreur |
89 | * 1 : écrasement des anciens fichiers |
91 | - ``option2`` : un entier précisant ce qui est fait des |
94 | * 1 : aucune action particulière |
95 | * 2 : publication dans le module SMESH |
97 | Retourne un entier : |
98 | * 0 : adaptation réussie |
99 | * autre valeur : problème |
100 +---------------------------------------------------------------+
101 | .. module:: GetName |
104 | Retourne le nom de l'itération |
105 +---------------------------------------------------------------+
106 | .. module:: GetNumber |
109 | Retourne le numéro de l'itération. |
111 | L'itération 0 est celle associée au maillage initial. |
112 | Ensuite, une itération de numéro N est issue de |
113 | l'adaptation d'une itération de numéro N-1. |
114 +---------------------------------------------------------------+
115 | .. module:: GetIterParent |
117 | **GetIterParent()** |
118 | Retourne l'itération mère |
119 +---------------------------------------------------------------+
120 | .. module:: LastIteration |
122 | **LastIteration()** |
123 | Retourne une instance de la classe ``iteration`` : la |
124 | dernière créée dans la descendance de l'itération. C'est |
125 | celle qui est sans fille. Il y a erreur s'il existe plus |
126 | d'une branche dans la descendance. |
127 +---------------------------------------------------------------+
128 | .. module:: AssociateHypo |
130 | **AssociateHypo(hypo_name)** |
131 | Associe une hypothèse à l'itération |
133 | - ``hypo_name`` : le nom de l'hypothèse à associer |
134 +---------------------------------------------------------------+
135 | .. module:: GetHypoName |
137 | **GetHypoName()** |
138 | Retourne le nom de l'hypothèse associée |
139 +---------------------------------------------------------------+
140 | .. module:: GetCaseName |
142 | **GetCaseName()** |
143 | Retourne le nom du cas associé |
144 +---------------------------------------------------------------+
145 | .. module:: GetState |
148 | Retourne l'état de l'itération |
150 | - ``2`` : itération calculée correctement |
151 | - ``1`` : itération non calculée |
152 | - ``<=0`` : itération initiale à ne pas calculer, de |
153 | numéro valant la valeur absolue de l'état |
154 +---------------------------------------------------------------+
155 | .. module:: GetLogFile |
158 | Retourne le nom du fichier retraçant le déroulement de |
159 | l'exécution de HOMARD |
160 +---------------------------------------------------------------+
161 | .. module:: GetFileInfo |
163 | **GetFileInfo()** |
164 | Retourne le nom du fichier contenant l'abalyse du maillage|
165 +---------------------------------------------------------------+
166 | .. index:: single: Delete |
168 | **Delete(option)** |
169 | Detruit l'itération et toutes ses filles éventuelles. |
171 | - ``option`` : un entier précisant ce qui est fait des |
172 | fichiers de maillage associés |
174 | * 0 : les fichiers sont conservés |
175 | * 1 : les fichiers sont détruits |
177 | Retourne un entier : |
178 | * 0 : destruction réussie |
179 | * autre valeur : problème |
180 +---------------------------------------------------------------+
182 Informations sur les maillages
183 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
185 +---------------------------------------------------------------+
186 +---------------------------------------------------------------+
187 | .. module:: SetMeshName |
189 | **SetMeshName(mesh_name)** |
190 | Définit le nom du maillage produit |
192 | - ``mesh_name`` : le nom du maillage produit |
193 +---------------------------------------------------------------+
194 | .. module:: GetMeshName |
196 | **GetMeshName()** |
197 | Retourne le nom du maillage produit |
198 +---------------------------------------------------------------+
199 | .. module:: SetMeshFile |
201 | **SetMeshFile(mesh_file)** |
202 | Définit le fichier du maillage produit |
204 | - ``mesh_file`` : le nom du fichier qui contiendra |
205 | le maillage produit |
206 +---------------------------------------------------------------+
207 | .. module:: GetMeshFile |
209 | **GetMeshFile()** |
210 | Retourne le nom du fichier du maillage produit |
211 +---------------------------------------------------------------+
212 | .. module:: MeshInfo |
214 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)** |
215 | Donne des informations sur le maillage. Pour chaque |
216 | option, le choix 0 correspond à ne rien faire, alors que |
217 | le choix 1 active l'option. |
219 | - ``Qual`` : qualité des mailles |
220 | - ``Diam`` : diamètre des mailles |
221 | - ``Conn`` : connexité du domaine ; en un seul morceau, |
222 | combien de trous, etc. |
223 | - ``Tail`` : tailles des constituants du domaine, groupe |
225 | - ``Inte`` : interpénétration des mailles, par dimension |
226 +---------------------------------------------------------------+
228 Informations sur le champ
229 ^^^^^^^^^^^^^^^^^^^^^^^^^
231 +---------------------------------------------------------------+
232 +---------------------------------------------------------------+
233 | .. module:: SetFieldFile |
235 | **SetFieldFile(field_file)** |
236 | Définit le fichier des champs utiles |
238 | - ``field_file`` : le nom du fichier contenant le champ |
239 +---------------------------------------------------------------+
240 | .. module:: SetTimeStepRank |
242 | **SetTimeStepRank(TimeStep, Rank)** |
243 | Définit les instants pour le champ |
245 | Si un seul instant est défini pour le champ, il est pris |
248 | Inutile si aucun instant n'est défini pour le champ |
250 | - ``TimeStep`` : l'instant où est pris le champ |
251 | - ``Rank`` : le numéro d'ordre où est pris le champ |
252 +---------------------------------------------------------------+
253 | .. module:: SetTimeStepRankLast |
255 | **SetTimeStepRankLast()** |
256 | Précise que le dernier instant enregistré pour le champ |
258 +---------------------------------------------------------------+
259 | .. module:: GetFieldFileName |
261 | **GetFieldFileName()** |
262 | Retourne le nom du fichier du champ |
263 +---------------------------------------------------------------+
264 | .. module:: GetTimeStep |
266 | **GetTimeStep()** |
267 | Retourne l'instant où est pris le champ |
268 +---------------------------------------------------------------+
269 | .. module:: GetRank |
272 | Retourne le numéro d'ordre où est pris le champ |
273 +---------------------------------------------------------------+
277 .. index:: single: maillage;initial
279 Pour la création de la première itération, on part de celle qui correspond au maillage initial. C'est celle contenue dans le cas. ::
281 iter_name = "Iteration_1"
282 iter_1 = case_1.NextIteration(iter_name)
283 iter_1.SetField(field_file)
284 iter_1.SetTimeStepRank( 0, 0)
285 iter_1.SetMeshName("maill_01")
286 iter_1.SetMeshFile("/local00/M.01.med")
287 iter_1.AssociateHypo("HypoField")
288 codret = iter_1.Compute(1, 2)
290 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
292 iter_name = "Iteration_2"
293 iter_2 = iter_1.NextIteration(iter_name)
294 iter_2.SetField(field_file)
295 iter_2.SetTimeStepRank( 1, 1)
296 iter_2.SetMeshName("maill_02")
297 iter_2.SetMeshFile("/local00/M.02.med")
298 iter_2.AssociateHypo("HypoField")
299 codret = iter_2.Compute(1, 2)
302 Saisie graphique correspondante
303 """""""""""""""""""""""""""""""
304 Consulter :ref:`gui_create_iteration`