]> SALOME platform Git repositories - plugins/hexoticplugin.git/blobdiff - doc/salome/gui/HexoticPLUGIN/input/hexoticplugin_python_interface.doc
Salome HOME
COTECH: Update names of DISTENE products
[plugins/hexoticplugin.git] / doc / salome / gui / HexoticPLUGIN / input / hexoticplugin_python_interface.doc
index 3d8eb013243375bb7f386e44e1cd1543a96ca67a..96cb32ebe3939b775bdc3101f53b7cf78c5f35ff 100644 (file)
@@ -2,11 +2,22 @@
 
 \page hexoticplugin_python_interface_page Python Interface
 
-Python package HexoticPLUGINBuilder defines several classes, destined for creation of the 3D meshes.
+\note The former name of MG-Hexa mesher is \a Hexotic and names
+of the corresponding classes and modules still include \a "Hexotic".
 
-Hexotic meshing plugin dynamically adds several methods to the smeshBuilder.Mesh class to create meshing algorithms.
+Python package HexoticPLUGINBuilder defines
+HexoticPLUGINBuilder.Hexotic_Algorithm class providing access
+to the MG-Hexa meshing algorithm and its parameters.
 
-Below you can see an example of usage of the HexoticPLUGINBuilder Python API for mesh generation:
+You can get an instance of this class by calling
+smeshBuilder.Mesh.Hexahedron(algo=smeshBuilder.MG_Hexa) or 
+smeshBuilder.Mesh.Hexahedron(algo=smeshBuilder.Hexotic). This call
+creates an algorithm (if not yet exist), assigns it to the mesh and
+returns an instance of HexoticPLUGINBuilder.Hexotic_Algorithm to the caller.
+
+The class of algorithm has methods to set up meshing parameters.
+
+Below you can see examples of usage of this class for hexahedral mesh generation.
 
 \anchor tui_hexotic