]> SALOME platform Git repositories - plugins/ghs3dprlplugin.git/blobdiff - doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc
Salome HOME
COTECH: Update names of DISTENE products
[plugins/ghs3dprlplugin.git] / doc / salome / gui / GHS3DPRLPLUGIN / input / ghs3dprlplugin_python_interface.doc
index eb4b482e62505d9e14ef1e08e7504958e37b12a9..eb50bc172f390c0eb0220bc5029b132a047eb1b0 100644 (file)
@@ -2,8 +2,19 @@
 
 \page ghs3dprlplugin_python_interface_page Python Interface
 
-Python package GHS3DPRLPluginBuilder defines several classes, destined for creation of the 3D meshes.
+\note The former name of MG-Tetra Parallel meshing algorithm is \a GHS3DPRL and names
+of the corresponding classes and modules still include \a "GHS3DPRL".
 
-GHS3DPRL meshing plugin dynamically adds several methods to the smeshBuilder.Mesh class to create meshing algorithms.
+Python package GHS3DPRLPluginBuilder defines
+GHS3DPRLPluginBuilder.GHS3DPRL_Algorithm class providing access
+to the MG-Tetra Parallel meshing algorithm and its parameters.
+
+You can get an instance of this class by calling
+smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.MG_Tetra_Parallel) or 
+smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.GHS3DPRL). This call
+creates an algorithm (if not yet exist), assigns it to the mesh and
+returns an instance of GHS3DPRLPluginBuilder.GHS3DPRL_Algorithm to the caller.
+
+The class of algorithm has methods to set up meshing parameters.
 
 */