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

61 lines
2.3 KiB
Plaintext
Raw Normal View History

/*!
2009-02-17 10:27:49 +05:00
\page smeshpy_interface_page Python interface
Python API for SALOME %Mesh module defines several classes that can
be used for easy mesh creation and edition.
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
2009-12-08 18:11:42 +05:00
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
2013-03-13 20:32:14 +06:00
in the \ref SMESH_SWIG.smeshBuilder "smeshBuilder" and \ref SMESH_SWIG.StdMeshersDC "StdMeshersDC" Python packages.
2009-12-08 18:11:42 +05:00
2013-03-13 20:32:14 +06:00
Class \ref SMESH_SWIG.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.
2009-12-08 18:11:42 +05:00
As soon as mesh is created, it is possible to manage it via its own
2013-03-13 20:32:14 +06:00
methods, described in \ref SMESH_SWIG.smeshBuilder.Mesh "class Mesh" documentation.
2009-12-08 18:11:42 +05:00
2013-03-13 20:32:14 +06:00
Class \ref SMESH_SWIG.smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
Please note that some algorithms, included in the standard SALOME
2013-03-13 20:32:14 +06:00
distribution are always available. Python package \ref SMESH_SWIG.StdMeshersDC "StdMeshersDC"
provides an interface for standard meshing algorithms included into
the SALOME %Mesh module distribution, like:
2009-12-08 18:11:42 +05:00
- REGULAR (1D)
- COMPOSITE (1D)
- MEFISTO (2D)
- Quadrangle (2D)
- Hexa(3D)
- etc ...
2009-12-08 18:11:42 +05:00
To add meshing hypotheses, it is possible to use the functions provided by the
algorithms interfaces.
2009-02-17 10:27:49 +05:00
An example below demonstrates usage of the Python API for 3d mesh generation.
2009-02-17 10:27:49 +05:00
2009-12-08 18:11:42 +05:00
\anchor example_3d_mesh
<h2>Example of 3d mesh generation:</h2>
\tui_script{3dmesh.py}
2009-02-17 10:27:49 +05:00
Examples of Python scripts for Mesh operations are available by
2009-12-08 18:11:42 +05:00
the following links:
2009-12-08 18:11:42 +05:00
- \subpage tui_creating_meshes_page
2011-12-05 17:03:04 +06:00
- \subpage tui_cartesian_algo
2012-11-23 19:38:39 +06:00
- \subpage tui_use_existing_faces
2009-12-08 18:11:42 +05:00
- \subpage tui_viewing_meshes_page
- \subpage tui_defining_hypotheses_page
- \subpage tui_quality_controls_page
2010-11-25 17:44:43 +05:00
- \subpage tui_filters_page
2009-12-08 18:11:42 +05:00
- \subpage tui_grouping_elements_page
- \subpage tui_modifying_meshes_page
- \subpage tui_transforming_meshes_page
- \subpage tui_notebook_smesh_page
2010-11-25 17:44:43 +05:00
- \subpage tui_measurements_page
- \subpage tui_generate_flat_elements_page
- \subpage tui_work_on_objects_from_gui
- \subpage tui_prism_3d_algo
*/