.. _smeshpy_interface_page: **************** Python interface **************** Python API of SALOME Mesh module defines several classes that can be used for easy mesh creation and edition. Documentation of SALOME Mesh module Python API is available in two forms: - :doc:`Structured documentation `, where all methods and classes are grouped by their functionality. - :ref:`Linear documentation ` grouped only by classes, declared in the :mod:`smeshBuilder` and :mod:`StdMeshersBuilder` Python packages. 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() #. Create a :class:`smeshBuilder.Mesh` object: .. code-block:: python :linenos: mesh = smesh.Mesh( geometry ) #. Create and assign :ref:`algorithms ` by calling corresponding methods of the mesh. If a sub-shape is provided as an argument, a :ref:`sub-mesh ` is implicitly created on this sub-shape: .. code-block:: python :linenos: regular1D = mesh.Segment() mefisto = mesh.Triangle( smeshBuilder.MEFISTO ) # use other triangle algorithm on a face -- a sub-mesh appears in the mesh netgen = mesh.Triangle( smeshBuilder.NETGEN_1D2D, face ) #. Create and assign :ref:`hypotheses ` by calling corresponding methods of algorithms: .. code-block:: python :linenos: segLen10 = regular1D.LocalLength( 10. ) maxArea = mefisto.LocalLength( 100. ) netgen.SetMaxSize( 20. ) netgen.SetFineness( smeshBuilder.VeryCoarse ) #. :ref:`compute_anchor` the mesh (generate mesh nodes and elements): .. code-block:: python :linenos: mesh.Compute() 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 :download:`Download this script <../../../examples/3dmesh.py>` Examples of Python scripts for Mesh operations are available by the following links: .. toctree:: :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 .. toctree:: :hidden: smesh_migration.rst smeshBuilder.rst StdMeshersBuilder.rst smeshstudytools.rst modules.rst smesh_module.rst