Merge branch 'master' of https://codev-tuleap.cea.fr/plugins/git/salome/smesh

[modules/smesh.git] / src / Tools / blocFissure / doc / scripts.rst

diff --git a/src/Tools/blocFissure/doc/scripts.rst b/src/Tools/blocFissure/doc/scripts.rst
index 0808c48bb3d11ffa9d3c9772a9bd6c3bf6ae4fce..d8804c1c3ccc87cff14423b1489245c9ebccb1fe 100644 (file)
--- 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      |\r
 |                      |                                   |  in MED format                                        |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **BrepFaceFissure**  | *[string]*                        |  Absolute address of the input crack geometry         |\r
-|                      |                                   |  in BREP format                                       |\r
+| **CAOFaceFissure**   | *[string]*                        |  Absolute address of the input crack geometry         |\r
+|                      |                                   |  in XAO or BREP format                                |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
-| **edgeFissIds**      | *[list of integers]*              |  List of edges number which define the crack front    |\r
+| **edgeFiss**         | *[list of strings]*               |  List of edges group which define the crack front     |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+|                      | *[list of integers]*              |  List of edges number which define the crack front    |\r
 +----------------------+-----------------------------------+-------------------------------------------------------+\r
 | **meshBrep**         | *[list of 2 floats]*              |  List of two floats defining respectively minimum and |\r
 |                      |                                   |  maximum size of elements of the crack mesh           |\r
@@ -47,29 +49,30 @@ Geometrical parameters of the tore are illustrated :
 .. image:: images/parametres.png\r
    :width: 350\r
    :align: center\r
+   :alt: Geometrical parameters of the tore\r
 \r
-Different levels of verbose are available. Use one of this 4 optional functions to set verbose type:\r
+Different levels of verbose are available. The prints are located in the file ''LOGFILE''. Use one of this 4 optional functions to set verbose type:\r
 \r
-- / **setDebug()**\r
+- / **setDebug(LOGFILE)**\r
 \r
-- / **setVerbose()**\r
+- / **setVerbose(LOGFILE)**\r
 \r
-- / **setRelease()**\r
+- / **setRelease(LOGFILE)**\r
 \r
-- / **setUnitTests()**\r
+- / **setUnitTests(LOGFILE)**\r
 \r
 **example to run in salome session**::\r
 \r
   from blocFissure import gmu\r
   from blocFissure.gmu import initLog\r
-  initLog.setDebug()\r
+  initLog.setDebug("/tmp/blocFissure.log")\r
 \r
   from blocFissure.casStandard import casStandard\r
 \r
   dicoParams = dict(nomCas            = 'cubeFiss',\r
                     maillageSain      = "/home/A123456/BF/cube.med",\r
-                    brepFaceFissure   = "/home/A123456/BF/fiss.brep",\r
-                    edgeFissIds       = [4],\r
+                    CAOFaceFissure    = "/home/A123456/BF/fiss.xao",\r
+                    edgeFiss          = ["Fond"],\r
                     lgInfluence       = 20.,\r
                     meshBrep          = (5.,10.),\r
                     rayonPipe         = 5.,\r
@@ -80,6 +83,8 @@ Different levels of verbose are available. Use one of this 4 optional functions
 \r
   execInstance = casStandard(dicoParams)\r
 \r
+  newmesh = execInstance.maillageFissure\r
+\r
 \r
 \r
 \r