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

121 lines
3.8 KiB
ReStructuredText
Raw Normal View History

2017-12-08 19:09:48 +05:00
.. _smeshpy_interface_page:
****************
Python interface
****************
Python API of SALOME Mesh module defines several classes that can
be used for easy mesh creation and edition.
2018-05-25 22:04:48 +05:00
Documentation of SALOME Mesh module Python API is available in two forms:
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
- :doc:`Structured documentation <modules>`, where all methods and classes are grouped by their functionality.
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
- :ref:`Linear documentation <modindex>` grouped only by classes, declared in the :mod:`smeshBuilder` and :mod:`StdMeshersBuilder` Python packages.
2017-12-08 19:09:48 +05:00
With SALOME 7.2, the Python interface for Mesh has been slightly modified to offer new functionality.
You may have to modify your scripts generated with SALOME 6 or older versions.
Please see :ref:`smesh_migration_page`.
Class :class:`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.
As soon as a mesh is created, it is possible to manage it via its own
methods, described in class :class:`smeshBuilder.Mesh` documentation.
Class :class:`smeshstudytools.SMeshStudyTools` provides several methods to manipulate mesh objects in Salome study.
A usual workflow to generate a mesh on geometry is following:
#. Create an instance of :class:`smeshBuilder.smeshBuilder`:
.. code-block:: python
:linenos:
from salome.smesh import smeshBuilder
smesh = smeshBuilder.New( salome.myStudy )
#. Create a :class:`smeshBuilder.Mesh` object:
.. code-block:: python
:linenos:
mesh = smesh.Mesh( geometry )
2018-05-25 22:04:48 +05:00
#. Create and assign :ref:`algorithms <basic_meshing_algos_page>` by calling corresponding methods of the mesh. If a sub-shape is provided as an argument, a :ref:`sub-mesh <constructing_submeshes_page>` is implicitly created on this sub-shape:
2017-12-08 19:09:48 +05:00
.. code-block:: python
:linenos:
2018-05-25 22:04:48 +05:00
regular1D = mesh.Segment()
mefisto = mesh.Triangle( smeshBuilder.MEFISTO )
2017-12-08 19:09:48 +05:00
# use other triangle algorithm on a face -- a sub-mesh appears in the mesh
2018-05-25 22:04:48 +05:00
netgen = mesh.Triangle( smeshBuilder.NETGEN_1D2D, face )
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
#. Create and assign :ref:`hypotheses <about_hypo_page>` by calling corresponding methods of algorithms:
2017-12-08 19:09:48 +05:00
.. code-block:: python
:linenos:
2018-05-25 22:04:48 +05:00
segLen10 = regular1D.LocalLength( 10. )
maxArea = mefisto.LocalLength( 100. )
2017-12-08 19:09:48 +05:00
netgen.SetMaxSize( 20. )
netgen.SetFineness( smeshBuilder.VeryCoarse )
#. :ref:`compute_anchor` the mesh (generate mesh nodes and elements):
.. code-block:: python
:linenos:
2018-05-25 22:04:48 +05:00
mesh.Compute()
2017-12-08 19:09:48 +05:00
An easiest way to start with Python scripting is to do something in
GUI and then to get a corresponding Python script via
**File > Dump Study** menu item. Don't forget that you can get
all methods of any object in hand (e.g. a mesh group or a hypothesis)
by calling *dir()* Python built-in function.
All methods of the Mesh Group can be found in :ref:`tui_create_standalone_group` sample script.
An example below demonstrates usage of the Python API for 3d mesh
generation and for retrieving information on mesh nodes and elements.
.. _example_3d_mesh:
Example of 3d mesh generation:
##############################
.. literalinclude:: ../../../examples/3dmesh.py
:linenos:
:language: python
2018-05-25 22:04:48 +05:00
:download:`Download this script <../../../examples/3dmesh.py>`
2017-12-08 19:09:48 +05:00
Examples of Python scripts for Mesh operations are available by
the following links:
.. toctree::
2018-05-25 22:04:48 +05:00
:titlesonly:
tui_creating_meshes
tui_defining_hypotheses
tui_grouping_elements
tui_filters
tui_modifying_meshes
tui_transforming_meshes
tui_viewing_meshes
tui_quality_controls
tui_measurements
tui_work_on_objects_from_gui
tui_notebook_smesh
tui_cartesian_algo
tui_use_existing_faces
tui_prism_3d_algo
tui_generate_flat_elements
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. toctree::
:hidden:
smesh_migration.rst
smeshBuilder.rst
StdMeshersBuilder.rst
smeshstudytools.rst
modules.rst
smesh_module.rst