Salome HOME
Documentation sur les schémas YACS
[modules/homard.git] / doc / fr / gui_create_yacs.rst
1 .. _gui_create_yacs:
2
3 Le schéma YACS
4 ##############
5 .. index:: single: YACS
6 .. index:: single: cas
7
8 L'objet YACS contient toutes les définitions permettant de créer un schéma. Ce schéma va piloter l'alternance d'un calcul représentant une modélisation physique sur un maillage et l'adaptation de ce maillage de calcul. Cette alternance est piloté par des critères de convergence.
9
10 .. note::
11   Pour avoir une description détaillée de chacune des rubriques formant le schéma, consulter :ref:`yacs`
12
13 Procédure à employer
14 ********************
15 La création automatique du schéma va se faire en trois phases :
16
17 - 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.
18 - 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`.
19 - Enfin, de ce cas, on va créer le schéma qui se basera sur l'hypothèse d'adapation définie.
20
21
22 .. image:: images/create_yacs_01.png
23    :align: center
24    :alt: yacs - création
25    :width: 551
26    :height: 295
27
28 Nom du schéma
29 *************
30 Un nom de schéma est proposé automatiquement : YACS_1, YACS_2, etc. Ce nom peut être modifié. Il ne doit pas avoir été déjà utilisé pour un autre schéma.
31
32 Le script
33 *********
34
35 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 :
36
37 - le nom de la classe qui gère le calcul est ``Script``
38 - le lancement du calcul se fait par la méthode ``Compute()``
39 - le résultat du calcul est sous la forme de trois variables : le code d'erreur, un message, un dictionnaire python.
40
41 S'ils sont nécessaires à la création de la classe, on peut passer des arguments sous la forme :
42
43 - ``--rep_calc=rep_calc``, où ``rep_calc`` est le répertoire de calcul
44 - ``--num=num``, où ``num`` est le numéro du calcul  : 0 pour le tout premier, puis 1, 2 etc.
45 - ``--mesh_file=meshfile``, où ``meshfile`` est le fichier contenant le maillage sur lequel calculer.
46 - ``-v``, pour des messages
47
48 Les arguments de retour :
49
50 - ``erreur`` : le code d'erreur, entier : 0 si le calcul est correct, non nul sinon
51 - ``message`` : un éventuel message d'information sur le calcul
52 - ``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.
53
54
55
56 Exemple d'usage du script :
57 ::
58
59     argu = ["--rep_calc=" + rep_calc)]
60     argu.append("--num=%d" % numCalc)
61     argu.append("--mesh_file="  + MeshFile)
62     Script_A = Script(argu)
63     erreur, message, dico_resu = Script_A.compute ()
64
65 .. note::
66
67   * Pour piloter Code_Aster : :download:`ScriptAster<../files/yacs_script.py>`
68
69 Le répertoire
70 *************
71 Le répertoire est celui qui contiend les fichiers produits par le calcul. Par défaut, rien n'est proposé. Le choix est fait, soit en tapant le nom dans la zone de texte, soit en activant la fonction de recherche.
72
73 Le maillage initial
74 *******************
75 Le maillage initial doit se trouver dans un fichier au format MED. C'est celui qui est le point de départ du tout premier calcul. Le nom du fichier peut être fourni, soit en tapant le nom dans la zone de texte, soit en activant la fonction de recherche.
76
77
78 Le type de schéma
79 *****************
80 Plusieurs types de schéma sont proposés : constant ou variable.
81
82 L'option par défaut, 'constant', alterne le lancement d'un calcul qui est toujours le même et une adaptation de maillage : d'un calcul à l'autre, la seule chose qui change est le maillage. Tout le reste est identique. Par exemple, dans le cas où le calcul modéliserait un transitoire, c'est toujours l'intégralité du transitoire qui est prise en compte.
83
84 L'option 'variable' est inactive aujourd'hui.
85
86 Méthodes python correspondantes
87 *******************************
88 Consulter :ref:`tui_create_yacs`