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

   1 /*!
   2
   3 \page smeshpy_interface_page Python interface smesh.py
   4
   5 \n Python package smesh defines several classes, destined for easy and
   6 clear mesh creation and edition.
   7
   8 \n Documentation for smesh package is available in two forms:
   9
  10 \n The <a href="smeshpy_doc/modules.html"> structured
  11    documentation for smesh package</a>, where all methods and
  12    classes are grouped by their functionality, like it is done in the GUI documentation
  13 \n and the \ref smeshDC "linear documentation for smesh package"
  14    grouped only by classes, declared in the smesh.py file.
  15
  16 \n The main page of the \ref smeshDC "linear documentation for smesh package"
  17    contains a list of data structures and a list of
  18    functions, provided by the package smesh.py. The first item in
  19    the list of data structures (\ref smeshDC::smeshDC "class smesh")
  20    also represents documentation for the methods of the package smesh.py itself.
  21
  22 \n The package smesh.py provides an interface to create and handle
  23    meshes. Use it to create an empty mesh or to import it from the data file.
  24
  25 \n Once a mesh has been created, it is possible to  manage it via its own
  26    methods, described at \ref smeshDC::Mesh "class Mesh" documentation
  27    (it is also accessible by the second item "class Mesh" in the list of data structures).
  28
  29 \n Class Mesh allows assigning algorithms to a mesh.
  30 \n Please note, that some algorithms,
  31    included in the standard Salome installation are always available:
  32       - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
  33
  34 \n There are also some algorithms, which can be installed optionally,
  35 \n some of them are based on open-source meshers:
  36          - NETGEN(1D-2D,2D,1D-2D-3D,3D),
  37
  38 \n others are based on commercial meshers:
  39          - GHS3D(3D), BLSURF(2D).
  40
  41 \n    To add hypotheses, use the interfaces, provided by the assigned algorithms.
  42
  43 */