Salome HOME
improve comments of MakeBoundaryMesh()
authoreap <eap@opencascade.com>
Sat, 5 Mar 2011 13:49:54 +0000 (13:49 +0000)
committereap <eap@opencascade.com>
Sat, 5 Mar 2011 13:49:54 +0000 (13:49 +0000)
src/SMESH_SWIG/smeshDC.py

index d8e94dbfa0895c14a60e21b459b55960011a499d..f32b4ab811914f3111bc9511310f2883a72a7265 100644 (file)
@@ -3082,15 +3082,18 @@ class Mesh:
     ## Creates missing boundary elements
     #  @param elements - elements whose boundary is to be checked:
     #                    mesh, group, sub-mesh or list of elements
     ## Creates missing boundary elements
     #  @param elements - elements whose boundary is to be checked:
     #                    mesh, group, sub-mesh or list of elements
+    #   if elements is mesh, it must be the mesh whose MakeBoundaryMesh() is called
     #  @param dimension - defines type of boundary elements to create:
     #                     SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D
     #  @param dimension - defines type of boundary elements to create:
     #                     SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D
+    #    SMESH.BND_1DFROM3D creates mesh edges on all borders of free facets of 3D cells
     #  @param groupName - a name of group to store created boundary elements in,
     #                     "" means not to create the group
     #  @param meshName - a name of new mesh to store created boundary elements in,
     #                     "" means not to create the new mesh
     #  @param groupName - a name of group to store created boundary elements in,
     #                     "" means not to create the group
     #  @param meshName - a name of new mesh to store created boundary elements in,
     #                     "" means not to create the new mesh
-    #  @param toCopyElements - if true, the checked elements will be copied into the new mesh
+    #  @param toCopyElements - if true, the checked elements will be copied into
+    #     the new mesh else only boundary elements will be copied into the new mesh
     #  @param toCopyExistingBondary - if true, not only new but also pre-existing
     #  @param toCopyExistingBondary - if true, not only new but also pre-existing
-    #                                boundary elements will be copied into the new mesh
+    #     boundary elements will be copied into the new mesh
     #  @return tuple (mesh, group) where bondary elements were added to
     #  @ingroup l2_modif_edit
     def MakeBoundaryMesh(self, elements, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",
     #  @return tuple (mesh, group) where bondary elements were added to
     #  @ingroup l2_modif_edit
     def MakeBoundaryMesh(self, elements, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="",