Salome HOME
Fix MinDistance for node-group (SALOME_TESTS/Grids/smesh/imps_09/K0)
[modules/smesh.git] / doc / salome / gui / SMESH / input / smeshpy_interface.rst
index 7094b659216fdde31853739bf676b33f0cf40646..a08cb2d0ab0207d03c82a4f8898815bba22873b4 100644 (file)
@@ -11,7 +11,7 @@ Documentation of SALOME Mesh module Python API is available in two forms:
 
 - :doc:`Structured documentation <modules>`, where all methods and classes are grouped by their functionality.
 
-- :ref:`Linear documentation <modindex>` grouped only by classes, declared in the :mod:`smeshBuilder` and :mod:`StdMeshersBuilder` Python packages.
+- :ref:`Linear documentation <modindex>` grouped only by classes, declared in the :mod:`smeshBuilder` Python module.
 
 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.
@@ -29,21 +29,18 @@ 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 )
+               smesh = smeshBuilder.New()
 
 #. Create a :class:`smeshBuilder.Mesh` object:
 
        .. code-block:: python
-               :linenos:
 
                mesh = smesh.Mesh( geometry )
 
 #. 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:
        .. code-block:: python
-               :linenos:
 
                regular1D = mesh.Segment()
                mefisto   = mesh.Triangle( smeshBuilder.MEFISTO )
@@ -52,16 +49,14 @@ A usual workflow to generate a mesh on geometry is following:
 
 #. Create and assign :ref:`hypotheses <about_hypo_page>` 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):
+#. :ref:`Compute the mesh <compute_anchor>` (generate mesh nodes and elements):
        .. code-block:: python
-               :linenos:
 
                mesh.Compute()
 
@@ -71,10 +66,10 @@ GUI and then to get a corresponding Python script via
 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.
+All methods of the :class:`Mesh Group <SMESH.SMESH_GroupBase>` 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.
+An example below demonstrates usage of the Python API for 3D mesh
+generation and for retrieving basic information on mesh nodes, elements and groups.
 
 .. _example_3d_mesh:
 
@@ -82,7 +77,6 @@ Example of 3d mesh generation:
 ##############################
 
 .. literalinclude:: ../../../examples/3dmesh.py
-    :linenos:
     :language: python
 
 :download:`Download this script <../../../examples/3dmesh.py>`
@@ -104,10 +98,6 @@ the following links:
    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: