6 .. index:: single: type de conformité
7 .. index:: single: maillage;initial
9 Les variables sont décrites dans :doc:`gui_create_case`.
11 Méthodes de la classe homard
12 ****************************
17 +---------------------------------------------------------------+
18 +---------------------------------------------------------------+
19 | .. module:: CreateCase |
21 | **CreateCase(case_name, mesh_name, mesh_file)** |
22 | Retourne une instance de la classe ``cas`` après sa |
25 | - ``case_name`` : le nom du cas |
26 | - ``mesh_name`` : le nom du maillage initial |
27 | - ``mesh_file`` : le nom du fichier MED contenant ce |
32 | * le répertoire des résultats est ``/tmp`` |
33 | * l'adaptation est conforme |
34 +---------------------------------------------------------------+
35 | .. module:: GetCase |
37 | **GetCase(case_name)** |
38 | Retourne l'instance de la classe ``cas`` connue par |
41 | - ``case_name`` : le nom du cas |
42 +---------------------------------------------------------------+
43 | .. module:: GetAllCasesName |
45 | **GetAllCasesName()** |
46 | Retourne la liste des noms de tous les cas existant |
48 +---------------------------------------------------------------+
50 Création d'un cas par poursuite d'une itération calculée
51 ========================================================
53 +---------------------------------------------------------------+
54 +---------------------------------------------------------------+
55 | .. module:: CreateCaseFromIteration |
57 | **CreateCaseFromIteration(case_name, dir_name)** |
58 | Retourne une instance de la classe ``cas`` après sa |
61 | - ``case_name`` : le nom du cas |
62 | - ``dir_name`` : le nom du répertoire contenant |
63 | l'itération à poursuivre |
65 +---------------------------------------------------------------+
66 | .. module:: CreateCaseFromCaseLastIteration |
68 | **CreateCaseFromCaseLastIteration(case_name, dir_name)** |
69 | Retourne une instance de la classe ``cas`` après sa |
72 | - ``case_name`` : le nom du cas |
73 | - ``dir_name`` : le nom du répertoire contenant |
74 | le cas à poursuivre |
76 +---------------------------------------------------------------+
77 | .. module:: CreateCaseFromCaseIteration |
79 | **CreateCaseFromCaseIteration(case_name, dir_name, number)** |
80 | Retourne une instance de la classe ``cas`` après sa |
83 | - ``case_name`` : le nom du cas |
84 | - ``dir_name`` : le nom du répertoire contenant |
85 | le cas à poursuivre |
86 | - ``number`` : le numéro de l'itération du cas |
88 +---------------------------------------------------------------+
92 Méthodes de la classe cas
93 *************************
94 .. index:: single: YACS
96 +---------------------------------------------------------------+
97 +---------------------------------------------------------------+
98 | .. module:: GetName |
101 | Retourne le nom du cas |
102 +---------------------------------------------------------------+
103 | .. module:: SetDirName |
105 | **SetDirName(dirname)** |
106 | Affecte le répertoire des résultats associé au cas. Cela |
107 | ne peut se faire qu'après la création du cas et avant le |
110 | - ``dirname`` : le nom du répertoire des résultats |
111 +---------------------------------------------------------------+
112 | .. module:: GetDirName |
115 | Retourne le nom du répertoire des résultats associé au cas|
116 +---------------------------------------------------------------+
117 | .. module:: SetConfType |
119 | **SetConfType(conf_type)** |
120 | Définit le mode de conformité associé au cas |
122 | - ``conf_type`` : entier précisant le mode de conformité |
124 | * 0 : conforme (défaut) |
125 | * 1 : non conforme avec au minimum 2 aretes coupees |
126 | * 2 : non conforme avec 1 noeud par arete de maille |
127 | * 3 : non conforme quelconque |
128 | * -1 : conforme avec des boites (pas d'escalier) |
129 | * -2 : non-conforme avec des boites (pas d'escalier) |
130 +---------------------------------------------------------------+
131 | .. module:: GetConfType |
133 | **GetConfType()** |
134 | Retourne le type de conformité |
135 +---------------------------------------------------------------+
136 | .. module:: SetExtType |
138 | **SetExtType(ext_type)** |
139 | Définit le type externe associé au cas |
141 | - ``ext_type`` : entier précisant le type externe |
143 | * 0 : MED standard (défaut) |
144 | * 1 : Saturne MED |
145 | * 2 : Saturne 2D MED |
146 +---------------------------------------------------------------+
147 | .. module:: GetExtType |
150 | Retourne le type externe associé au cas |
151 +---------------------------------------------------------------+
152 | .. module:: GetIter0 |
155 | Retourne l'itération associée au maillage initial. |
156 | Cette itération est créée automatiquement par le module |
157 | HOMARD et est utilisée pour enchaîner les adaptations. |
158 | Elle correspond à un maillage initial ou à une itération |
159 | de poursuite d'un cas précédent. |
160 +---------------------------------------------------------------+
161 | .. module:: AddBoundaryGroup |
163 | **AddBoundaryGroup(boundary, group)** |
164 | Ajoute une frontière à la définition du cas |
166 | - ``boundary`` : nom d'une frontière courbe à suivre |
168 | Pour une frontière discrète : |
170 | . si toutes les lignes courbes sont suivies, le second |
171 | argument est une chaîne vide. |
172 | . si seulement certaines lignes courbes sont suivies, |
173 | ``group`` est le nom d'un groupe de segments à suivre. |
175 | Pour une frontière analytique : |
177 | - ``group`` : nom d'un groupe de faces placées sur la |
179 +---------------------------------------------------------------+
180 | .. module:: Delete |
182 | **Delete(option)** |
183 | Detruit le cas et toutes les itérations associées. Le |
184 | fichier du maillage initial associé est conservé. |
186 | - ``option`` : un entier précisant ce qui est fait des |
187 | fichiers de maillage associés |
189 | * 0 : les fichiers sont conservés |
190 | * 1 : les fichiers sont supprimés |
192 | Retourne un entier : |
193 | * 0 : destruction réussie |
194 | * autre valeur : problème |
195 +---------------------------------------------------------------+
196 | .. module:: GetState |
199 | Retourne l'état du cas : |
200 | * 0 : correspond à un maillage initial |
201 | * autre valeur : poursuite d'une itération de numéro n|
202 +---------------------------------------------------------------+
203 | .. module:: CreateYACSSchema |
205 | **CreateYACSSchema(yacs_name, ScriptFile, DirName, MeshFile)**|
206 | Retourne une instance de la classe ``yacs`` après sa |
209 | - ``yacs_name`` : le nom du schéma |
210 | - ``ScriptFile`` : le fichier du script python qui permet |
211 | de lancer le calcul à coupler avec l'adaptation de |
213 | - ``DirName`` : le répertoire où a lieu le calcul |
214 | - ``MeshFile`` : le fichier MED contenant le tout premier |
215 | maillage de calcul |
216 +---------------------------------------------------------------+
221 +---------------------------------------------------------------+
222 +---------------------------------------------------------------+
223 | .. module:: SetPyram |
225 | **SetPyram(option)** |
226 | Définit le statut des pyramides pour le cas |
228 | - ``option`` : entier précisant le statut des pyramides |
229 | éventuellement présentes dans le maillage initial |
231 | * 0 : pyramides refusées (défaut) |
232 | * 1 : pyramides autorisées |
233 +---------------------------------------------------------------+
234 | .. module:: GetPyram |
237 | Retourne le statut accordé aux pyramides éventuellement |
238 | présentes dans le maillage initial |
239 +---------------------------------------------------------------+
241 Informations sur le maillage initial
242 ====================================
244 +---------------------------------------------------------------+
245 +---------------------------------------------------------------+
246 | .. module:: MeshInfo |
248 | **MeshInfo(Qual, Diam, Conn, Tail, Inte)** |
249 | Donne des informations sur le maillage. Pour chaque |
250 | option, le choix 0 correspond à ne rien faire, alors que |
251 | le choix 1 active l'option. |
253 | - ``Qual`` : qualité des mailles |
254 | - ``Diam`` : diamètre des mailles |
255 | - ``Conn`` : connexité du domaine ; en un seul morceau, |
256 | combien de trous, etc. |
257 | - ``Tail`` : tailles des constituants du domaine, groupe |
259 | - ``Inte`` : interpénétration des mailles, par dimension |
260 +---------------------------------------------------------------+
265 La création de l'objet case_1 se fait ainsi : ::
269 mesh_file = "/home/A1789/Adapt/m0.med"
270 case_1 = homard.CreateCase(case_name, mesh_name, mesh_file)
271 dirname = "/home/A1789/Adapt/resu"
272 case_1.SetDirName(dirname)
273 case_1.SetConfType(1)
275 case_1.AddBoundaryGroup( 'intersection', '' )
276 case_1.AddBoundaryGroup( 'cyl_1', 'T1_EXT' )
277 case_1.AddBoundaryGroup( 'cyl_1', 'T2_EXT' )
278 case_1.AddBoundaryGroup( 'cyl_2', 'T_INT' )
282 Saisie graphique correspondante
283 *******************************
284 Consulter :doc:`gui_create_case`