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 \ref smesh_migration_page
  17
  18 The SMESH python package contains helper functions to manipulate mesh elements and
  19 interact with these elements.
  20
  21 Note that these functions either encapsulate the python programming interface of SMESH core
  22 (the CORBA or SWIG interface for example) or extend existing utilities as the smesh.py module.
  23
  24 The functions are distributed in the python package \b salome.smesh.
  25
  26 \note
  27 The main package \b salome contains other sub-packages that are distributed with the other
  28 SALOME modules. For example, the KERNEL module provides the python package \b salome.kernel
  29 and GEOM the package \b salome.geom.
  30
  31 Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
  32 meshes. It can be used to create an empty mesh or to import mesh from the data file.
  33
  34 Class \ref smeshstudytools.SMeshStudyTools "SMeshStudyTools" provides several methods to manipulate mesh objects in Salome study.
  35
  36 As soon as mesh is created, it is possible to manage it via its own
  37 methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation.
  38
  39 Class \ref smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
  40 Please note that some algorithms, included in the standard SALOME
  41 distribution are always available. Python package \ref StdMeshersBuilder "StdMeshersBuilder"
  42 provides an interface for standard meshing algorithms included into
  43 the SALOME %Mesh module distribution, like:
  44 - REGULAR (1D)
  45 - COMPOSITE (1D)
  46 - MEFISTO (2D)
  47 - Quadrangle (2D)
  48 - Hexa(3D)
  49 - etc ...
  50
  51 To add meshing hypotheses, it is possible to use the functions provided by the
  52 algorithms interfaces.
  53
  54 An example below demonstrates usage of the Python API for 3d mesh generation.
  55
  56 \anchor example_3d_mesh
  57 <h2>Example of 3d mesh generation:</h2>
  58 \tui_script{3dmesh.py}
  59
  60 Examples of Python scripts for Mesh operations are available by
  61 the following links:
  62
  63 - \subpage tui_creating_meshes_page
  64 - \subpage tui_cartesian_algo
  65 - \subpage tui_use_existing_faces
  66 - \subpage tui_viewing_meshes_page
  67 - \subpage tui_defining_hypotheses_page
  68 - \subpage tui_quality_controls_page
  69 - \subpage tui_filters_page
  70 - \subpage tui_grouping_elements_page
  71 - \subpage tui_modifying_meshes_page
  72 - \subpage tui_transforming_meshes_page
  73 - \subpage tui_notebook_smesh_page
  74 - \subpage tui_measurements_page
  75 - \subpage tui_generate_flat_elements_page
  76 - \subpage tui_work_on_objects_from_gui
  77 - \subpage tui_prism_3d_algo
  78
  79 */