6 .. index:: single: YACS
8 Les variables sont décrites dans :doc:`gui_create_yacs`.
10 Méthodes de la classe cas
11 *************************
12 Voir également dans :doc:`tui_create_case`.
14 +---------------------------------------------------------------+
15 +---------------------------------------------------------------+
16 | .. module:: CreateYACSSchema |
18 | **CreateYACSSchema(yacs_name, ScriptFile, DirName, MeshFile)**|
19 | Retourne une instance de la classe ``yacs`` après sa |
22 | - ``yacs_name`` : le nom du schéma |
23 | - ``ScriptFile`` : le fichier du script python qui permet |
24 | de lancer le calcul à coupler avec l'adaptation de |
26 | - ``DirName`` : le répertoire où a lieu le calcul |
27 | - ``MeshFile`` : le fichier MED contenant le tout premier |
28 | maillage de calcul |
29 +---------------------------------------------------------------+
31 Méthodes de la classe homard
32 ****************************
34 +---------------------------------------------------------------+
35 +---------------------------------------------------------------+
36 | .. module:: GetYACS |
38 | **GetYACS(yacs_name)** |
39 | Retourne l'instance de la classe ``yacs`` connue par |
42 | - ``yacs_name`` : le nom du schéma |
43 +---------------------------------------------------------------+
44 | .. module:: GetAllYACSsName |
46 | **GetAllYACSsName()** |
47 | Retourne la liste des noms de tous les schémas existant |
48 +---------------------------------------------------------------+
52 Méthodes de la classe YACS
53 **************************
58 +---------------------------------------------------------------+
59 +---------------------------------------------------------------+
63 | Ecrit le schéma dans le fichier lié au schéma |
64 | Par défaut, c'est le fichier ``schema.xml``, dans le |
65 | répertoire du cas. Si ``WriteOnFile`` a été utilisé |
66 | auparavant, l'écriture a lieu dans le nouveau fichier. |
68 | Retourne un entier : |
69 | * 0 : écriture réussie |
70 | * autre valeur : problème |
71 +---------------------------------------------------------------+
72 | .. module:: WriteOnFile |
74 | **WriteOnFile(file_xml)** |
75 | Ecrit le schéma dans un fichier désigné. |
77 | - ``file_xml`` : nom du fichier xml du schéma |
79 | Retourne un entier : |
80 | * 0 : écriture réussie |
81 | * autre valeur : problème |
82 +---------------------------------------------------------------+
83 | .. module:: Delete |
85 | **Delete(option)** |
86 | Detruit le schéma. |
88 | - ``option`` : un entier précisant ce qui est fait du |
89 | fichier xml du schéma |
91 | * 0 : le fichier est conservé |
92 | * 1 : le fichier est détruit |
94 | Retourne un entier : |
95 | * 0 : destruction réussie |
96 | * autre valeur : problème |
97 +---------------------------------------------------------------+
100 Informations sur le schéma
101 ==========================
103 +---------------------------------------------------------------+
104 +---------------------------------------------------------------+
105 | .. module:: GetName |
108 | Retourne le nom du schéma. |
109 +---------------------------------------------------------------+
110 | .. module:: SetType |
112 | **SetType(Type)** |
113 | Définit le type de schéma. |
115 | - ``Type`` : le type de schéma |
119 +---------------------------------------------------------------+
120 | .. module:: GetType |
123 | Retourne le type du schéma. |
124 +---------------------------------------------------------------+
125 | .. module:: SetScriptFile |
127 | **SetScriptFile(script_file)** |
128 | Définit le fichier du script python de lancement du |
131 | - ``script_file`` : le nom du fichier qui contient le |
133 +---------------------------------------------------------------+
134 | .. module:: GetScriptFile |
136 | **GetScriptFile()** |
137 | Retourne le nom du fichier MED qui contient le script |
139 +---------------------------------------------------------------+
140 | .. module:: SetDirName |
142 | **SetDirName(dir_name)** |
143 | Définit le nom du répertoire de calcul. |
145 | - ``dir_name`` : le nom du répertoire de calcul |
146 +---------------------------------------------------------------+
147 | .. module:: GetDirName |
150 | Retourne le nom du répertoire de calcul. |
151 +---------------------------------------------------------------+
152 | .. module:: SetMeshFile |
154 | **SetMeshFile(mesh_file)** |
155 | Définit le fichier MED du tout premier maillage. |
157 | - ``mesh_file`` : le nom du fichier MED contenant le tout |
158 | premier maillage de calcul |
159 +---------------------------------------------------------------+
160 | .. module:: GetMeshFile |
162 | **GetMeshFile()** |
163 | Retourne le nom du fichier MED du tout premier maillage |
165 +---------------------------------------------------------------+
166 | .. module:: SetXMLFile |
168 | **SetXMLFile(xml_file)** |
169 | Définit le fichier xml pour l'écriture. |
171 | - ``xml_file`` : le nom du fichier xml |
172 +---------------------------------------------------------------+
173 | .. module:: GetXMLFile |
176 | Retourne le nom du fichier xml. |
177 +---------------------------------------------------------------+
180 Les options du schéma
181 =====================
182 Les valeurs par défaut sont définies dans les préférences du module HOMARD.
184 +---------------------------------------------------------------+
185 +---------------------------------------------------------------+
186 | .. module:: SetMaxIter |
188 | **SetMaxIter(MaxIter)** |
189 | Définit le nombre maximal d'itérations pour le schéma. |
191 | - ``MaxIter`` : le nombre maximal d'itérations du schéma |
192 +---------------------------------------------------------------+
193 | .. module:: GetMaxIter |
196 | Retourne le nombre maximal d'itérations du schéma. |
197 +---------------------------------------------------------------+
198 | .. module:: SetMaxNode |
200 | **SetMaxNode(MaxNode)** |
201 | Définit le nombre maximal de noeuds pour l'adaptation. |
203 | - ``MaxNode`` : le nombre maximal de noeuds pour |
204 | l'adaptation. Si MaxNode est nul, aucune limite n'est |
206 +---------------------------------------------------------------+
207 | .. module:: GetMaxNode |
210 | Retourne le nombre maximal de noeuds pour l'adaptation. |
211 +---------------------------------------------------------------+
212 | .. module:: SetMaxElem |
214 | **SetMaxElem(MaxElem)** |
215 | Définit le nombre maximal de mailles pour l'adaptation. |
217 | - ``MaxElem`` : le nombre maximal de mailles pour |
218 | l'adaptation. Si MaxElem est nul, aucune limite n'est |
220 +---------------------------------------------------------------+
221 | .. module:: GetMaxElem |
224 | Retourne le nombre maximal de mailles pour l'adaptation. |
225 +---------------------------------------------------------------+
226 | .. module:: SetTestConvergence |
228 | **SetTestConvergence(Type, VRef)** |
229 | Précise un test de convergence pour le schéma. |
231 | - ``Type`` : le type de convergence du schéma. |
234 | * 1 : quand la valeur de test est supérieure à VRef |
235 | * 2 : quand la valeur de test est inférieure à VRef |
237 | - ``VRef`` : la valeur de référence du test |
238 +---------------------------------------------------------------+
239 | .. module:: GetTestConvergenceType |
241 | **GetTestConvergenceType()** |
242 | Retourne le type de convergence du schéma. |
243 +---------------------------------------------------------------+
244 | .. module:: GetTestConvergenceVRef |
246 | **GetTestConvergenceVRef()** |
247 | Retourne la valeur de référence utilisée pour le test de |
248 | convergence du schéma. |
249 +---------------------------------------------------------------+
254 La création d'un schéma se fait ainsi :
257 ScriptFile = "/scratch/D68518/Salome/HOMARD_SALOME/HOMARD_SRC/doc/files/ScriptAster.py"
258 DirName = "/scratch/D68518/calcul"
259 MeshFile = "/scratch/D68518/calcul/maill.00.med"
260 YACS_0 = Case.CreateYACSSchema("YACS_0", ScriptFile, DirName, MeshFile)
263 On peut ensuite l'écrire dans un fichier :
266 YACSFile = "/scratch/D68518/calcul/yacs.xml"
267 codret = YACS_0.WriteOnFile(YACSFile)
269 Saisie graphique correspondante
270 *******************************
271 Consulter :doc:`gui_create_yacs`