doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_interface.doc

   1 /*!
   2
   3 \page ghs3dplugin_python_interface_page Python Interface
   4
   5 \note The former name of MG-Tetra mesher is \a GHS3D and names
   6 of the corresponding classes and modules still include \a "GHS3D".
   7
   8 Python package GHS3DPluginBuilder defines
   9 GHS3DPluginBuilder.GHS3D_Algorithm class providing access
  10 to the MG-Tetra meshing algorithm and its parameters.
  11
  12 You can get an instance of this class by calling
  13 smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.MG_Tetra) or
  14 smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.GHS3D). This call
  15 creates an algorithm (if not yet exist), assigns it to the mesh and
  16 returns an instance of GHS3DPluginBuilder.GHS3D_Algorithm to the caller.
  17
  18 The class of algorithm has methods to set up meshing parameters.
  19
  20 Below you can see examples of usage of this class for tetrahedral mesh generation.
  21
  22 \anchor tui_ghs3d
  23
  24 -# \ref tui_ghs3d_basic
  25 -# \ref tui_ghs3d_enforced_vertices
  26 -# \ref tui_ghs3d_enforced_meshes
  27
  28 \section tui_ghs3d_basic Construction of Mesh using MG-Tetra algorithm
  29
  30 \anchor example_GHS3DPlugin
  31 <h2>Example of mesh generation with MG-Tetra algorithm:</h2>
  32 \tui_script{ghs3ddemo.py}
  33
  34
  35 \image html ghs3d_screenshot.png MG-Tetra mesh without hypothesis
  36
  37 \ref tui_ghs3d "Back to top"
  38
  39 \section tui_ghs3d_enforced_vertices Adding enforced vertices
  40
  41 <h2>Example of enforced vertices with MG-Tetra algorithm:</h2>
  42 \tui_script{ghs3d_enfvert.py}
  43
  44
  45 \image html ghs3d_screenshot_enf1.png MG-Tetra mesh with enforced vertex
  46 \image html ghs3d_screenshot_enf2.png MG-Tetra mesh with enforced vertex from GEOM vertex
  47
  48 \ref tui_ghs3d "Back to top"
  49
  50 \section tui_ghs3d_enforced_meshes Adding enforced mesh
  51
  52 <h2>Example of enforced meshes with MG-Tetra algorithm:</h2>
  53 \tui_script{ghs3d_enfmesh.py}
  54
  55 \image html ghs3d_screenshot_enf3.png
  56 \image html ghs3d_screenshot_enf4.png
  57 \image html ghs3d_screenshot_enf5.png
  58 \image html ghs3d_screenshot_enf6.png
  59
  60 \ref tui_ghs3d "Back to top"
  61
  62 */