doc/salome/gui/SMESH/input/smeshpy_interface.doc

   1 /*!
   2
   3 \page smeshpy_interface_page Python interface
   4
   5 Python API for SALOME %Mesh module defines several classes that can
   6 be used for easy mesh creation and edition.
   7
   8 Documentation for SALOME %Mesh module Python API is available in two forms:
   9 - <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and
  10 classes are grouped by their functionality, like it is done in the GUI documentation
  11 - <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared
  12 in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages.
  13
  14 \n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality,
  15 \n You may have to modify your scripts generated with SALOME 6 or older versions.
  16 \n Please see <li>\ref smesh_migration_page</li>
  17
  18 Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
  19 meshes. It can be used to create an empty mesh or to import mesh from the data file.
  20
  21 As soon as mesh is created, it is possible to manage it via its own
  22 methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation.
  23
  24 Class \ref smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
  25 Please note that some algorithms, included in the standard SALOME
  26 distribution are always available. Python package \ref StdMeshersBuilder "StdMeshersBuilder"
  27 provides an interface for standard meshing algorithms included into
  28 the SALOME %Mesh module distribution, like:
  29 - REGULAR (1D)
  30 - COMPOSITE (1D)
  31 - MEFISTO (2D)
  32 - Quadrangle (2D)
  33 - Hexa(3D)
  34 - etc ...
  35
  36 To add meshing hypotheses, it is possible to use the functions provided by the
  37 algorithms interfaces.
  38
  39 An example below demonstrates usage of the Python API for 3d mesh generation.
  40
  41 \anchor example_3d_mesh
  42 <h2>Example of 3d mesh generation:</h2>
  43 \tui_script{3dmesh.py}
  44
  45 Examples of Python scripts for Mesh operations are available by
  46 the following links:
  47
  48 - \subpage tui_creating_meshes_page
  49 - \subpage tui_cartesian_algo
  50 - \subpage tui_use_existing_faces
  51 - \subpage tui_viewing_meshes_page
  52 - \subpage tui_defining_hypotheses_page
  53 - \subpage tui_quality_controls_page
  54 - \subpage tui_filters_page
  55 - \subpage tui_grouping_elements_page
  56 - \subpage tui_modifying_meshes_page
  57 - \subpage tui_transforming_meshes_page
  58 - \subpage tui_notebook_smesh_page
  59 - \subpage tui_measurements_page
  60 - \subpage tui_generate_flat_elements_page
  61 - \subpage tui_work_on_objects_from_gui
  62 - \subpage tui_prism_3d_algo
  63
  64 */