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:: CreateIteration |
19 | **CreateIteration(iter_name, iter_parent_name)** |
20 | Retourne une instance de la classe iteration |
22 | - ``iter_name`` : le nom de l'itération |
23 | - ``iter_parent_name`` : le nom de l'itération mère |
27 | * le maillage produit a le même nom que l'itération |
28 +---------------------------------------------------------------+
29 | .. module:: AssociateIterHypo |
31 | **AssociateIterHypo(iter_name, hypo_name)** |
33 | - ``iter_name`` : le nom de l'itération |
34 | - ``hypo_name`` : le nom de l'hypothèse à associer |
35 +---------------------------------------------------------------+
37 Méthodes de la classe iteration
38 """""""""""""""""""""""""""""""
43 +---------------------------------------------------------------+
44 +---------------------------------------------------------------+
45 | .. index:: single: Compute |
47 | **Compute(option)** |
48 | Calcule le maillage correspondant à l'itération |
50 | - ``option`` : un entier précisant ce qui se passe quand |
51 | des fichiers de résultats existent déjà |
53 | * 0 : arrêt en erreur |
54 | * 1 : écrasement des anciens fichiers |
56 | Retourne un entier : |
57 | * 0 : adaptation réussie |
58 | * autre valeur : problème |
59 +---------------------------------------------------------------+
60 | .. module:: GetName |
63 | Retourne le nom de l'itération |
64 +---------------------------------------------------------------+
65 | .. module:: GetNumber |
68 | Retourne le numéro de l'itération. |
70 | L'itération 0 est celle associée au maillage initial. |
71 | Ensuite, une itération de numéro N est issue de |
72 | l'adaptation d'une itération de numéro N-1. |
73 +---------------------------------------------------------------+
74 | .. module:: GetIterParent |
76 | **GetIterParent()** |
77 | Retourne le nom de l'itération mère |
78 +---------------------------------------------------------------+
79 | .. module:: GetHypoName |
82 | Retourne le nom de l'hypothèse associée |
83 +---------------------------------------------------------------+
84 | .. module:: GetCaseName |
87 | Retourne le nom du cas associé |
88 +---------------------------------------------------------------+
89 | .. module:: GetState |
92 | Retourne l'état de l'itération |
94 | - ``0`` : itération non calculée |
95 | - ``1`` : itération calculée correctement |
96 +---------------------------------------------------------------+
98 Informations sur les maillages
99 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 +---------------------------------------------------------------+
102 +---------------------------------------------------------------+
103 | .. module:: GetMeshName |
105 | **GetMeshName()** |
106 | Retourne le nom du maillage produit |
107 +---------------------------------------------------------------+
108 | .. module:: SetMeshFile |
110 | **SetMeshFile(mesh_file)** |
112 | - ``mesh_file`` : le nom du fichier qui contiendra |
113 | le maillage produit |
114 +---------------------------------------------------------------+
115 | .. module:: GetMeshFile |
117 | **GetMeshFile()** |
118 | Retourne le nom du fichier du maillage produit |
119 +---------------------------------------------------------------+
121 Informations sur le champ
122 ^^^^^^^^^^^^^^^^^^^^^^^^^
124 +---------------------------------------------------------------+
125 +---------------------------------------------------------------+
126 | .. module:: SetFieldFile |
128 | **SetFieldFile(field_file)** |
130 | - ``field_file`` : le nom du fichier contenant le champ |
131 +---------------------------------------------------------------+
132 | .. module:: SetTimeStepRank |
134 | **SetTimeStepRank(TimeStep, Rank)** |
136 | - ``TimeStep`` : l'instant où est pris le champ |
137 | - ``Rank`` : le numéro d'ordre où est pris le champ |
138 +---------------------------------------------------------------+
139 | .. module:: GetFieldFileName |
141 | **GetFieldFileName()** |
142 | Retourne le nom du fichier du champ |
143 +---------------------------------------------------------------+
144 | .. module:: GetTimeStep |
146 | **GetTimeStep()** |
147 | Retourne l'instant où est pris le champ |
148 +---------------------------------------------------------------+
149 | .. module:: GetRank |
152 | Retourne le numéro d'ordre où est pris le champ |
153 +---------------------------------------------------------------+
157 .. index:: single: maillage;initial
159 Pour la création de la première itération, il faut récupérer le nom qui a été donné à celle qui correspond au maillage initial. Ce nom s'obtient avec la méthode ``GetIter0Name`` appliquée au cas. ::
161 iter_name = "Iteration_1"
162 iter_1 = homard.CreateIteration(iter_name, case_1.GetIter0Name())
163 iter_1.SetField(field_file, 0, 0)
164 iter_1.SetMeshName("maill_01")
165 iter_1.SetMeshFile("/local00/M.01.med")
166 homard.AssociateIterHypo(iter_name, "HypoField")
167 codret = iter_1.Compute(1)
169 Pour la création d'une itération suivante, on donnera le nom de l'itération parent de laquelle on part. ::
171 iter_name = "Iteration_2"
172 iter_2 = homard.CreateIteration(iter_name, "Iteration_1")
173 iter_2.SetField(field_file, 0, 0)
174 iter_2.SetMeshName("maill_02")
175 iter_2.SetMeshFile("/local00/M.02.med")
176 homard.AssociateIterHypo(iter_name, "HypoField")
177 codret = iter_2.Compute(1)
180 Saisie graphique correspondante
181 """""""""""""""""""""""""""""""
182 Consulter :ref:`gui_create_iteration`