Salome HOME
PR: distributed geom and smesh scripts: first step
[modules/smesh.git] / src / SMESH_SWIG / StdMeshersDC.py
index da59111f3306ffed71ae64851202c1f2b47022ca..b032e204ca8323a7fa4863097a25646128a341fa 100644 (file)
@@ -21,8 +21,9 @@
 # @package StdMeshersDC
 # Python API for the standard meshing plug-in module.
 
-from smesh import Mesh_Algorithm, AssureGeomPublished, IsEqual, ParseParameters
-from smesh import GetName, TreatHypoStatus
+from smesh_algorithm import Mesh_Algorithm
+from smeshDC import AssureGeomPublished, IsEqual, ParseParameters
+from smeshDC import GetName, TreatHypoStatus
 from smeshDC import Mesh
 
 import StdMeshers
@@ -360,6 +361,9 @@ class StdMeshersDC_CompositeSegment(StdMeshersDC_Segment):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = False
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates segment 1D algorithm for edges"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -387,6 +391,9 @@ class StdMeshersDC_Segment_Python(Mesh_Algorithm):
     ## doc string of the method
     #  @internal
     docHelper  = "Creates tetrahedron 3D algorithm for solids"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates segment 1D algorithm for edges"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -430,6 +437,9 @@ class StdMeshersDC_Triangle_MEFISTO(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates triangle 2D algorithm for faces"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -480,6 +490,9 @@ class StdMeshersDC_Quadrangle(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates quadrangle 2D algorithm for faces"
     ## hypothesis associated with algorithm
     #  @internal
     params     = 0
@@ -596,6 +609,9 @@ class StdMeshersDC_Hexahedron(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates hexahedron 3D algorithm for volumes"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -625,6 +641,9 @@ class StdMeshersDC_Projection1D(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates projection 1D algorithm for edges"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -679,6 +698,9 @@ class StdMeshersDC_Projection2D(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates projection 2D algorithm for faces"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -735,6 +757,9 @@ class StdMeshersDC_Projection1D2D(StdMeshersDC_Projection2D):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = "Projection_1D2D"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates projection 1D-2D algorithm for edges and faces"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -759,6 +784,9 @@ class StdMeshersDC_Projection3D(Mesh_Algorithm):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = "Projection_3D"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates projection 3D algorithm for volumes"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -819,6 +847,9 @@ class StdMeshersDC_Prism3D(Mesh_Algorithm):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = "Prism_3D"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates prism 3D algorithm for volumes"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -952,7 +983,7 @@ class StdMeshersDC_Prism3D(Mesh_Algorithm):
 
     pass # end of StdMeshersDC_Prism3D class
 
-## Defines a Radial Quadrangle 1D2D algorithm
+## Defines a Radial Quadrangle 1D-2D algorithm
 # 
 #  It is created by calling smesh.Mesh.Quadrangle(smesh.RADIAL_QUAD,geom=0)
 #
@@ -965,6 +996,9 @@ class StdMeshersDC_RadialQuadrangle1D2D(Mesh_Algorithm):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = RADIAL_QUAD
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates quadrangle 1D-2D algorithm for triangular faces"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -1081,6 +1115,9 @@ class StdMeshersDC_UseExistingElements_1D(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates 1D algorithm for edges with reusing of existing mesh elements"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -1127,6 +1164,9 @@ class StdMeshersDC_UseExistingElements_1D2D(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates 1D-2D algorithm for edges/faces with reusing of existing mesh elements"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -1173,6 +1213,9 @@ class StdMeshersDC_Cartesian_3D(Mesh_Algorithm):
     #  of smesh.Mesh class
     #  @internal
     isDefault  = True
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates body fitting 3D algorithm for volumes"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -1240,6 +1283,9 @@ class StdMeshersDC_UseExisting_1D(Mesh_Algorithm):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = "UseExisting_1D"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates 1D algorithm for edges with reusing of existing mesh elements"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to
@@ -1265,6 +1311,9 @@ class StdMeshersDC_UseExisting_2D(Mesh_Algorithm):
     ## type of algorithm used with helper function in smesh.Mesh class
     #  @internal
     algoType   = "UseExisting_2D"
+    ## doc string of the method
+    #  @internal
+    docHelper  = "Creates 2D algorithm for faces with reusing of existing mesh elements"
 
     ## Private constructor.
     #  @param mesh parent mesh object algorithm is assigned to