mirror of
https://git.salome-platform.org/gitpub/modules/smesh.git
synced 2025-01-13 10:10:33 +05:00
Improve documentation
This commit is contained in:
parent
7c7a9a15ee
commit
6200373964
@ -9,17 +9,17 @@ Documentation for SALOME %Mesh module Python API is available in two forms:
|
|||||||
- <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and
|
- <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and
|
||||||
classes are grouped by their functionality, like it is done in the GUI documentation
|
classes are grouped by their functionality, like it is done in the GUI documentation
|
||||||
- <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared
|
- <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared
|
||||||
in the \ref SMESH_SWIG.smeshBuilder "smeshBuilder" and \ref SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder" Python packages.
|
in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages.
|
||||||
|
|
||||||
Class \ref SMESH_SWIG.smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
|
Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
|
||||||
meshes. It can be used to create an empty mesh or to import mesh from the data file.
|
meshes. It can be used to create an empty mesh or to import mesh from the data file.
|
||||||
|
|
||||||
As soon as mesh is created, it is possible to manage it via its own
|
As soon as mesh is created, it is possible to manage it via its own
|
||||||
methods, described in \ref SMESH_SWIG.smeshBuilder.Mesh "class Mesh" documentation.
|
methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation.
|
||||||
|
|
||||||
Class \ref SMESH_SWIG.smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
|
Class \ref smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
|
||||||
Please note that some algorithms, included in the standard SALOME
|
Please note that some algorithms, included in the standard SALOME
|
||||||
distribution are always available. Python package \ref SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder"
|
distribution are always available. Python package \ref StdMeshersBuilder "StdMeshersBuilder"
|
||||||
provides an interface for standard meshing algorithms included into
|
provides an interface for standard meshing algorithms included into
|
||||||
the SALOME %Mesh module distribution, like:
|
the SALOME %Mesh module distribution, like:
|
||||||
- REGULAR (1D)
|
- REGULAR (1D)
|
||||||
|
Loading…
Reference in New Issue
Block a user