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 (see the \ref introduction_to_mesh_python_page "example").
   7
   8 \n Please draw your attention to the below notes before address to
   9 the \ref smeshDC "documentation for smesh.py"
  10
  11 \n 1. The main page of the \ref smeshDC "documentation for smesh.py"
  12       contains a list of data structures and a list of functions,
  13       provided by the package smesh.py. The first item in the data
  14       structures list (\ref smeshDC::smeshDC "class smesh") also
  15       represents documentation for methods of the package smesh.py itself.
  16
  17 \n 2. Package smesh.py gives interface to create and manage
  18       meshes. Please, use it to create an empty mesh or to import
  19       it from data file.
  20
  21 \n 3. Once you have created a mesh, you can manage it via its own
  22       methods. See \ref smeshDC::Mesh "class Mesh" documentation for
  23       them (it is also accessible by the second item "class Mesh" in the
  24       data structures list).
  25
  26 \n 4. Class Mesh allows to assign algorithms to a mesh.
  27 \n \t Please note, that there are always available some algorithms,
  28       included in standard Salome installation:
  29          - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
  30
  31 \n Also there are some algorithms, which can be installed optionally,
  32 \n some of them are based on open-source meshers:
  33          - NETGEN(1D-2D,2D,1D-2D-3D,3D),
  34
  35 \n others are based on commercial meshers:
  36          - GHS3D(3D).
  37
  38 \n \t To add hypotheses, please use interfaces, provided by the
  39       assigned algorithms.
  40
  41 */