- # @param name a name for the submesh
- # @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape
+ # @param name a name for the sub-mesh in the Object Browser
+ # @return an object of type SMESH.SMESH_subMesh, representing a part of mesh,
+ # which lies on the given shape
+ #
+ # The sub-mesh object gives access to the IDs of nodes and elements.
+ # The sub-mesh object has the following methods:
+ # - SMESH.SMESH_subMesh.GetNumberOfElements()
+ # - SMESH.SMESH_subMesh.GetNumberOfNodes( all )
+ # - SMESH.SMESH_subMesh.GetElementsId()
+ # - SMESH.SMESH_subMesh.GetElementsByType( ElementType )
+ # - SMESH.SMESH_subMesh.GetNodesId()
+ # - SMESH.SMESH_subMesh.GetSubShape()
+ # - SMESH.SMESH_subMesh.GetFather()
+ # - SMESH.SMESH_subMesh.GetId()
+ # @note A sub-mesh is implicitly created when a sub-shape is specified at
+ # creating an algorithm, for example: <code>algo1D = mesh.Segment(geom=Edge_1) </code>
+ # creates a sub-mesh on @c Edge_1 and assign Wire Discretization algorithm to it.
+ # The created sub-mesh can be retrieved from the algorithm:
+ # <code>submesh = algo1D.GetSubMesh()</code>