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 -# \ref tui_ghs3d_optimization
  28
  29 \section tui_ghs3d_basic Construction of Mesh using MG-Tetra algorithm
  30
  31 \anchor example_GHS3DPlugin
  32 <h2>Example of mesh generation with MG-Tetra algorithm:</h2>
  33 \tui_script{ghs3ddemo.py}
  34
  35
  36 \image html ghs3d_screenshot.png MG-Tetra mesh without hypothesis
  37
  38 \ref tui_ghs3d "Back to top"
  39
  40 \section tui_ghs3d_enforced_vertices Adding enforced vertices
  41
  42 <h2>Example of enforced vertices with MG-Tetra algorithm:</h2>
  43 \tui_script{ghs3d_enfvert.py}
  44
  45
  46 \image html ghs3d_screenshot_enf1.png MG-Tetra mesh with enforced vertex
  47 \image html ghs3d_screenshot_enf2.png MG-Tetra mesh with enforced vertex from GEOM vertex
  48
  49 \ref tui_ghs3d "Back to top"
  50
  51 \section tui_ghs3d_enforced_meshes Adding enforced mesh
  52
  53 <h2>Example of enforced meshes with MG-Tetra algorithm:</h2>
  54 \tui_script{ghs3d_enfmesh.py}
  55
  56 \image html ghs3d_screenshot_enf3.png
  57 \image html ghs3d_screenshot_enf4.png
  58 \image html ghs3d_screenshot_enf5.png
  59 \image html ghs3d_screenshot_enf6.png
  60
  61 \section tui_ghs3d_optimization Mesh optimization
  62
  63 <h2>Example of mesh optimization with MG-Tetra Optimization:</h2>
  64 \tui_script{ghs3d_optimization.py}
  65
  66 \ref tui_ghs3d "Back to top"
  67
  68 */