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 | .. index:: single: Delete |
150 | Detruit l'itération et toutes ses filles éventuelles. Les |
151 | fichiers des maillages associés sont supprimés. |
153 | Retourne un entier : |
154 | * 0 : destruction réussie |
155 | * autre valeur : problème |
156 +---------------------------------------------------------------+
158 Informations sur les maillages
159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
161 +---------------------------------------------------------------+
162 +---------------------------------------------------------------+
163 | .. module:: SetMeshName |
165 | **SetMeshName(mesh_name)** |
166 | Définit le nom du maillage produit |
168 | - ``mesh_name`` : le nom du maillage produit |
169 +---------------------------------------------------------------+
170 | .. module:: GetMeshName |
172 | **GetMeshName()** |
173 | Retourne le nom du maillage produit |
174 +---------------------------------------------------------------+
175 | .. module:: SetMeshFile |
177 | **SetMeshFile(mesh_file)** |
178 | Définit le fichier du maillage produit |
180 | - ``mesh_file`` : le nom du fichier qui contiendra |
181 | le maillage produit |
182 +---------------------------------------------------------------+
183 | .. module:: GetMeshFile |
185 | **GetMeshFile()** |
186 | Retourne le nom du fichier du maillage produit |
187 +---------------------------------------------------------------+
189 Informations sur le champ
190 ^^^^^^^^^^^^^^^^^^^^^^^^^
192 +---------------------------------------------------------------+
193 +---------------------------------------------------------------+
194 | .. module:: SetFieldFile |
196 | **SetFieldFile(field_file)** |
197 | Définit le fichier des champs utiles |
199 | - ``field_file`` : le nom du fichier contenant le champ |
200 +---------------------------------------------------------------+
201 | .. module:: SetTimeStepRank |
203 | **SetTimeStepRank(TimeStep, Rank)** |
204 | Définit les instants pour le champ |
206 | Inutile si aucun instant n'est défini pour le champ |
208 | - ``TimeStep`` : l'instant où est pris le champ |
209 | - ``Rank`` : le numéro d'ordre où est pris le champ |
210 +---------------------------------------------------------------+
211 | .. module:: GetFieldFileName |
213 | **GetFieldFileName()** |
214 | Retourne le nom du fichier du champ |
215 +---------------------------------------------------------------+
216 | .. module:: GetTimeStep |
218 | **GetTimeStep()** |
219 | Retourne l'instant où est pris le champ |
220 +---------------------------------------------------------------+
221 | .. module:: GetRank |
224 | Retourne le numéro d'ordre où est pris le champ |
225 +---------------------------------------------------------------+
229 .. index:: single: maillage;initial
231 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. ::
233 iter_name = "Iteration_1"
234 iter_1 = case_1.NextIteration(iter_name)
235 iter_1.SetField(field_file)
236 iter_1.SetTimeStepRank( 0, 0)
237 iter_1.SetMeshName("maill_01")
238 iter_1.SetMeshFile("/local00/M.01.med")
239 iter_1.AssociateHypo("HypoField")
240 codret = iter_1.Compute(1)
242 Ensuite, on crée une itération suivante à l'itération parent de laquelle on part. ::
244 iter_name = "Iteration_2"
245 iter_2 = iter_1.NextIteration(iter_name)
246 iter_2.SetField(field_file)
247 iter_2.SetTimeStepRank( 1, 1)
248 iter_2.SetMeshName("maill_02")
249 iter_2.SetMeshFile("/local00/M.02.med")
250 iter_2.AssociateHypo("HypoField")
251 codret = iter_2.Compute(1)
254 Saisie graphique correspondante
255 """""""""""""""""""""""""""""""
256 Consulter :ref:`gui_create_iteration`