From: Gérald NICOLAS Date: Mon, 14 Dec 2015 15:03:28 +0000 (+0100) Subject: Remplacement de ref par doc dans les hyperliens X-Git-Tag: V8_0_0a1~5^2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f49cb7be43bb382b2c5aa9c6d0e1e1b92f04ba95;p=modules%2Fhomard.git Remplacement de ref par doc dans les hyperliens --- diff --git a/doc/en/demarrage_rapide.rst b/doc/en/demarrage_rapide.rst index f272e23a..3fed844e 100644 --- a/doc/en/demarrage_rapide.rst +++ b/doc/en/demarrage_rapide.rst @@ -5,7 +5,7 @@ Quick start .. index:: single: start .. index:: single: example -The options to drive HOMARD in SALOME are described into :ref:`gui_usage`. Here are the basic instructions to discover how to use HOMARD from a very simple example. +The options to drive HOMARD in SALOME are described into :doc:`gui_usage`. Here are the basic instructions to discover how to use HOMARD from a very simple example. Let's imagine that a calculation of a thermal problem has been done with a given mesh. An output MED file was produced; it contains the mesh and the field of the temperatures over the nodes. We'd like to adapt the mesh to decrease the variation of the temperature from one node to another below a threshold. diff --git a/doc/en/gui_create_boundary.rst b/doc/en/gui_create_boundary.rst index e257241b..3cea8288 100644 --- a/doc/en/gui_create_boundary.rst +++ b/doc/en/gui_create_boundary.rst @@ -136,7 +136,7 @@ At the end of this creation of boundaries, the object browser was enriched. We f Corresponding python functions ****************************** -Look :ref:`tui_create_boundary` +Look :doc:`tui_create_boundary` diff --git a/doc/en/gui_create_case.rst b/doc/en/gui_create_case.rst index 68eed8ba..4dbd1ea5 100644 --- a/doc/en/gui_create_case.rst +++ b/doc/en/gui_create_case.rst @@ -79,7 +79,7 @@ Check the button: .. image:: images/create_case_5.png :align: center -The definition of the boundaries is described in :ref:`gui_create_boundary`. +The definition of the boundaries is described in :doc:`gui_create_boundary`. .. index:: single: pyramid @@ -150,5 +150,5 @@ At the end of the creation, the case is included into the object browser. The in Corresponding python functions ****************************** -Look :ref:`tui_create_case` +Look :doc:`tui_create_case` diff --git a/doc/en/gui_create_hypothese.rst b/doc/en/gui_create_hypothese.rst index 1a1eb28c..1bbf8df3 100644 --- a/doc/en/gui_create_hypothese.rst +++ b/doc/en/gui_create_hypothese.rst @@ -28,7 +28,7 @@ Adaptation by a field ********************* .. note:: - To be able to adapt the mesh according to a field it is beforehand necessary to have indicated the file med containing the field. It is made in the window of construction of the iteration (see :ref:`gui_create_iteration`). The name of the file which was selected is shown without possible modification here: + To be able to adapt the mesh according to a field it is beforehand necessary to have indicated the file med containing the field. It is made in the window of construction of the iteration (see :doc:`gui_create_iteration`). The name of the file which was selected is shown without possible modification here: .. image:: images/create_hypothese_ch_1.png :align: center @@ -61,7 +61,7 @@ Adaptation by a zone ******************** .. index:: single: zone -In the starting up, it is necessary to create a first zone by activation of the button "*New*" (see :ref:`gui_create_zone`) : +In the starting up, it is necessary to create a first zone by activation of the button "*New*" (see :doc:`gui_create_zone`) : .. image:: images/create_hypothese_zo_1.png :align: center @@ -93,7 +93,7 @@ Interpolation of fields .. index:: single: interpolation .. note:: - To be able to interpolate a field from the former towards the new mesh, it is beforehand necessary to have indicated the file med containing the field. It is made in the window of construction of the iteration (see :ref:`gui_create_iteration`). + To be able to interpolate a field from the former towards the new mesh, it is beforehand necessary to have indicated the file med containing the field. It is made in the window of construction of the iteration (see :doc:`gui_create_iteration`). By default, no field is interpolated. On the contrary, we can ask for the interpolation of all the present fields in the supplied file: @@ -133,4 +133,4 @@ The object browser contains the created hypotheses and the iterations which use Corresponding python functions ****************************** -Look :ref:`tui_create_hypothese` +Look :doc:`tui_create_hypothese` diff --git a/doc/en/gui_create_iteration.rst b/doc/en/gui_create_iteration.rst index 7826750f..3dc07084 100644 --- a/doc/en/gui_create_iteration.rst +++ b/doc/en/gui_create_iteration.rst @@ -49,7 +49,7 @@ The hypothesis ************** The iteration in progress will control the adaptation by HOMARD according to a scenario defined on an hypothesis. This one is selected in the list of the existing hypotheses. -With starting, it is necessary to create a first hypothesis by activation of the button "*New*" (see: :ref:`gui_create_hypothese`) : +With starting, it is necessary to create a first hypothesis by activation of the button "*New*" (see: :doc:`gui_create_hypothese`) : .. image:: images/create_iteration_4.png :align: center @@ -78,4 +78,4 @@ When several iterations are connected, their hypothesis is visible in the object Corresponding python functions ****************************** -Look :ref:`tui_create_iteration` +Look :doc:`tui_create_iteration` diff --git a/doc/en/gui_create_yacs.rst b/doc/en/gui_create_yacs.rst index f581163b..0a846c58 100644 --- a/doc/en/gui_create_yacs.rst +++ b/doc/en/gui_create_yacs.rst @@ -8,14 +8,14 @@ The schema YACS The object YACS contains every definition that allows the creation of a schema. This schema will drive the alternation of the computation of a physical modelization over a mesh and the adaptation of the mesh for the computation. This alternation is driven by some criteria for the convergence. .. note:: - To read an exhaustive description of any part of the schema, see :ref:`yacs` + To read an exhaustive description of any part of the schema, see :doc:`yacs` Procedure ********* The automatic creation of the schema is going to be made in three phases. - At first, it is necessary to have done a calculation on the very first mesh. This calculation will have produced the results in a MED file. -- Then, a case is created in the module HOMARD, as described in :ref:`gui_create_case`. In this case, we create the following iteration of the mesh by defining a hypothesis of adaptation ; see :ref:`gui_create_iteration`. +- Then, a case is created in the module HOMARD, as described in :doc:`gui_create_case`. In this case, we create the following iteration of the mesh by defining a hypothesis of adaptation ; see :doc:`gui_create_iteration`. - Last, from this case, a schema will be created, based on the hypothesis for the adaptation. @@ -92,7 +92,7 @@ The object browser contains the created schemas, identified by their names. They Corresponding python functions ****************************** -Look :ref:`tui_create_yacs` +Look :doc:`tui_create_yacs` How to use the schema ##################### @@ -104,7 +104,7 @@ The schema that is produced by this procedure can be imported into the module YA By default, the maximal number of iterations is equal to 5 and the test for the convergence is satisfied if the variable varies less than one per a thousand in a relative value, between two successive iterations. These tests can be modified. -These tests ares done into the node "Analyse" of the schema, as described in :ref:`yacs`. +These tests ares done into the node "Analyse" of the schema, as described in :doc:`yacs`. The maximal number of iterations is given by the variable `NbCalcMax`: @@ -130,7 +130,7 @@ Examples ######## .. index:: single: Code_Aster -A user's guide for schemas with *Code_Aster* is available here: :ref:`gui_create_yacs_aster`. +A user's guide for schemas with *Code_Aster* is available here: :doc:`gui_create_yacs_aster`. diff --git a/doc/en/gui_create_zone.rst b/doc/en/gui_create_zone.rst index 6c5af27f..fbb6282e 100644 --- a/doc/en/gui_create_zone.rst +++ b/doc/en/gui_create_zone.rst @@ -95,4 +95,4 @@ The disk with hole is necessarily in the plan of coordinate system. It is define Corresponding python functions ****************************** -Look :ref:`tui_create_zone` +Look :doc:`tui_create_zone` diff --git a/doc/en/gui_homard.rst b/doc/en/gui_homard.rst index 3ce94f0f..6a6b6bde 100644 --- a/doc/en/gui_homard.rst +++ b/doc/en/gui_homard.rst @@ -47,5 +47,5 @@ Both text files, Liste.n.vers.(n+1).log and apad.n.vers.(n+1).bilan, are visible Corresponding python functions ****************************** -Look :ref:`tui_create_iteration` +Look :doc:`tui_create_iteration` diff --git a/doc/en/gui_mesh_info.rst b/doc/en/gui_mesh_info.rst index cb3127df..f0118944 100644 --- a/doc/en/gui_mesh_info.rst +++ b/doc/en/gui_mesh_info.rst @@ -88,5 +88,5 @@ As for an imported mesh, the object browser was enriched with both files of info Corresponding python functions ****************************** -Look :ref:`tui_create_case` and :ref:`tui_create_iteration` +Look :doc:`tui_create_case` and :doc:`tui_create_iteration` diff --git a/doc/en/gui_usage.rst b/doc/en/gui_usage.rst index b8accc91..757189f8 100644 --- a/doc/en/gui_usage.rst +++ b/doc/en/gui_usage.rst @@ -20,7 +20,7 @@ The user can choose either to start a new study or to open an old stored one, as Definition of an adaptation *************************** -Once the activation of the module HOMARD is done, a case is created. The initial mesh of the series of adapted meshes is selected (see :ref:`gui_create_case`). From this case, the successive iterations are defined (see :ref:`gui_create_iteration`) with hypotheses (see :ref:`gui_create_hypothese`). The adaptations are launched as described in :ref:`gui_homard`. +Once the activation of the module HOMARD is done, a case is created. The initial mesh of the series of adapted meshes is selected (see :doc:`gui_create_case`). From this case, the successive iterations are defined (see :doc:`gui_create_iteration`) with hypotheses (see :doc:`gui_create_hypothese`). The adaptations are launched as described in :doc:`gui_homard`. User's guide of the graphical interface diff --git a/doc/en/intro.rst b/doc/en/intro.rst index 618b1037..260e7928 100644 --- a/doc/en/intro.rst +++ b/doc/en/intro.rst @@ -56,7 +56,7 @@ Some variations may exist. If no error indicator is available, another field can .. index:: single: YACS .. note:: - This alternation (computation/adaptation) suits in the :ref:`yacs` schemes. + This alternation (computation/adaptation) suits in the :doc:`yacs` schemes. Methods for splitting the elements diff --git a/doc/en/tui_create_boundary.rst b/doc/en/tui_create_boundary.rst index b6efe599..1a33efc0 100644 --- a/doc/en/tui_create_boundary.rst +++ b/doc/en/tui_create_boundary.rst @@ -7,7 +7,7 @@ The boundary .. index:: single: cylinder .. index:: single: sphere -The variables are described in :ref:`gui_create_boundary`. +The variables are described in :doc:`gui_create_boundary`. Methods of the class homard *************************** @@ -101,7 +101,7 @@ These methods returns an instance of the class boundary. Methods of the class cas ************************ -See also in :ref:`tui_create_case`. +See also in :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -179,4 +179,4 @@ Creation of a discrete boundary, a spherical boundary, and a cylindrical boundar Similar graphical input *********************** -Look at :ref:`gui_create_boundary` +Look at :doc:`gui_create_boundary` diff --git a/doc/en/tui_create_hypothese.rst b/doc/en/tui_create_hypothese.rst index d0d6e2bc..2d90df06 100644 --- a/doc/en/tui_create_hypothese.rst +++ b/doc/en/tui_create_hypothese.rst @@ -7,7 +7,7 @@ The hypothesis .. index:: single: hypothesis .. index:: single: zone -The variables are described in :ref:`gui_create_hypothese`. +The variables are described in :doc:`gui_create_hypothese`. Methods of the class homard *************************** @@ -360,7 +360,7 @@ Interpolation of fields +---------------------------------------------------------------+ .. note:: - The file and the time steps for the fiels are defined with the iteration; see :ref:`tui_create_iteration`. + The file and the time steps for the fiels are defined with the iteration; see :doc:`tui_create_iteration`. Advanced options ================ @@ -447,7 +447,7 @@ The creation of the object hypo_1 is done as follows: Similar graphical input *********************** -Look at :ref:`gui_create_hypothese` +Look at :doc:`gui_create_hypothese` .. warning:: With the graphical input mode, if an hypothesis is edited and if one of the characteristic is modified, the value of the threshold for the refinement for example, all the iterations that were computed with this hypothesis are unvalidated. In python mode, that is not true: the iterations stay as they are. diff --git a/doc/en/tui_create_iteration.rst b/doc/en/tui_create_iteration.rst index c424f047..8309374a 100644 --- a/doc/en/tui_create_iteration.rst +++ b/doc/en/tui_create_iteration.rst @@ -7,7 +7,7 @@ The iteration .. index:: single: hypothesis .. index:: single: zone -The variables are described in :ref:`gui_create_iteration`. +The variables are described in :doc:`gui_create_iteration`. Methods of the class homard *************************** @@ -32,7 +32,7 @@ Methods of the class homard Methods of both classes cas and iteration ****************************************" -See also in :ref:`tui_create_case`. +See also in :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -287,7 +287,7 @@ If no time step is defined for the field or if a single time step is defined for The time steps for the fields to interpolate -------------------------------------------- -The choice of the fields to interpolated are defined in the hypothesis (see :ref:`tui_create_hypothese`). +The choice of the fields to interpolated are defined in the hypothesis (see :doc:`tui_create_hypothese`). For a given field, if nothing is declared, every single time step will be considered. If some time steps are wanted, they must be defined as follows. @@ -381,4 +381,4 @@ Then, the next iteration is created from the current iteration. Similar graphical input *********************** -Look at :ref:`gui_create_iteration` +Look at :doc:`gui_create_iteration` diff --git a/doc/en/tui_create_yacs.rst b/doc/en/tui_create_yacs.rst index 12c730b1..75b28d44 100644 --- a/doc/en/tui_create_yacs.rst +++ b/doc/en/tui_create_yacs.rst @@ -5,11 +5,11 @@ The schema YACS .. index:: single: YACS -The variables are described in :ref:`gui_create_yacs`. +The variables are described in :doc:`gui_create_yacs`. Méthodes de la classe cas ************************* -See also in :ref:`tui_create_case`. +See also in :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -269,7 +269,7 @@ It can be writen down in a file : Similar graphical input *********************** -Look at :ref:`gui_create_yacs` +Look at :doc:`gui_create_yacs` diff --git a/doc/en/tui_create_zone.rst b/doc/en/tui_create_zone.rst index 0746ab72..2a17986b 100644 --- a/doc/en/tui_create_zone.rst +++ b/doc/en/tui_create_zone.rst @@ -12,7 +12,7 @@ The zone .. index:: single: disk with a hole .. index:: single: 2D -The variables are described in :ref:`gui_create_zone`. +The variables are described in :doc:`gui_create_zone`. Methods of the class homard *************************** @@ -198,7 +198,7 @@ The creation of a disk in the plane XY is done as follows: Similar graphical input *********************** -Look at :ref:`gui_create_zone` +Look at :doc:`gui_create_zone` .. warning:: With the graphical input mode, if a zone is edited and if one of the dimensions is modified, all the iterations that were computed with this zone are unvalidated. In python mode, that is not true: the iterations stay as they are. diff --git a/doc/en/tui_homard.rst b/doc/en/tui_homard.rst index b8aab2ad..2665750c 100644 --- a/doc/en/tui_homard.rst +++ b/doc/en/tui_homard.rst @@ -32,4 +32,4 @@ Example Corresponding graphical interface ********************************* -Look at :ref:`gui_homard` +Look at :doc:`gui_homard` diff --git a/doc/en/yacs.rst b/doc/en/yacs.rst index 7d4db2ba..4815352d 100644 --- a/doc/en/yacs.rst +++ b/doc/en/yacs.rst @@ -4,12 +4,12 @@ YACS #### .. index:: single: YACS -Using a YACS scheme allows the coupling between a computation and an adaptation as described into :ref:`intro`. This coupling can be repeated inside a loop as long as a criteria for the convergence is reached for instance. Many ways are available to program a YACS scheme. The solution that is shown here is correct but many others are too! +Using a YACS scheme allows the coupling between a computation and an adaptation as described into :doc:`intro`. This coupling can be repeated inside a loop as long as a criteria for the convergence is reached for instance. Many ways are available to program a YACS scheme. The solution that is shown here is correct but many others are too! In this part, an extensive description of a schema YACS is available. .. note:: - The module HOMARD proposes an automatic creation of a schema YASC starting from a defined case. To do that, see :ref:`gui_create_yacs` + The module HOMARD proposes an automatic creation of a schema YASC starting from a defined case. To do that, see :doc:`gui_create_yacs` Introduction ************ @@ -167,7 +167,7 @@ The name of the case CaseName is imposed on "Calcul". The name of the case MeshN .. literalinclude:: ../files/yacs_01.en.xml :lines: 483-486 -The options of this case must be now given. It is made by the node python CaseOptions. It is imperative to give the directory of calculation. We shall look at the description of the functions in :ref:`tui_create_case`. In output, we get back the instance of the iteration corresponding to the initial state of the case. +The options of this case must be now given. It is made by the node python CaseOptions. It is imperative to give the directory of calculation. We shall look at the description of the functions in :doc:`tui_create_case`. In output, we get back the instance of the iteration corresponding to the initial state of the case. .. literalinclude:: ../files/yacs_01.en.xml :lines: 216-228 @@ -194,7 +194,7 @@ The directory of calculation is recovered. The name of the mesh is given. .. literalinclude:: ../files/yacs_01.en.xml :lines: 325-333 -The hypothesis transmitted in input parameter characterized (look :ref:`tui_create_hypothese`) : +The hypothesis transmitted in input parameter characterized (look :doc:`tui_create_hypothese`) : .. literalinclude:: ../files/yacs_01.en.xml :lines: 254-278 @@ -204,7 +204,7 @@ It is necessary to establish a name for the future iteration. To make sure that .. literalinclude:: ../files/yacs_01.en.xml :lines: 280-290 -The iteration is supplemented : hypothesis, future mesh, field (look :ref:`tui_create_iteration`) : +The iteration is supplemented : hypothesis, future mesh, field (look :doc:`tui_create_iteration`) : .. literalinclude:: ../files/yacs_01.en.xml :lines: 292-311 @@ -226,8 +226,8 @@ Iter_n For the following passing in the block of adaptation, it is necessary to recover: -- the last created iteration: service LastIteration (look :ref:`tui_create_iteration`) -- the created hypothesis: service GetHypothesis (look :ref:`tui_create_hypothese`) +- the last created iteration: service LastIteration (look :doc:`tui_create_iteration`) +- the created hypothesis: service GetHypothesis (look :doc:`tui_create_hypothese`) One passes then in the Homard_Exec node to calculate the new mesh. diff --git a/doc/fr/demarrage_rapide.rst b/doc/fr/demarrage_rapide.rst index 3eef5b96..941a4f55 100644 --- a/doc/fr/demarrage_rapide.rst +++ b/doc/fr/demarrage_rapide.rst @@ -5,7 +5,7 @@ Démarrage rapide .. index:: single: démarrage .. index:: single: exemple -L'ensemble des options de pilotage du module HOMARD dans SALOME est décrit dans le :ref:`gui_usage`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. +L'ensemble des options de pilotage du module HOMARD dans SALOME est décrit dans le :doc:`gui_usage`. Mais on trouvera ici le B.A. BA pour découvrir l'utilisation de HOMARD à partir d'un exemple simple. Imaginons que l'on a effectué un calcul de thermique sur un maillage donné. On a récupéré en sortie de ce calcul un fichier au format MED, contenant le maillage et le champ des températures aux noeuds. On aimerait adapter le maillage de telle sorte que l'écart de température entre deux noeuds voisins soit inférieur à une valeur donnée. diff --git a/doc/fr/gui_create_boundary.rst b/doc/fr/gui_create_boundary.rst index c1848767..67def0fd 100644 --- a/doc/fr/gui_create_boundary.rst +++ b/doc/fr/gui_create_boundary.rst @@ -137,7 +137,7 @@ A l'issue de cette création de frontières, l'arbre d'études a été enrichi. Méthodes python correspondantes ******************************* -Consulter : :ref:`tui_create_boundary` +Consulter : :doc:`tui_create_boundary` diff --git a/doc/fr/gui_create_case.rst b/doc/fr/gui_create_case.rst index 9a4e600f..d8c3c7d1 100644 --- a/doc/fr/gui_create_case.rst +++ b/doc/fr/gui_create_case.rst @@ -76,7 +76,7 @@ On cochera le ou les boutons voulus : .. image:: images/create_case_5.png :align: center -La définition des frontières est décrite dans :ref:`gui_create_boundary`. +La définition des frontières est décrite dans :doc:`gui_create_boundary`. .. index:: single: pyramide @@ -151,5 +151,5 @@ A l'issue de cette création de cas, l'arbre d'études a été enrichi de ce nou Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_case` +Consulter :doc:`tui_create_case` diff --git a/doc/fr/gui_create_hypothese.rst b/doc/fr/gui_create_hypothese.rst index 6af2910f..2cf4d3b2 100644 --- a/doc/fr/gui_create_hypothese.rst +++ b/doc/fr/gui_create_hypothese.rst @@ -28,7 +28,7 @@ Adaptation selon un champ ************************* .. note:: - Pour pouvoir adapter le maillage selon un champ il faut avoir au préalable désigné le fichier med contenant le champ. Cela se fait dans la fenêtre de construction de l'itération (voir :ref:`gui_create_iteration`). Le nom du fichier qui a été sélectionné est affiché sans modification possible ici : + Pour pouvoir adapter le maillage selon un champ il faut avoir au préalable désigné le fichier med contenant le champ. Cela se fait dans la fenêtre de construction de l'itération (voir :doc:`gui_create_iteration`). Le nom du fichier qui a été sélectionné est affiché sans modification possible ici : .. image:: images/create_hypothese_ch_1.png :align: center @@ -62,7 +62,7 @@ Adaptation selon une zone ************************* .. index:: single: zone -Au démarrage, il faut créer une première zone par activation du bouton "*Nouveau*" (voir :ref:`gui_create_zone`) : +Au démarrage, il faut créer une première zone par activation du bouton "*Nouveau*" (voir :doc:`gui_create_zone`) : .. image:: images/create_hypothese_zo_1.png :align: center @@ -94,7 +94,7 @@ Interpolation de champs .. index:: single: interpolation .. note:: - Pour pouvoir interpoler un champ de l'ancien vers le nouveau maillage, il faut avoir au préalable désigné le fichier med contenant le champ. Cela se fait dans la fenêtre de construction de l'itération (voir :ref:`gui_create_iteration`). + Pour pouvoir interpoler un champ de l'ancien vers le nouveau maillage, il faut avoir au préalable désigné le fichier med contenant le champ. Cela se fait dans la fenêtre de construction de l'itération (voir :doc:`gui_create_iteration`). Par défaut, aucun champ n'est interpolé. A contrario, on peut demander l'interpolation de tous les champs présents dans le fichier fourni : @@ -134,4 +134,4 @@ L'arbre d'études contient les hypothèses créées et les itérations qui les u Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_hypothese` +Consulter :doc:`tui_create_hypothese` diff --git a/doc/fr/gui_create_iteration.rst b/doc/fr/gui_create_iteration.rst index 83c62856..e7d2c148 100644 --- a/doc/fr/gui_create_iteration.rst +++ b/doc/fr/gui_create_iteration.rst @@ -50,7 +50,7 @@ L'hypothèse utilisée ******************** L'itération en cours pilotera l'adaptation par HOMARD selon un scénario défini dans une hypothèse. Celle-ci est choisie dans la liste des hypothèses existantes. -Au démarrage, il faut créer une première hypothèse par activation du bouton "*Nouveau*" (voir :ref:`gui_create_hypothese`) : +Au démarrage, il faut créer une première hypothèse par activation du bouton "*Nouveau*" (voir :doc:`gui_create_hypothese`) : .. image:: images/create_iteration_4.png :align: center @@ -79,4 +79,4 @@ Quand plusieurs itérations s'enchaînent, leur hypothèse est visible dans l'ar Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_iteration` +Consulter :doc:`tui_create_iteration` diff --git a/doc/fr/gui_create_yacs.rst b/doc/fr/gui_create_yacs.rst index 67e1a796..d16ea88d 100644 --- a/doc/fr/gui_create_yacs.rst +++ b/doc/fr/gui_create_yacs.rst @@ -8,14 +8,14 @@ Le schéma YACS 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. .. note:: - Pour avoir une description détaillée de chacune des rubriques formant le schéma, consulter :ref:`yacs` + Pour avoir une description détaillée de chacune des rubriques formant le schéma, consulter :doc:`yacs` Procédure à employer ******************** La création automatique du schéma 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`. +- Ensuite, on crée un cas dans le module HOMARD, tel qu'il est décrit dans :doc:`gui_create_case`. Dans ce cas, on crée une itération suivante du maillage en définissant une hypothèse d'adaptation ; voir :doc:`gui_create_iteration`. - Enfin, de ce cas, on va créer le schéma qui se basera sur l'hypothèse d'adapation définie. @@ -93,7 +93,7 @@ A l'issue de cette création de schéma, l'arbre d'études a été enrichi. On y Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_yacs` +Consulter :doc:`tui_create_yacs` Utilisation du schéma ##################### @@ -105,7 +105,7 @@ Le schéma produit par cette saisie est directement importable dans le module YA Par défaut le nombre maximal d'itérations est fixé à 5 et le test de convergence est satisfait si la variable bouge de moins de 1 pour mille en valeur relative entre deux itérations successives. On peut évidemment modifier ces tests. -Ces tests sont réalisés dans le noeud python "Analyse" du schéma, comme décrit dans :ref:`yacs`. +Ces tests sont réalisés dans le noeud python "Analyse" du schéma, comme décrit dans :doc:`yacs`. Le nombre maximal d'itérations est modifiable par la variable `NbCalcMax` : @@ -131,7 +131,7 @@ Exemples ######## .. index:: single: Code_Aster -Un mode d'emploi associé à la création de schéma avec *Code_Aster* est disponible en consultant : :ref:`gui_create_yacs_aster`. +Un mode d'emploi associé à la création de schéma avec *Code_Aster* est disponible en consultant : :doc:`gui_create_yacs_aster`. diff --git a/doc/fr/gui_create_zone.rst b/doc/fr/gui_create_zone.rst index cc2381fa..eebf7052 100644 --- a/doc/fr/gui_create_zone.rst +++ b/doc/fr/gui_create_zone.rst @@ -108,4 +108,4 @@ A l'issue de cette création de zone, l'arbre d'études a été enrichi. On y tr Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_zone` +Consulter :doc:`tui_create_zone` diff --git a/doc/fr/gui_homard.rst b/doc/fr/gui_homard.rst index b7afb223..81705788 100644 --- a/doc/fr/gui_homard.rst +++ b/doc/fr/gui_homard.rst @@ -47,5 +47,5 @@ Les deux fichiers de texte, Liste.n.vers.(n+1).log et apad.n.vers.(n+1).bilan, s Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_iteration` +Consulter :doc:`tui_create_iteration` diff --git a/doc/fr/gui_mesh_info.rst b/doc/fr/gui_mesh_info.rst index 020e7438..de18a17b 100644 --- a/doc/fr/gui_mesh_info.rst +++ b/doc/fr/gui_mesh_info.rst @@ -88,5 +88,5 @@ Comme pour un maillage importé, l'arbre d'études a été enrichi avec les deux Méthodes python correspondantes ******************************* -Consulter :ref:`tui_create_case` et :ref:`tui_create_iteration` +Consulter :doc:`tui_create_case` et :doc:`tui_create_iteration` diff --git a/doc/fr/gui_usage.rst b/doc/fr/gui_usage.rst index 6820f39f..c4c2a50b 100644 --- a/doc/fr/gui_usage.rst +++ b/doc/fr/gui_usage.rst @@ -20,7 +20,7 @@ L'utilisateur a alors le choix entre créer une nouvelle étude ou en ouvrir une Définir une adaptation ********************** -Une fois que HOMARD a été activé, la permière action consiste à créer un cas. Il s'agit de sélectionner le maillage initial de la suite d'adaptations envisagée (voir :ref:`gui_create_case`). A partir de ce cas, on définira les itérations successives (voir :ref:`gui_create_iteration`) à partir des hypothèses (voir :ref:`gui_create_hypothese`). Les adaptations sont lancées tel que décrit dans :ref:`gui_homard`. +Une fois que HOMARD a été activé, la permière action consiste à créer un cas. Il s'agit de sélectionner le maillage initial de la suite d'adaptations envisagée (voir :doc:`gui_create_case`). A partir de ce cas, on définira les itérations successives (voir :doc:`gui_create_iteration`) à partir des hypothèses (voir :doc:`gui_create_hypothese`). Les adaptations sont lancées tel que décrit dans :doc:`gui_homard`. Mode d'emploi de la saisie des données diff --git a/doc/fr/intro.rst b/doc/fr/intro.rst index 745dd554..ef941bce 100644 --- a/doc/fr/intro.rst +++ b/doc/fr/intro.rst @@ -21,7 +21,7 @@ HOMARD sait traiter des maillages en 2 ou 3 dimensions et comportant les mailles Ces mailles peuvent être présentes simultanément. Par exemple, HOMARD saura adapter un maillage comportant des triangles et des quadrangles. Les noeuds acceptés sont évidemment les noeuds qui sont les sommets des mailles, ce qui correspond à la description classique « en degré 1 » . Si les éléments sont décrits « en degré 2 », les noeuds complémentaires sont gérés. En revanche, il ne peut pas y avoir cohabitation de mailles décrites en degré 1 et d'autres décrites en degré 2. Enfin, HOMARD sait prendre en compte des noeuds isolés, qui n'appartiendraient à aucune définition de mailles : ils ressortiront tels quels du processus d'adaptation. -Le cas des pyramides est à part. Pour un maillage comportant des hexaèdres ou des prismes, la mise en conformité du maillage issu du raffinement crée des pyramides pour assurer la liaison entre deux régions de niveaux de raffinement différents. Ces pyramides sont gérées comme toutes les mailles de transition et ne sont pas redécoupées par la suite. En revanche, si le maillage initial contient des pyramides, HOMARD ne saura pas l'adapter et émettra un message d'erreur. Dans certains cas particuliers, on pourra néanmoins traiter un tel maillage, comme il est décrit dans la rubrique :ref:`options_avancees` de la création du cas. +Le cas des pyramides est à part. Pour un maillage comportant des hexaèdres ou des prismes, la mise en conformité du maillage issu du raffinement crée des pyramides pour assurer la liaison entre deux régions de niveaux de raffinement différents. Ces pyramides sont gérées comme toutes les mailles de transition et ne sont pas redécoupées par la suite. En revanche, si le maillage initial contient des pyramides, HOMARD ne saura pas l'adapter et émettra un message d'erreur. Dans certains cas particuliers, on pourra néanmoins traiter un tel maillage, comme il est décrit dans la rubrique :doc:`options_avancees` de la création du cas. Plusieurs motivations apparaissent pour adapter un maillage : @@ -56,7 +56,7 @@ Des variantes de ce schéma de base sont possibles. Si aucun calcul d'erreur n'e .. index:: single: YACS .. note:: - Cet alternance de calculs et d'adaptions est très appropriée à la mise place de schémas :ref:`yacs`. + Cet alternance de calculs et d'adaptions est très appropriée à la mise place de schémas :doc:`yacs`. Mode de découpage des mailles ***************************** diff --git a/doc/fr/tui_create_boundary.rst b/doc/fr/tui_create_boundary.rst index fcdb8241..6b963767 100644 --- a/doc/fr/tui_create_boundary.rst +++ b/doc/fr/tui_create_boundary.rst @@ -8,7 +8,7 @@ La frontière .. index:: single: cylindre .. index:: single: sphere -Les variables sont décrites dans :ref:`gui_create_boundary`. +Les variables sont décrites dans :doc:`gui_create_boundary`. Méthodes de la classe homard **************************** @@ -102,7 +102,7 @@ Ces méthodes retournent une instance de la classe boundary. Méthodes de la classe cas ************************* -Voir également dans :ref:`tui_create_case`. +Voir également dans :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -180,4 +180,4 @@ Création d'une frontière discrète, d'une frontière sphèrique, puis d'une fr Saisie graphique correspondante ******************************* -Consulter :ref:`gui_create_boundary` +Consulter :doc:`gui_create_boundary` diff --git a/doc/fr/tui_create_case.rst b/doc/fr/tui_create_case.rst index 734646c9..0c9d3141 100644 --- a/doc/fr/tui_create_case.rst +++ b/doc/fr/tui_create_case.rst @@ -6,7 +6,7 @@ Le cas .. index:: single: type de conformité .. index:: single: maillage;initial -Les variables sont décrites dans :ref:`gui_create_case`. +Les variables sont décrites dans :doc:`gui_create_case`. Méthodes de la classe homard **************************** @@ -121,10 +121,12 @@ Méthodes de la classe cas | | | - ``conf_type`` : entier précisant le mode de conformité | | | -| * 1 : conforme | -| * 2 : non conforme avec 1 noeud par maille | -| * 3 : non conforme avec 1 noeud par arete de maille | -| * 4 : non conforme quelconque | +| * 0 : conforme | +| * 1 : non conforme avec au minimum 2 aretes coupees | +| * 2 : non conforme avec 1 noeud par arete de maille | +| * 3 : non conforme quelconque | +| * -1 : conforme avec des boites (pas d'escalier) | +| * -2 : non-conforme avec des boites (pas d'escalier) | +---------------------------------------------------------------+ | .. module:: GetConfType | | | @@ -262,6 +264,6 @@ La création de l'objet case_1 se fait ainsi : :: Saisie graphique correspondante ******************************* -Consulter :ref:`gui_create_case` +Consulter :doc:`gui_create_case` diff --git a/doc/fr/tui_create_hypothese.rst b/doc/fr/tui_create_hypothese.rst index 1af58314..d8be91de 100644 --- a/doc/fr/tui_create_hypothese.rst +++ b/doc/fr/tui_create_hypothese.rst @@ -7,7 +7,7 @@ L'hypothèse .. index:: single: hypothèse .. index:: single: zone -Les variables sont décrites dans :ref:`gui_create_hypothese`. +Les variables sont décrites dans :doc:`gui_create_hypothese`. Méthodes de la classe homard **************************** @@ -364,7 +364,7 @@ Les champs à interpoler +---------------------------------------------------------------+ .. note:: - Le fichier et les instants où sont pris les champs sont définis dans l'itération ; voir :ref:`tui_create_iteration`. + Le fichier et les instants où sont pris les champs sont définis dans l'itération ; voir :doc:`tui_create_iteration`. Les options avancées ==================== @@ -451,7 +451,7 @@ La création de l'objet hypo_1 se fait ainsi : :: Saisie graphique correspondante ******************************* -Consulter :ref:`gui_create_hypothese` +Consulter :doc:`gui_create_hypothese` .. warning:: En mode graphique, si on édite une hypothèse et que l'on modifie une de ses caractéristiques, par exemple le seuil de raffinement, toutes les itérations qui ont été calculées précédemment avec cette hypothèse sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles. diff --git a/doc/fr/tui_create_iteration.rst b/doc/fr/tui_create_iteration.rst index dd59db8d..0c3b1be0 100644 --- a/doc/fr/tui_create_iteration.rst +++ b/doc/fr/tui_create_iteration.rst @@ -7,7 +7,7 @@ L'itération .. index:: single: hypothèse .. index:: single: zone -Les variables sont décrites dans :ref:`gui_create_iteration`. +Les variables sont décrites dans :doc:`gui_create_iteration`. Méthodes de la classe homard **************************** @@ -31,7 +31,7 @@ Méthodes de la classe homard Méthodes communes aux classes cas et iteration ********************************************** -Voir également dans :ref:`tui_create_case`. +Voir également dans :doc:`tui_create_case`. +---------------------------------------------------------------+ +---------------------------------------------------------------+ @@ -284,7 +284,7 @@ Si une seule occurence du champ de pilotage de l'adaptation est présente dans l Les instants pour les champs à interpoler ----------------------------------------- -Les champs à interpoler sont définis dans l'hypothèse (voir :ref:`tui_create_hypothese`). +Les champs à interpoler sont définis dans l'hypothèse (voir :doc:`tui_create_hypothese`). Pour un champ donné, si aucune mention de pas de temps n'est précisé, tous les pas de temps seront pris en compte. Si on souhaite limiter l'interpolation à un ou plusieurs pas de temps, il faut le préciser ici. @@ -380,4 +380,4 @@ Ensuite, on crée une itération suivante à l'itération parent de laquelle on Saisie graphique correspondante ******************************* -Consulter :ref:`gui_create_iteration` +Consulter :doc:`gui_create_iteration` diff --git a/doc/fr/tui_create_zone.rst b/doc/fr/tui_create_zone.rst index 651e25de..03a09494 100644 --- a/doc/fr/tui_create_zone.rst +++ b/doc/fr/tui_create_zone.rst @@ -12,7 +12,7 @@ La zone .. index:: single: disque avec trou .. index:: single: 2D -Les variables sont décrites dans :ref:`gui_create_zone`. +Les variables sont décrites dans :doc:`gui_create_zone`. Méthodes de la classe homard **************************** @@ -197,7 +197,7 @@ La création d'un disque dans le plan XY se fait ainsi : Saisie graphique correspondante ******************************* -Consulter :ref:`gui_create_zone` +Consulter :doc:`gui_create_zone` .. warning:: En mode graphique, si on édite une zone et que l'on modifie une des dimensions, toutes les itérations qui ont été calculées précédemment avec cette zone sont invalidées. En mode python, cela n'est plus vrai : les itérations restent telles quelles. diff --git a/doc/fr/tui_homard.rst b/doc/fr/tui_homard.rst index 07ea221a..e0a85e4c 100644 --- a/doc/fr/tui_homard.rst +++ b/doc/fr/tui_homard.rst @@ -32,4 +32,4 @@ Exemple Saisie graphique correspondante ******************************* -Consulter :ref:`gui_homard` +Consulter :doc:`gui_homard` diff --git a/doc/fr/yacs.rst b/doc/fr/yacs.rst index 91e10cb9..b4c3cea3 100644 --- a/doc/fr/yacs.rst +++ b/doc/fr/yacs.rst @@ -4,12 +4,12 @@ YACS #### .. index:: single: YACS -L'utilisation de schémas YACS va permettre de coupler un calcul et une adaptation comme il est décrit dans :ref:`intro`. Ce couplage peut être répété au sein d'une boucle jusqu'à l'obtention d'un critère de convergence par exemple. Il existe de nombreuses façons de programmer un schéma YACS. La solution proposée ici fonctionne mais on peut très bien faire autrement ! +L'utilisation de schémas YACS va permettre de coupler un calcul et une adaptation comme il est décrit dans :doc:`intro`. Ce couplage peut être répété au sein d'une boucle jusqu'à l'obtention d'un critère de convergence par exemple. Il existe de nombreuses façons de programmer un schéma YACS. La solution proposée ici fonctionne mais on peut très bien faire autrement ! On trouvera ici la description exhaustive d'un schéma YACS. .. note:: - Le module HOMARD propose une création automatique de schéma YASC à partir d'un cas précédemment créé. Pour la mettre en oeuvre, consulter :ref:`gui_create_yacs` + Le module HOMARD propose une création automatique de schéma YASC à partir d'un cas précédemment créé. Pour la mettre en oeuvre, consulter :doc:`gui_create_yacs` Présentation générale ********************* @@ -167,7 +167,7 @@ Le nom du cas CaseName est imposé à "Calcul". Le paramètre d'entrée MeshName .. literalinclude:: ../files/yacs_01.fr.xml :lines: 483-486 -Les options de ce cas doivent maintenant être renseignées. C'est fait par le noeud python CaseOptions. Il est impératif de renseigner le répertoire de calcul. On regardera la description des fonctions dans :ref:`tui_create_case`. En sortie, on récupère l'instance de l'itération correspondant à l'état initial du cas. +Les options de ce cas doivent maintenant être renseignées. C'est fait par le noeud python CaseOptions. Il est impératif de renseigner le répertoire de calcul. On regardera la description des fonctions dans :doc:`tui_create_case`. En sortie, on récupère l'instance de l'itération correspondant à l'état initial du cas. .. literalinclude:: ../files/yacs_01.fr.xml :lines: 216-228 @@ -194,7 +194,7 @@ Le répertoire de calcul est récupéré. Le nom du maillage est rappelé. .. literalinclude:: ../files/yacs_01.fr.xml :lines: 325-333 -L'hypothèse transmise en paramètre d'entrée est caractérisée (voir :ref:`tui_create_hypothese`) : +L'hypothèse transmise en paramètre d'entrée est caractérisée (voir :doc:`tui_create_hypothese`) : .. literalinclude:: ../files/yacs_01.fr.xml :lines: 254-278 @@ -204,7 +204,7 @@ Il faut établir un nom pour la future itération. Pour s'assurer que le nom n'a .. literalinclude:: ../files/yacs_01.fr.xml :lines: 280-290 -L'itération est complétée : hypothèse, futur maillage, champ (voir :ref:`tui_create_iteration`) : +L'itération est complétée : hypothèse, futur maillage, champ (voir :doc:`tui_create_iteration`) : .. literalinclude:: ../files/yacs_01.fr.xml :lines: 292-311 @@ -226,8 +226,8 @@ Iter_n Aux passages suivants dans le bloc d'adaptation, il faut récupérer : -- la dernière itération créée pour la poursuivre : service LastIteration (voir :ref:`tui_create_iteration`) -- l'hypothèse créée : service GetHypothesis (voir :ref:`tui_create_hypothese`) +- la dernière itération créée pour la poursuivre : service LastIteration (voir :doc:`tui_create_iteration`) +- l'hypothèse créée : service GetHypothesis (voir :doc:`tui_create_hypothese`) On passe ensuite dans le noeud Homard_Exec pour calculer le nouveau maillage.