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(option)** |
83 | Calcule le maillage correspondant à l'itération |
85 | - ``option`` : 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 | Retourne un entier : |
92 | * 0 : adaptation réussie |
93 | * autre valeur : problème |
94 +---------------------------------------------------------------+
95 | .. module:: GetName |
98 | Retourne le nom de l'itération |
99 +---------------------------------------------------------------+
100 | .. module:: GetNumber |
103 | Retourne le numéro de l'itération. |
105 | L'itération 0 est celle associée au maillage initial. |
106 | Ensuite, une itération de numéro N est issue de |
107 | l'adaptation d'une itération de numéro N-1. |
108 +---------------------------------------------------------------+
109 | .. module:: GetIterParent |
111 | **GetIterParent()** |
112 | Retourne l'itération mère |
113 +---------------------------------------------------------------+
114 | .. module:: LastIteration |
116 | **LastIteration()** |
117 | Retourne une instance de la classe ``iteration`` : la |
118 | dernière créée dans la descendance de l'itération. C'est |
119 | celle qui est sans fille. Il y a erreur s'il existe plus |
120 | d'une branche dans la descendance. |
121 +---------------------------------------------------------------+
122 | .. module:: AssociateHypo |
124 | **AssociateHypo(hypo_name)** |
125 | Associe une hypothèse à l'itération |
127 | - ``hypo_name`` : le nom de l'hypothèse à associer |
128 +---------------------------------------------------------------+
129 | .. module:: GetHypoName |
131 | **GetHypoName()** |
132 | Retourne le nom de l'hypothèse associée |
133 +---------------------------------------------------------------+
134 | .. module:: GetCaseName |
136 | **GetCaseName()** |
137 | Retourne le nom du cas associé |
138 +---------------------------------------------------------------+
139 | .. module:: GetState |
142 | Retourne l'état de l'itération |
144 | - ``0`` : itération non calculée |
145 | - ``1`` : itération calculée correctement |
146 +---------------------------------------------------------------+
147 | .. module:: GetLogFile |
150 | Retourne le nom du fichier retraçant le déroulement de |
151 | l'exécuion de HOMARD |
152 +---------------------------------------------------------------+
153 | .. module:: GetFileInfo |
155 | **GetFileInfo()** |
156 | Retourne le nom du fichier contenant l'abalyse du maillage|
157 +---------------------------------------------------------------+
158 | .. index:: single: Delete |
160 | **Delete(option)** |
161 | Detruit l'itération et toutes ses filles éventuelles. |
163 | - ``option`` : un entier précisant ce qui est fait des |
164 | fichiers de maillage associés |
166 | * 0 : les fichiers sont conservés |
167 | * 1 : les fichiers sont détruits |
169 | Retourne un entier : |
170 | * 0 : destruction réussie |
171 | * autre valeur : problème |
172 +---------------------------------------------------------------+
174 Informations sur les maillages
175 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177 +---------------------------------------------------------------+
178 +---------------------------------------------------------------+
179 | .. module:: SetMeshName |
181 | **SetMeshName(mesh_name)** |
182 | Définit le nom du maillage produit |
184 | - ``mesh_name`` : le nom du maillage produit |
185 +---------------------------------------------------------------+
186 | .. module:: GetMeshName |
188 | **GetMeshName()** |
189 | Retourne le nom du maillage produit |
190 +---------------------------------------------------------------+
191 | .. module:: SetMeshFile |
193 | **SetMeshFile(mesh_file)** |
194 | Définit le fichier du maillage produit |
196 | - ``mesh_file`` : le nom du fichier qui contiendra |
197 | le maillage produit |
198 +---------------------------------------------------------------+
199 | .. module:: GetMeshFile |
201 | **GetMeshFile()** |
202 | Retourne le nom du fichier du maillage produit |
203 +---------------------------------------------------------------+
204 | .. module:: MeshInfo |
206 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)** |
207 | Donne des informations sur le maillage. Pour chaque |
208 | option, le choix 0 correspond à ne rien faire, alors que |
209 | le choix 1 active l'option. |
211 | - ``Qual`` : qualité des mailles |
212 | - ``Diam`` : diamètre des mailles |
213 | - ``Conn`` : connexité du domaine ; en un seul morceau, |
214 | combien de trous, etc. |
215 | - ``Tail`` : tailles des constituants du domaine, groupe |
217 | - ``Inte`` : interpénétration des mailles, par dimension |
218 +---------------------------------------------------------------+
220 Informations sur le champ
221 ^^^^^^^^^^^^^^^^^^^^^^^^^
223 +---------------------------------------------------------------+
224 +---------------------------------------------------------------+
225 | .. module:: SetFieldFile |
227 | **SetFieldFile(field_file)** |
228 | Définit le fichier des champs utiles |
230 | - ``field_file`` : le nom du fichier contenant le champ |
231 +---------------------------------------------------------------+
232 | .. module:: SetTimeStepRank |
234 | **SetTimeStepRank(TimeStep, Rank)** |
235 | Définit les instants pour le champ |
237 | Si un seul instant est défini pour le champ, il est pris |
240 | Inutile si aucun instant n'est défini pour le champ |
242 | - ``TimeStep`` : l'instant où est pris le champ |
243 | - ``Rank`` : le numéro d'ordre où est pris le champ |
244 +---------------------------------------------------------------+
245 | .. module:: SetTimeStepRankLast |
247 | **SetTimeStepRankLast()** |
248 | Précise que le dernier instant enregistré pour le champ |
250 +---------------------------------------------------------------+
251 | .. module:: GetFieldFileName |
253 | **GetFieldFileName()** |
254 | Retourne le nom du fichier du champ |
255 +---------------------------------------------------------------+
256 | .. module:: GetTimeStep |
258 | **GetTimeStep()** |
259 | Retourne l'instant où est pris le champ |
260 +---------------------------------------------------------------+
261 | .. module:: GetRank |
264 | Retourne le numéro d'ordre où est pris le champ |
265 +---------------------------------------------------------------+
269 .. index:: single: maillage;initial
271 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. ::
273 iter_name = "Iteration_1"
274 iter_1 = case_1.NextIteration(iter_name)
275 iter_1.SetField(field_file)
276 iter_1.SetTimeStepRank( 0, 0)
277 iter_1.SetMeshName("maill_01")
278 iter_1.SetMeshFile("/local00/M.01.med")
279 iter_1.AssociateHypo("HypoField")
280 codret = iter_1.Compute(1)
282 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
284 iter_name = "Iteration_2"
285 iter_2 = iter_1.NextIteration(iter_name)
286 iter_2.SetField(field_file)
287 iter_2.SetTimeStepRank( 1, 1)
288 iter_2.SetMeshName("maill_02")
289 iter_2.SetMeshFile("/local00/M.02.med")
290 iter_2.AssociateHypo("HypoField")
291 codret = iter_2.Compute(1)
294 Saisie graphique correspondante
295 """""""""""""""""""""""""""""""
296 Consulter :ref:`gui_create_iteration`