Salome HOME
Merge remote branch 'origin/V7_dev'
[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
new file mode 100755 (executable)
index 0000000..0808c48
--- /dev/null
@@ -0,0 +1,86 @@
+.. _script:\r
+\r
+With scripts\r
+=====================================\r
+\r
+« Bloc Fissure » has a script mode which is very close to the :ref:`GUI <gui>`, in the sense that the same information is needed as input.This documentation aims at giving an example and explains how to generate a cracked mesh using a python script calling « Bloc Fissure » functions. There are several others functions available in « Bloc Fissure » but they are not documented in this documentation.\r
+\r
+The main command of « Bloc Fissure » is the casStandard function. It has a single argument which is a python dictionary with the following keys. All are mandatory parameters except those marked by /.\r
+\r
++------------------------------------------------------------------------------------------------------------------+\r
+|       Script parameters                                                                                          |\r
++======================+===================================+=======================================================+\r
+| / **nomCas**         | *[string, default=’casStandard’]* |  Name of the problem                                  |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **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
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **edgeFissIds**      | *[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
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **lgInfluence**      | *[float]*                         |  Length of influence - distance that defines the      |\r
+|                      |                                   |  size of the extracted Box around the crack           |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **rayonPipe**        | *[float]*                         |  Radius of the tore around the front                  |\r
+|                      |                                   |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| / **lenSegPipe**     | *[float, default=rayonPipe]*      |  Length of the segments of the tore along crack front |\r
+|                      |                                   |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+|  **nbSegRad**        | *[integer]*                       |  Number of radial segment of the tore                 |\r
+|                      |                                   |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **nbSegCercle**      | *[integer]*                       |  Number of sectors of the tore                        |\r
+|                      |                                   |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+| **areteFaceFissure** | *[float]*                         |  Mesh size of elements for the Box remeshing          |\r
+|                      |                                   |                                                       |\r
++----------------------+-----------------------------------+-------------------------------------------------------+\r
+\r
+Geometrical parameters of the tore are illustrated :\r
+\r
+.. image:: images/parametres.png\r
+   :width: 350\r
+   :align: center\r
+\r
+Different levels of verbose are available. Use one of this 4 optional functions to set verbose type:\r
+\r
+- / **setDebug()**\r
+\r
+- / **setVerbose()**\r
+\r
+- / **setRelease()**\r
+\r
+- / **setUnitTests()**\r
+\r
+**example to run in salome session**::\r
+\r
+  from blocFissure import gmu\r
+  from blocFissure.gmu import initLog\r
+  initLog.setDebug()\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
+                    lgInfluence       = 20.,\r
+                    meshBrep          = (5.,10.),\r
+                    rayonPipe         = 5.,\r
+                    lenSegPipe        = 5,\r
+                    nbSegRad          = 5,\r
+                    nbSegCercle       = 32,\r
+                    areteFaceFissure  = 5)\r
+\r
+  execInstance = casStandard(dicoParams)\r
+\r
+\r
+\r
+\r
+\r