Salome HOME
Mise à jour documentation
[modules/smesh.git] / src / Tools / blocFissure / doc / gui.rst
old mode 100755 (executable)
new mode 100644 (file)
index 0293413..4d63358
@@ -3,25 +3,33 @@
 With GUI\r
 =====================================\r
 \r
-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 *XXXXXXXXXXXXXXXXXXXXXXXX*\r
+To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) was developed.\r
+Inputs are similar to those of :ref:`script mode <script>`. GUI is accessible in the SMESH extension *Add a crack in a mesh*\r
 \r
-.. figure:: images/BF_GUI_capture.png\r
-   :width: 700\r
+.. image:: images/BF_GUI_capture.png\r
+   :scale: 100\r
    :align: center\r
+   :alt: Window of the graphical interface\r
 \r
-   Windows of the graphical interface\r
+Window of the graphical interface\r
 \r
 +------------------------------------------------------------------------------------------------------------------+\r
 |       GUI parameters                                                                                             |\r
 +======================+===================================+=======================================================+\r
-| **maillageSain**     | *[string]*                        |  Relative address of the input structure 3D mesh      |\r
+| **Maillage sain**    | *[string]*                        |  Relative address of the input structure 3D mesh      |\r
 |                      | ex: mesh/maillage.med             |  in MED format (base is repertoire de travail)        |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **FaceFissure**      | *[string]*                        |  Relative address of the input crack geometry         |\r
-|                      | ex: mesh/fissure.brep             |  in BREP format (base is repertoire de travail)       |\r
+| **Face fissure**     | *[string]*                        |  Relative address of the input crack geometry in      |\r
+|                      | ex: mesh/fissure.xao              |  BREP or XAO format (base is repertoire de travail)   |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **index edges fond   | *[list of integers]*              |  List of edges number which define the crack front    |\r
-| fissure**            | ex: [1,2]                         |                                                       |\r
+| **Arêtes fond        | *[list of strings]*               |  Definition of the crack front:                       |\r
+| fissure**            | ex: ["F_1", "F_2"]                |  If XAO: list of the names of the edge group(s)       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+|                      | *[list of integers]*              |  If BREP (or XAO): list of edges number in GEOM       |\r
+|                      | ex: [1,2]                         |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **Distance           | *[float]*                         |  Length of influence - distance that defines the      |\r
+| d'influence**        | ex: 20.0000                       |  size of the extracted Box around the crack           |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
 | **min**              | *[float]*                         |  Float defining the minimum size of elements          |\r
 |                      | ex: 1.00000                       |  to mesh the crack                                    |\r
@@ -29,40 +37,40 @@ To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) w
 | **max**              | *[float]*                         |  Float defining the maximum size of elements          |\r
 |                      | ex: 10.0000                       |  to mesh the crack                                    |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **distance           | *[float]*                         |  Length of influence - distance that defines the      |\r
-| influence**          | ex: 20.0000                       |  size of the extracted Box around the crack           |\r
-+----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **rayon pipe**       | *[float]*                         |  Radius of the tore around the front                  |\r
+| **Rayon pipe**       | *[float]*                         |  Radius of the tore around the front                  |\r
 |                      | ex: 5.00000                       |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **longueur mailles** | *[float]*                         |  Length of the segments of the tore along crack front |\r
+| **Longueur mailles** | *[float]*                         |  Length of the segments of the tore along crack front |\r
 |                      | ex: 5.00000                       |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-|  **couronnes**       | *[integer]*                       |  Number of radial segment of the tore                 |\r
+| **Couronnes**        | *[integer]*                       |  Number of radial segment of the tore                 |\r
 |                      | ex: 5                             |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **secteurs**         | *[integer]*                       |  Number of sectors of the tore                        |\r
+| **Secteurs**         | *[integer]*                       |  Number of sectors of the tore                        |\r
 |                      | ex: 16                            |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **arete face         | *[float]*                         |  Mesh size of elements for the Box remeshing          |\r
+| **Triangles face     | *[float]*                         |  Mesh size of elements for the Box remeshing          |\r
 | fissure**            | ex: 5.0000                        |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **repertoire de      | *[string]*                        |  Absolute address of the directory where files are    |\r
+| **pertoire de      | *[string]*                        |  Absolute address of the directory where files are    |\r
 | travail**            | ex: /home/A123456                 |  saved                                                |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **nom résultat**     | *[string]*                        |  Name of the resulting mesh                           |\r
+| **Nom du résultat**  | *[string]*                        |  Name of the resulting mesh                           |\r
 |                      | ex: maillage_fissure              |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **mode**             | *[choice]*                        |  Verbose mode for Salome messages                     |\r
+| **Mode**             | *[choice]*                        |  Verbose mode for Salome messages                     |\r
 |                      | ex: verbose                       |                                                       |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
 \r
-.. figure:: images/parametres_GUI.png\r
+.. image:: images/parametres_GUI.png\r
    :width: 350\r
    :align: center\r
+   :alt: Tore parameters\r
+\r
+Tore parameters\r
 \r
-   Tore parameters\r
 \r
+- **Exemple**: fills the panels with a test-case\r
 \r
 - **Reset**: clears all the parameters\r
 \r
@@ -72,7 +80,7 @@ To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) w
 \r
 - **Sauver**: save a .dic file with the active parameters\r
 \r
-- **Cancel**: exit GUI\r
+- **Fermer**: exit GUI\r
 \r
-- **Sauver**: Launch calculation\r
+- **OK**: Launch calculation\r
 \r