]> SALOME platform Git repositories - modules/homard.git/blobdiff - doc/en/gui_create_yacs_aster.rst
Salome HOME
Documentation sur les schémas YACS
[modules/homard.git] / doc / en / gui_create_yacs_aster.rst
diff --git a/doc/en/gui_create_yacs_aster.rst b/doc/en/gui_create_yacs_aster.rst
new file mode 100644 (file)
index 0000000..e947b8a
--- /dev/null
@@ -0,0 +1,61 @@
+.. _gui_create_yacs_aster:
+
+A schema YACS for Code_Aster
+############################
+.. index:: single: YACS
+.. index:: single: Code_Aster
+
+If the schema implies a coupling between Code_Aster and HOMARD, somme comments are included here.
+
+Préalable
+*********
+La création automatique du schema va se faire en trois phases :
+
+- Au départ, il faut avoir fait un calcul sur un tout premier maillage. Ce calcul aura produit des résultats dans un fichier MED.
+- Ensuite, on crée un cas dans le module HOMARD, tel qu'il est décrit dans :ref:`gui_create_case`. Dans ce cas, on crée une itération suivante du maillage en définissant une hypothèse d'adaptation ; voir :ref:`gui_create_iteration`.
+- Enfin, de ce cas, on va créer le schema qui se basera sur l'hypothèse d'adapation définie.
+
+
+.. image:: images/create_yacs_01.png
+   :align: center
+   :alt: yacs - création
+   :width: 551
+   :height: 295
+
+Le script
+*********
+
+Le fichier contenant le script qui permet de lancer le calcul lié à la modélisation physique est fourni ici. C'est un script python qui doit respecter les règles suivantes :
+
+- le nom de la classe qui gère le calcul est ``Script``
+- le lancement du calcul se fait par la méthode ``Compute()``
+- le résultat du calcul est sous la forme de trois variables : le code d'erreur, un message, un dictionnaire python.
+
+S'ils sont nécessaires à la création de la classe, on peut passer des arguments sous la forme :
+
+- ``--rep_calc=rep_calc``, où ``rep_calc`` est le répertoire de calcul
+- ``--num=num``, où ``num`` est le numéro du calcul  : 0 pour le tout premier, puis 1, 2 etc.
+- ``--mesh_file=meshfile``, où ``meshfile`` est le fichier contenant le maillage sur lequel calculer.
+- ``-v``, pour des messages
+
+Les arguments de retour :
+
+- ``erreur`` : le code d'erreur, entier : 0 si le calcul est correct, non nul sinon
+- ``message`` : un éventuel message d'information sur le calcul
+- ``dico_resu`` : un dictionnaire python qui comprend a minima les deux clés suivantes : ``FileName`` est la clé pour le nom du fichier MED qui contient les résultats du calcul, ``V_TEST`` est la clé pour la valeur réelle à tester.
+
+
+
+Exemple d'usage du script :
+::
+
+    argu = ["--rep_calc=" + rep_calc)]
+    argu.append("--num=%d" % numCalc)
+    argu.append("--mesh_file="  + MeshFile)
+    Script_A = Script(argu)
+    erreur, message, dico_resu = Script_A.compute ()
+
+.. note::
+
+  * Pour piloter Code_Aster : :download:`ScriptAster<../files/yacs_script.py>`
+