Salome HOME
Merge branch 'master' into gni/evolution
[modules/smesh.git] / src / Tools / blocFissure / doc / gui.rst
1 .. _gui:\r
2 \r
3 With GUI\r
4 =====================================\r
5 \r
6 To make the use of « Bloc Fissure » easier, a Graphical User Interface (GUI) was developed.\r
7 Inputs are similar to those of :ref:`script mode <script>`. GUI is accessible in the SMESH extension *Add a crack in a mesh*\r
8 \r
9 .. image:: images/BF_GUI_capture.png\r
10    :scale: 100\r
11    :align: center\r
12    :alt: Window of the graphical interface\r
13 \r
14 Window of the graphical interface\r
15 \r
16 +------------------------------------------------------------------------------------------------------------------+\r
17 |       GUI parameters                                                                                             |\r
18 +======================+===================================+=======================================================+\r
19 | **Maillage sain**    | *[string]*                        |  Relative address of the input structure 3D mesh      |\r
20 |                      | ex: mesh/maillage.med             |  in MED format (base is repertoire de travail)        |\r
21 +----------------------+-----------------------------------+-------------------------------------------------------+\r
22 | **Face fissure**     | *[string]*                        |  Relative address of the input crack geometry in      |\r
23 |                      | ex: mesh/fissure.xao              |  BREP or XAO format (base is repertoire de travail)   |\r
24 +----------------------+-----------------------------------+-------------------------------------------------------+\r
25 | **Arêtes fond        | *[list of strings]*               |  Definition of the crack front:                       |\r
26 | fissure**            | ex: ["F_1", "F_2"]                |  If XAO: list of the names of the edge group(s)       |\r
27 +----------------------+-----------------------------------+-------------------------------------------------------+\r
28 |                      | *[list of integers]*              |  If BREP (or XAO): list of edges number in GEOM       |\r
29 |                      | ex: [1,2]                         |                                                       |\r
30 +----------------------+-----------------------------------+-------------------------------------------------------+\r
31 | **Distance           | *[float]*                         |  Length of influence - distance that defines the      |\r
32 | d'influence**        | ex: 20.0000                       |  size of the extracted Box around the crack           |\r
33 +----------------------+-----------------------------------+-------------------------------------------------------+\r
34 | **min**              | *[float]*                         |  Float defining the minimum size of elements          |\r
35 |                      | ex: 1.00000                       |  to mesh the crack                                    |\r
36 +----------------------+-----------------------------------+-------------------------------------------------------+\r
37 | **max**              | *[float]*                         |  Float defining the maximum size of elements          |\r
38 |                      | ex: 10.0000                       |  to mesh the crack                                    |\r
39 +----------------------+-----------------------------------+-------------------------------------------------------+\r
40 | **Rayon pipe**       | *[float]*                         |  Radius of the tore around the front                  |\r
41 |                      | ex: 5.00000                       |                                                       |\r
42 +----------------------+-----------------------------------+-------------------------------------------------------+\r
43 | **Longueur mailles** | *[float]*                         |  Length of the segments of the tore along crack front |\r
44 |                      | ex: 5.00000                       |                                                       |\r
45 +----------------------+-----------------------------------+-------------------------------------------------------+\r
46 | **Couronnes**        | *[integer]*                       |  Number of radial segment of the tore                 |\r
47 |                      | ex: 5                             |                                                       |\r
48 +----------------------+-----------------------------------+-------------------------------------------------------+\r
49 | **Secteurs**         | *[integer]*                       |  Number of sectors of the tore                        |\r
50 |                      | ex: 16                            |                                                       |\r
51 +----------------------+-----------------------------------+-------------------------------------------------------+\r
52 | **Triangles face     | *[float]*                         |  Mesh size of elements for the Box remeshing          |\r
53 | fissure**            | ex: 5.0000                        |                                                       |\r
54 +----------------------+-----------------------------------+-------------------------------------------------------+\r
55 | **Répertoire de      | *[string]*                        |  Absolute address of the directory where files are    |\r
56 | travail**            | ex: /home/A123456                 |  saved                                                |\r
57 +----------------------+-----------------------------------+-------------------------------------------------------+\r
58 | **Nom du résultat**  | *[string]*                        |  Name of the resulting mesh                           |\r
59 |                      | ex: maillage_fissure              |                                                       |\r
60 +----------------------+-----------------------------------+-------------------------------------------------------+\r
61 | **Mode**             | *[choice]*                        |  Verbose mode for Salome messages                     |\r
62 |                      | ex: verbose                       |                                                       |\r
63 +----------------------+-----------------------------------+-------------------------------------------------------+\r
64 \r
65 .. image:: images/parametres_GUI.png\r
66    :width: 350\r
67    :align: center\r
68    :alt: Tore parameters\r
69 \r
70 Tore parameters\r
71 \r
72 \r
73 - **Exemple**: fills the panels with a test-case\r
74 \r
75 - **Reset**: clears all the parameters\r
76 \r
77 - **Précédent**: loads the last set of parameters used\r
78 \r
79 - **Recharger**: loads a .dic file containing parameters\r
80 \r
81 - **Sauver**: save a .dic file with the active parameters\r
82 \r
83 - **Fermer**: exit GUI\r
84 \r
85 - **OK**: Launch calculation\r
86 \r