Création automatique de schémas YACS à partir d'un cas

[modules/homard.git] / doc / en / tui_create_case.rst

diff --git a/doc/en/tui_create_case.rst b/doc/en/tui_create_case.rst
index 73d29ab53081d05a7a6b15de250493cb1f10f841..2f6e2b2598d529b3ad7e38375633a502b6d5d286 100644 (file)
--- a/doc/en/tui_create_case.rst
+++ b/doc/en/tui_create_case.rst
@@ -1,7 +1,7 @@
 .. _tui_create_case:
 
 The case
-========
+########
 .. index:: single: cas
 .. index:: single: type of conformity
 .. index:: single: mesh;initial
@@ -9,10 +9,10 @@ The case
 The variables are described in :ref:`gui_create_case`.
 
 Methods of the class homard
-""""""""""""""""""""""""""""
+***************************
 
 Creation of a case
-^^^^^^^^^^^^^^^^^^
+==================
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -46,7 +46,7 @@ Creation of a case
 +---------------------------------------------------------------+
 
 Creation of a case by pursuit of a computed iteration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=====================================================
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -88,7 +88,8 @@ Creation of a case by pursuit of a computed iteration
 
 
 Methods of the class cas
-""""""""""""""""""""""""
+************************
+.. index:: single: yacs
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -181,9 +182,20 @@ Methods of the class cas
 |         * 0: corresponds to an initial mesh                   |
 |         * other value: pursuit of an iteration with number n  |
 +---------------------------------------------------------------+
+| .. module:: WriteYACSSchema                                   |
+|                                                               |
+| **WriteYACSSchema(ScriptFile, DirName, MeshFile)**            |
+|     Writes a schema YACS relative to the case.                |
+|                                                               |
+|     - ``ScriptFile`` : name of the file that contains the     |
+|       script to launch the computation                        |
+|     - ``DirName`` : the directory for the computation         |
+|     - ``MeshFile`` : name of the file that contains the mesh  |
+|       for the very first computation                          |
++---------------------------------------------------------------+
 
 Advanced options
-^^^^^^^^^^^^^^^^
+****************
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -205,7 +217,7 @@ Advanced options
 +---------------------------------------------------------------+
 
 Informations for the initial mesh
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+*********************************
 
 +---------------------------------------------------------------+
 +---------------------------------------------------------------+
@@ -227,7 +239,7 @@ Informations for the initial mesh
 
 
 Example
-"""""""
+*******
 The creation of the object case_1 is done as follows:
 
 ::
@@ -247,7 +259,7 @@ The creation of the object case_1 is done as follows:
 
 
 Similar graphical input
-"""""""""""""""""""""""
+***********************
 Look at :ref:`gui_create_case`