doc/salome/gui/HexoticPLUGIN/input/hexoticplugin_python_interface.doc

   1 /*!
   2
   3 \page hexoticplugin_python_interface_page Python Interface
   4
   5 \note The former name of MG-Hexa mesher is \a Hexotic and names
   6 of the corresponding classes and modules still include \a "Hexotic".
   7
   8 Python package HexoticPLUGINBuilder defines
   9 HexoticPLUGINBuilder.Hexotic_Algorithm class providing access
  10 to the MG-Hexa meshing algorithm and its parameters.
  11
  12 You can get an instance of this class by calling
  13 smeshBuilder.Mesh.Hexahedron(algo=smeshBuilder.MG_Hexa) or
  14 smeshBuilder.Mesh.Hexahedron(algo=smeshBuilder.Hexotic). This call
  15 creates an algorithm (if not yet exist), assigns it to the mesh and
  16 returns an instance of HexoticPLUGINBuilder.Hexotic_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 hexahedral mesh generation.
  21
  22 \anchor tui_hexotic
  23
  24 -# \ref tui_hexotic_basic
  25 -# \ref tui_hexotic_sd_mode
  26   -# \ref tui_hexotic_sd_mode1
  27   -# \ref tui_hexotic_sd_mode2
  28   -# \ref tui_hexotic_sd_mode3
  29   -# \ref tui_hexotic_sd_mode4
  30
  31 \section tui_hexotic_basic Construction of Mesh using MG-Hexa algorithm
  32
  33 <h2>Example of mesh generation with MG-Hexa algorithm:</h2>
  34 \tui_script{hexoticdemo.py}
  35
  36 \image html hexotic_basic_subdivisions_4_8.png Left: MG-Hexa mesh without hypothesis, right: MG-Hexa mesh with an hypothesis defined by minl=4 and maxl=8
  37
  38 <h2>Example of mesh generation with MG-Hexa algorithm and viscous layers parameters:</h2>
  39 \tui_script{hexoticdemo_vl.py}
  40
  41 \image html hexotic_vl_example.png Left: MG-Hexa mesh without viscous layers parameters, right: MG-Hexa mesh with viscous layers parameters
  42
  43 \subsection tui_local_size Local size
  44
  45 \image html hexotic_local_size_example.png Example of use of a local size on the skin of a sphere
  46
  47
  48 \ref tui_hexotic "Back to top"
  49
  50 \section tui_hexotic_sd_mode Effect of the sub-domain mode
  51
  52 This example illustrates the sub-domain mode of MG-Hexa.
  53
  54 \subsection tui_hexotic_sd_mode1 Sub-domain mode = 1
  55
  56 <h2>Example of sub-domain mode 1 with MG-Hexa algorithm:</h2>
  57 \tui_script{hexoticsubdom1.py}
  58
  59 \image html hexotic_sd_mode_1.png MG-Hexa mesh of a box cut by a holed sphere ( sd = 1 )
  60
  61 \ref tui_hexotic "Back to top"
  62
  63 \subsection tui_hexotic_sd_mode2 Sub-domain mode = 2
  64
  65 <h2>Example of sub-domain mode 2 with MG-Hexa algorithm:</h2>
  66 \tui_script{hexoticsubdom2.py}
  67
  68 \image html hexotic_sd_mode_2.png MG-Hexa mesh of a box cut by a holed sphere ( sd = 2 )
  69
  70 \ref tui_hexotic "Back to top"
  71
  72 \subsection tui_hexotic_sd_mode3 Sub-domain mode = 3
  73
  74 <h2>Example of sub-domain mode 3 with MG-Hexa algorithm:</h2>
  75 \tui_script{hexoticsubdom3.py}
  76
  77 \image html hexotic_sd_mode_3.png MG-Hexa mesh of a box cut by a holed sphere ( sd = 3 )
  78
  79 \ref tui_hexotic "Back to top"
  80
  81 \subsection tui_hexotic_sd_mode4 Sub-domain mode = 4
  82
  83 <h2>Example of sub-domain mode 4 with MG-Hexa algorithm:</h2>
  84 \tui_script{hexoticsubdom4.py}
  85
  86 \image html hexotic_sd_mode_4.png MG-Hexa mesh of a box cut by a plane ( On the left, sd = 3: the internal surface is ignored ; on the right sd = 4: all sub-domains are meshed )
  87
  88 \ref tui_hexotic "Back to top"
  89
  90 */