doc/salome/gui/BLSURFPLUGIN/input/blsurfplugin_python_interface.doc

   1 /*!
   2
   3 \page blsurfplugin_python_interface_page Python Interface
   4
   5 \note The former name of MG-CADSurf mesher is \a BLSURF and names
   6 of the corresponding classes and modules still include \a "BLSURF".
   7
   8 Python package BLSURFPluginBuilder defines
   9 BLSURFPluginBuilder.BLSURF_Algorithm class providing access
  10 to the MG-CADSurf meshing algorithm and its parameters.
  11
  12 You can get an instance of this class by calling
  13 smeshBuilder.Mesh.Triangle(algo=smeshBuilder.MG_CADSurf) or
  14 smeshBuilder.Mesh.Triangle(algo=smeshBuilder.BLSURF). This call
  15 creates an algorithm (if not yet exist), assigns it to the mesh and
  16 returns an instance of BLSURFPluginBuilder.BLSURF_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 2D mesh generation.
  21
  22 \anchor tui_blsurf
  23
  24 \anchor example_BLSURFPlugin
  25 <h2>Example of mesh generation with MG-CADSurf algorithm</h2>
  26 \tui_script{blsurfdemo.py}
  27
  28 \anchor tui_blsurf_periodicity_preCAD
  29 <h2>Example of periodicity definition with preCAD</h2>
  30 \tui_script{test_periodicity_precad.py}
  31
  32 */