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