From: GERALD NICOLAS <D68518@dsp0864451.atlas.edf.fr>
Date: Thu, 28 Jan 2021 09:35:48 +0000 (+0100)
Subject: Mise à jour documentation
X-Git-Tag: V9_7_0a1~13^2~30
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=bb1db63155760ac9727a664331145cb22dd30661;p=modules%2Fsmesh.git

Mise à jour documentation
---

diff --git a/src/Tools/blocFissure/doc/gui.rst b/src/Tools/blocFissure/doc/gui.rst
index af0815088..4d633588e 100644
--- a/src/Tools/blocFissure/doc/gui.rst
+++ b/src/Tools/blocFissure/doc/gui.rst
@@ -6,23 +6,30 @@ With GUI
 To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) was developed.
 Inputs are similar to those of :ref:`script mode <script>`. GUI is accessible in the SMESH extension *Add a crack in a mesh*
 
-.. figure:: images/BF_GUI_capture.png
-   :width: 700
+.. image:: images/BF_GUI_capture.png
+   :scale: 100
    :align: center
+   :alt: Window of the graphical interface
 
-   Windows of the graphical interface
+Window of the graphical interface
 
 +------------------------------------------------------------------------------------------------------------------+
 |       GUI parameters                                                                                             |
 +======================+===================================+=======================================================+
-| **maillageSain**     | *[string]*                        |  Relative address of the input structure 3D mesh      |
+| **Maillage sain**    | *[string]*                        |  Relative address of the input structure 3D mesh      |
 |                      | ex: mesh/maillage.med             |  in MED format (base is repertoire de travail)        |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **FaceFissure**      | *[string]*                        |  Relative address of the input crack geometry         |
-|                      | ex: mesh/fissure.brep             |  in BREP format (base is repertoire de travail)       |
+| **Face fissure**     | *[string]*                        |  Relative address of the input crack geometry in      |
+|                      | ex: mesh/fissure.xao              |  BREP or XAO format (base is repertoire de travail)   |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **index edges fond   | *[list of integers]*              |  List of edges number which define the crack front    |
-| fissure**            | ex: [1,2]                         |                                                       |
+| **Arêtes fond        | *[list of strings]*               |  Definition of the crack front:                       |
+| fissure**            | ex: ["F_1", "F_2"]                |  If XAO: list of the names of the edge group(s)       |
++----------------------+-----------------------------------+-------------------------------------------------------+
+|                      | *[list of integers]*              |  If BREP (or XAO): list of edges number in GEOM       |
+|                      | ex: [1,2]                         |                                                       |
++----------------------+-----------------------------------+-------------------------------------------------------+
+| **Distance           | *[float]*                         |  Length of influence - distance that defines the      |
+| d'influence**        | ex: 20.0000                       |  size of the extracted Box around the crack           |
 +----------------------+-----------------------------------+-------------------------------------------------------+
 | **min**              | *[float]*                         |  Float defining the minimum size of elements          |
 |                      | ex: 1.00000                       |  to mesh the crack                                    |
@@ -30,40 +37,40 @@ Inputs are similar to those of :ref:`script mode <script>`. GUI is accessible in
 | **max**              | *[float]*                         |  Float defining the maximum size of elements          |
 |                      | ex: 10.0000                       |  to mesh the crack                                    |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **distance           | *[float]*                         |  Length of influence - distance that defines the      |
-| influence**          | ex: 20.0000                       |  size of the extracted Box around the crack           |
-+----------------------+-----------------------------------+-------------------------------------------------------+
-| **rayon pipe**       | *[float]*                         |  Radius of the tore around the front                  |
+| **Rayon pipe**       | *[float]*                         |  Radius of the tore around the front                  |
 |                      | ex: 5.00000                       |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **longueur mailles** | *[float]*                         |  Length of the segments of the tore along crack front |
+| **Longueur mailles** | *[float]*                         |  Length of the segments of the tore along crack front |
 |                      | ex: 5.00000                       |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-|  **couronnes**       | *[integer]*                       |  Number of radial segment of the tore                 |
+| **Couronnes**        | *[integer]*                       |  Number of radial segment of the tore                 |
 |                      | ex: 5                             |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **secteurs**         | *[integer]*                       |  Number of sectors of the tore                        |
+| **Secteurs**         | *[integer]*                       |  Number of sectors of the tore                        |
 |                      | ex: 16                            |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **arete face         | *[float]*                         |  Mesh size of elements for the Box remeshing          |
+| **Triangles face     | *[float]*                         |  Mesh size of elements for the Box remeshing          |
 | fissure**            | ex: 5.0000                        |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **repertoire de      | *[string]*                        |  Absolute address of the directory where files are    |
+| **Répertoire de      | *[string]*                        |  Absolute address of the directory where files are    |
 | travail**            | ex: /home/A123456                 |  saved                                                |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **nom résultat**     | *[string]*                        |  Name of the resulting mesh                           |
+| **Nom du résultat**  | *[string]*                        |  Name of the resulting mesh                           |
 |                      | ex: maillage_fissure              |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **mode**             | *[choice]*                        |  Verbose mode for Salome messages                     |
+| **Mode**             | *[choice]*                        |  Verbose mode for Salome messages                     |
 |                      | ex: verbose                       |                                                       |
 +----------------------+-----------------------------------+-------------------------------------------------------+
 
-.. figure:: images/parametres_GUI.png
+.. image:: images/parametres_GUI.png
    :width: 350
    :align: center
+   :alt: Tore parameters
+
+Tore parameters
 
-   Tore parameters
 
+- **Exemple**: fills the panels with a test-case
 
 - **Reset**: clears all the parameters
 
@@ -73,7 +80,7 @@ Inputs are similar to those of :ref:`script mode <script>`. GUI is accessible in
 
 - **Sauver**: save a .dic file with the active parameters
 
-- **Cancel**: exit GUI
+- **Fermer**: exit GUI
 
-- **Sauver**: Launch calculation
+- **OK**: Launch calculation
 
diff --git a/src/Tools/blocFissure/doc/images/BF_GUI_capture.png b/src/Tools/blocFissure/doc/images/BF_GUI_capture.png
index d234f6c11..c1fb0e072 100644
Binary files a/src/Tools/blocFissure/doc/images/BF_GUI_capture.png and b/src/Tools/blocFissure/doc/images/BF_GUI_capture.png differ
diff --git a/src/Tools/blocFissure/doc/pipes.rst b/src/Tools/blocFissure/doc/pipes.rst
index adac58384..2101f546a 100644
--- a/src/Tools/blocFissure/doc/pipes.rst
+++ b/src/Tools/blocFissure/doc/pipes.rst
@@ -6,9 +6,10 @@ For bended pipes
 Cracked bended pipes being a common encountered case, a specific module was developed with a Graphic User Interface (GUI). GUI is accessible in the SMESH extension *Meshed Pipe with a crack*. Compared to the classical use of « Bloc Fissure », this extension also generate the pipe mesh and the crack geometry from geometrical information.
 
 
-.. figure:: images/Capture_GUI_pipes_2.png
+.. image:: images/Capture_GUI_pipes_2.png
    :width: 800
    :align: center
+   :alt: Print screen of GUI
 
    Print screen of GUI of the extension *Meshed Pipe with a crack*
 
diff --git a/src/Tools/blocFissure/doc/principles.rst b/src/Tools/blocFissure/doc/principles.rst
index ae223297a..af6c7a646 100644
--- a/src/Tools/blocFissure/doc/principles.rst
+++ b/src/Tools/blocFissure/doc/principles.rst
@@ -10,7 +10,7 @@ In order to illustrate « Bloc Fissure » principle, the simple case of a crack
 
 1. The first step consists in loading the structure mesh (a) as well as the crack surface geometry (b).
 
-2. The crack is then meshed (c). A length criterion defines the size of the extracted « Box ». This length is called the length of influence. Every element having a node within this zone is included in the « Box ». A second operation adds elements in the Box in order to have continuous faces (d).
+2. The crack is then meshed (c). A length criterion defines the size of the extracted « Box ». This length is called the length of influence. Every element of the structure mesh having a node within this zone is included in the « Box ». A second operation adds those elements in the Box in order to have continuous faces (d).
 
 3. A geometrical Box is reconstructed from the extracted Box mesh. The reconstruction is limited to faces which intersect the crack (e). A torus is created following the crack front (f).
 
@@ -63,6 +63,7 @@ The length of influence is important. It defines the size of the extracted Box.
 .. image:: images/longueur_influence.png
    :width: 600
    :align: center
+   :alt: The length of influence
 
 Every element having a node at a smaller distance to the crack than the length of influence is selected. Then a filling algorithm fulfill the Box with elements to get a Box. The Box is not limited to rectangular shapes. See the section on :ref:`test cases <test_cases>` to see examples.
 
@@ -90,6 +91,7 @@ For similar reasons, crack front edges must exceed from the structure mesh. The
 
 .. image:: images/schema_lignes1.png
    :scale: 80
+   :alt: Crack front edges
 
 5) **Loss of element groups:**
 
diff --git a/src/Tools/blocFissure/doc/scripts.rst b/src/Tools/blocFissure/doc/scripts.rst
index 0808c48bb..078da2596 100644
--- a/src/Tools/blocFissure/doc/scripts.rst
+++ b/src/Tools/blocFissure/doc/scripts.rst
@@ -15,10 +15,12 @@ The main command of « Bloc Fissure » is the casStandard function. It has a sin
 | **maillageSain**     | *[string]*                        |  Absolute address of the input structure 3D mesh      |
 |                      |                                   |  in MED format                                        |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **BrepFaceFissure**  | *[string]*                        |  Absolute address of the input crack geometry         |
-|                      |                                   |  in BREP format                                       |
+| **CAOFaceFissure**   | *[string]*                        |  Absolute address of the input crack geometry         |
+|                      |                                   |  in XAO or BREP format                                |
 +----------------------+-----------------------------------+-------------------------------------------------------+
-| **edgeFissIds**      | *[list of integers]*              |  List of edges number which define the crack front    |
+| **edgeFiss**         | *[list of strings]*               |  List of edges group which define the crack front     |
++----------------------+-----------------------------------+-------------------------------------------------------+
+|                      | *[list of integers]*              |  List of edges number which define the crack front    |
 +----------------------+-----------------------------------+-------------------------------------------------------+
 | **meshBrep**         | *[list of 2 floats]*              |  List of two floats defining respectively minimum and |
 |                      |                                   |  maximum size of elements of the crack mesh           |
@@ -47,6 +49,7 @@ Geometrical parameters of the tore are illustrated :
 .. image:: images/parametres.png
    :width: 350
    :align: center
+   :alt: Geometrical parameters of the tore
 
 Different levels of verbose are available. Use one of this 4 optional functions to set verbose type:
 
@@ -68,8 +71,8 @@ Different levels of verbose are available. Use one of this 4 optional functions
 
   dicoParams = dict(nomCas            = 'cubeFiss',
                     maillageSain      = "/home/A123456/BF/cube.med",
-                    brepFaceFissure   = "/home/A123456/BF/fiss.brep",
-                    edgeFissIds       = [4],
+                    CAOFaceFissure    = "/home/A123456/BF/fiss.xao",
+                    edgeFiss          = ["Fond"],
                     lgInfluence       = 20.,
                     meshBrep          = (5.,10.),
                     rayonPipe         = 5.,
diff --git a/src/Tools/blocFissure/doc/testcases.rst b/src/Tools/blocFissure/doc/testcases.rst
index 76ae558ac..8119c4e6e 100644
--- a/src/Tools/blocFissure/doc/testcases.rst
+++ b/src/Tools/blocFissure/doc/testcases.rst
@@ -92,6 +92,8 @@ All 13 cases are shown Table 2. Two views show the whole cracked structure and a
 |   :width: 400                             |    :width: 400                               |
 |   :align: center                          |    :align: center                            |
 +-------------------------------------------+----------------------------------------------+
+| tube                                                                                     |
++-------------------------------------------+----------------------------------------------+
 
 .. _pipeTC:
 
@@ -152,7 +154,7 @@ modify the file ``CasTests/execution_Cas.py`` and change::
 
 And change from 0 to 1 of the index of the test you want to launch::
 
-    torun = [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    torun = [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
 
 then launch the test cases::
 
@@ -170,7 +172,7 @@ The index of each test is the position of the test in the following table, from
 +--------------------+--------------------+--------------------+-----------------+-----------------+
 | cubeMilieu         | ellipse_2          | fissureCoude_1     | fissureCoude_6  | vis_1           |
 +--------------------+--------------------+--------------------+-----------------+-----------------+
-| cubeTransverse     | eprouvetteCourbe   | fissureCoude_10    | fissureCoude_7  |                 |
+| cubeTransverse     | eprouvetteCourbe   | fissureCoude_10    | fissureCoude_7  | tube            |
 +--------------------+--------------------+--------------------+-----------------+-----------------+
 | cylindre           | eprouvetteDroite   | fissureCoude_2     | fissureCoude_8  |                 |
 +--------------------+--------------------+--------------------+-----------------+-----------------+