X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSMESH_SWIG%2FsmeshDC.py;h=218415f05030525808a8365bf4850d7758918ff3;hb=8a0f1ad782dbacb92972a3c1084f745744cbb368;hp=266473c88c5b4a287d78b885d8c7af29248530f8;hpb=79b1ac2b6df9117f16f11d444b1f165d477a1813;p=modules%2Fsmesh.git diff --git a/src/SMESH_SWIG/smeshDC.py b/src/SMESH_SWIG/smeshDC.py index 266473c88..218415f05 100644 --- a/src/SMESH_SWIG/smeshDC.py +++ b/src/SMESH_SWIG/smeshDC.py @@ -26,18 +26,71 @@ \brief Module smesh """ -## \package smeshDC -# To get started, please look at smeshDC::smeshDC documentation for general services of smesh package. -# You can find the smeshDC::smeshDC documentation also by the first -# item in the Data Structures list on this page. -# See also the list of Data Structures and the list of Functions -# for other classes and methods of smesh python interface. - +## @defgroup l1_auxiliary Auxiliary methods and structures +## @defgroup l1_creating Creating meshes +## @{ +## @defgroup l2_impexp Importing and exporting meshes +## @defgroup l2_construct Constructing meshes +## @defgroup l2_algorithms Defining Algorithms +## @{ +## @defgroup l3_algos_basic Basic meshing algorithms +## @defgroup l3_algos_proj Projection Algorithms +## @defgroup l3_algos_radialp Radial Prism +## @defgroup l3_algos_segmarv Segments around Vertex +## @defgroup l3_algos_3dextr 3D extrusion meshing algorithm + +## @} +## @defgroup l2_hypotheses Defining hypotheses +## @{ +## @defgroup l3_hypos_1dhyps 1D Meshing Hypotheses +## @defgroup l3_hypos_2dhyps 2D Meshing Hypotheses +## @defgroup l3_hypos_maxvol Max Element Volume hypothesis +## @defgroup l3_hypos_netgen Netgen 2D and 3D hypotheses +## @defgroup l3_hypos_ghs3dh GHS3D Parameters hypothesis +## @defgroup l3_hypos_blsurf BLSURF Parameters hypothesis +## @defgroup l3_hypos_hexotic Hexotic Parameters hypothesis +## @defgroup l3_hypos_additi Additional Hypotheses + +## @} +## @defgroup l2_submeshes Constructing submeshes +## @defgroup l2_compounds Building Compounds +## @defgroup l2_editing Editing Meshes + +## @} +## @defgroup l1_meshinfo Mesh Information +## @defgroup l1_controls Quality controls and Filtering +## @defgroup l1_grouping Grouping elements +## @{ +## @defgroup l2_grps_create Creating groups +## @defgroup l2_grps_edit Editing groups +## @defgroup l2_grps_operon Using operations on groups +## @defgroup l2_grps_delete Deleting Groups + +## @} +## @defgroup l1_modifying Modifying meshes +## @{ +## @defgroup l2_modif_add Adding nodes and elements +## @defgroup l2_modif_del Removing nodes and elements +## @defgroup l2_modif_edit Modifying nodes and elements +## @defgroup l2_modif_renumber Renumbering nodes and elements +## @defgroup l2_modif_trsf Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging) +## @defgroup l2_modif_movenode Moving nodes +## @defgroup l2_modif_throughp Mesh through point +## @defgroup l2_modif_invdiag Diagonal inversion of elements +## @defgroup l2_modif_unitetri Uniting triangles +## @defgroup l2_modif_changori Changing orientation of elements +## @defgroup l2_modif_cutquadr Cutting quadrangles +## @defgroup l2_modif_smooth Smoothing +## @defgroup l2_modif_extrurev Extrusion and Revolution +## @defgroup l2_modif_patterns Pattern mapping +## @defgroup l2_modif_tofromqu Convert to/from Quadratic Mesh + +## @} import salome import geompyDC -import SMESH # necessary for back compatibility +import SMESH # This is necessary for back compatibility from SMESH import * import StdMeshers @@ -52,7 +105,10 @@ except ImportError: noNETGENPlugin = 1 pass -# Types of algo +## @addtogroup l1_auxiliary +## @{ + +# Types of algorithms REGULAR = 1 PYTHON = 2 COMPOSITE = 3 @@ -78,13 +134,22 @@ PLANE = SMESH_MeshEditor.PLANE LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH -# Fineness enumeration(for NETGEN) +# Fineness enumeration (for NETGEN) VeryCoarse = 0 -Coarse = 1 -Moderate = 2 -Fine = 3 -VeryFine = 4 -Custom = 5 +Coarse = 1 +Moderate = 2 +Fine = 3 +VeryFine = 4 +Custom = 5 + +# Optimization level of GHS3D +None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization = 0,1,2,3 + +# Topology treatment way of BLSURF +FromCAD, PreProcess, PreProcessPlus = 0,1,2 + +# Element size flag of BLSURF +DefaultSize, DefaultGeom, Custom = 0,0,1 PrecisionConfusion = 1e-07 @@ -105,7 +170,7 @@ def GetName(obj): attr = sobj.FindAttribute("AttributeName")[1] return attr.Value() -## Sets name to object +## Sets a name to the object def SetName(obj, name): ior = salome.orb.object_to_string(obj) sobj = salome.myStudy.FindObjectIOR(ior) @@ -113,7 +178,7 @@ def SetName(obj, name): attr = sobj.FindAttribute("AttributeName")[1] attr.SetValue(name) -## Print error message if a hypothesis was not assigned. +## Prints error message if a hypothesis was not assigned. def TreatHypoStatus(status, hypName, geomName, isAlgo): if isAlgo: hypType = "algorithm" @@ -123,23 +188,25 @@ def TreatHypoStatus(status, hypName, geomName, isAlgo): if status == HYP_UNKNOWN_FATAL : reason = "for unknown reason" elif status == HYP_INCOMPATIBLE : - reason = "this hypothesis mismatches algorithm" + reason = "this hypothesis mismatches the algorithm" elif status == HYP_NOTCONFORM : - reason = "not conform mesh would be built" + reason = "a non-conform mesh would be built" elif status == HYP_ALREADY_EXIST : - reason = hypType + " of the same dimension already assigned to this shape" + reason = hypType + " of the same dimension is already assigned to this shape" elif status == HYP_BAD_DIM : - reason = hypType + " mismatches shape" + reason = hypType + " mismatches the shape" elif status == HYP_CONCURENT : reason = "there are concurrent hypotheses on sub-shapes" elif status == HYP_BAD_SUBSHAPE : - reason = "shape is neither the main one, nor its subshape, nor a valid group" + reason = "the shape is neither the main one, nor its subshape, nor a valid group" elif status == HYP_BAD_GEOMETRY: - reason = "geometry mismatches algorithm's expectation" + reason = "geometry mismatches the expectation of the algorithm" elif status == HYP_HIDDEN_ALGO: - reason = "it is hidden by an algorithm of upper dimension generating all-dimensions elements" + reason = "it is hidden by an algorithm of an upper dimension, which generates elements of all dimensions" elif status == HYP_HIDING_ALGO: - reason = "it hides algorithm(s) of lower dimension by generating all-dimensions elements" + reason = "it hides algorithms of lower dimensions by generating elements of all dimensions" + elif status == HYP_NEED_SHAPE: + reason = "Algorithm can't work without shape" else: return hypName = '"' + hypName + '"' @@ -150,43 +217,51 @@ def TreatHypoStatus(status, hypName, geomName, isAlgo): print hypName, "was not assigned to",geomName,":", reason pass -## Methods of package smesh.py: general services of MESH component. -# -# This class has been designed to provide general services of the MESH component. -# All methods of this class are accessible directly from the smesh.py package. -# Use these methods to create an empty mesh, to import mesh from a file, -# and also to create patterns and filtering criteria. +## Converts an angle from degrees to radians +def DegreesToRadians(AngleInDegrees): + from math import pi + return AngleInDegrees * pi / 180.0 + +# end of l1_auxiliary +## @} + +# All methods of this class are accessible directly from the smesh.py package. class smeshDC(SMESH._objref_SMESH_Gen): - ## To set current study and Geometry component + ## Sets the current study and Geometry component + # @ingroup l1_auxiliary def init_smesh(self,theStudy,geompyD): self.geompyD=geompyD self.SetGeomEngine(geompyD) self.SetCurrentStudy(theStudy) - ## Create an empty Mesh. This mesh can have underlying geometry. - # @param obj Geometrical object to build the mesh on. If not defined, - # the mesh will not have underlying geometry. - # @param name A name for the new mesh. - # @return instance of Mesh class. + ## Creates an empty Mesh. This mesh can have an underlying geometry. + # @param obj the Geometrical object on which the mesh is built. If not defined, + # the mesh will have no underlying geometry. + # @param name the name for the new mesh. + # @return an instance of Mesh class. + # @ingroup l2_construct def Mesh(self, obj=0, name=0): return Mesh(self,self.geompyD,obj,name) - ## Returns long value from enumeration - # To be used for SMESH.FunctorType enumeration + ## Returns a long value from enumeration + # Should be used for SMESH.FunctorType enumeration + # @ingroup l1_controls def EnumToLong(self,theItem): return theItem._v - ## Get PointStruct from vertex - # @param theVertex is GEOM object(vertex) + ## Gets PointStruct from vertex + # @param theVertex a GEOM object(vertex) # @return SMESH.PointStruct + # @ingroup l1_auxiliary def GetPointStruct(self,theVertex): [x, y, z] = self.geompyD.PointCoordinates(theVertex) return PointStruct(x,y,z) - ## Get DirStruct from vector - # @param theVector is GEOM object(vector) + ## Gets DirStruct from vector + # @param theVector a GEOM object(vector) # @return SMESH.DirStruct + # @ingroup l1_auxiliary def GetDirStruct(self,theVector): vertices = self.geompyD.SubShapeAll( theVector, geompyDC.ShapeType["VERTEX"] ) if(len(vertices) != 2): @@ -198,16 +273,18 @@ class smeshDC(SMESH._objref_SMESH_Gen): dirst = DirStruct(pnt) return dirst - ## Make DirStruct from a triplet - # @param x,y,z are vector components + ## Makes DirStruct from a triplet + # @param x,y,z vector components # @return SMESH.DirStruct + # @ingroup l1_auxiliary def MakeDirStruct(self,x,y,z): pnt = PointStruct(x,y,z) return DirStruct(pnt) ## Get AxisStruct from object - # @param theObj is GEOM object(line or plane) + # @param theObj a GEOM object (line or plane) # @return SMESH.AxisStruct + # @ingroup l1_auxiliary def GetAxisStruct(self,theObj): edges = self.geompyD.SubShapeAll( theObj, geompyDC.ShapeType["EDGE"] ) if len(edges) > 1: @@ -233,35 +310,41 @@ class smeshDC(SMESH._objref_SMESH_Gen): # From SMESH_Gen interface: # ------------------------ - ## Set the current mode + ## Sets the current mode + # @ingroup l1_auxiliary def SetEmbeddedMode( self,theMode ): #self.SetEmbeddedMode(theMode) SMESH._objref_SMESH_Gen.SetEmbeddedMode(self,theMode) - ## Get the current mode + ## Gets the current mode + # @ingroup l1_auxiliary def IsEmbeddedMode(self): #return self.IsEmbeddedMode() return SMESH._objref_SMESH_Gen.IsEmbeddedMode(self) - ## Set the current study + ## Sets the current study + # @ingroup l1_auxiliary def SetCurrentStudy( self, theStudy ): #self.SetCurrentStudy(theStudy) SMESH._objref_SMESH_Gen.SetCurrentStudy(self,theStudy) - ## Get the current study + ## Gets the current study + # @ingroup l1_auxiliary def GetCurrentStudy(self): #return self.GetCurrentStudy() return SMESH._objref_SMESH_Gen.GetCurrentStudy(self) - ## Create Mesh object importing data from given UNV file + ## Creates a Mesh object importing data from the given UNV file # @return an instance of Mesh class + # @ingroup l2_impexp def CreateMeshesFromUNV( self,theFileName ): aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromUNV(self,theFileName) aMesh = Mesh(self, self.geompyD, aSmeshMesh) return aMesh - ## Create Mesh object(s) importing data from given MED file + ## Creates a Mesh object(s) importing data from the given MED file # @return a list of Mesh class instances + # @ingroup l2_impexp def CreateMeshesFromMED( self,theFileName ): aSmeshMeshes, aStatus = SMESH._objref_SMESH_Gen.CreateMeshesFromMED(self,theFileName) aMeshes = [] @@ -270,20 +353,25 @@ class smeshDC(SMESH._objref_SMESH_Gen): aMeshes.append(aMesh) return aMeshes, aStatus - ## Create Mesh object importing data from given STL file + ## Creates a Mesh object importing data from the given STL file # @return an instance of Mesh class + # @ingroup l2_impexp def CreateMeshesFromSTL( self, theFileName ): aSmeshMesh = SMESH._objref_SMESH_Gen.CreateMeshesFromSTL(self,theFileName) aMesh = Mesh(self, self.geompyD, aSmeshMesh) return aMesh ## From SMESH_Gen interface - # @return list of integer values + # @return the list of integer values + # @ingroup l1_auxiliary def GetSubShapesId( self, theMainObject, theListOfSubObjects ): return SMESH._objref_SMESH_Gen.GetSubShapesId(self,theMainObject, theListOfSubObjects) - ## From SMESH_Gen interface. Creates pattern - # @return an instance of SMESH_Pattern + ## From SMESH_Gen interface. Creates a pattern + # @return an instance of SMESH_Pattern + # + # Example of Patterns usage + # @ingroup l2_modif_patterns def GetPattern(self): return SMESH._objref_SMESH_Gen.GetPattern(self) @@ -293,6 +381,7 @@ class smeshDC(SMESH._objref_SMESH_Gen): ## Creates an empty criterion # @return SMESH.Filter.Criterion + # @ingroup l1_controls def GetEmptyCriterion(self): Type = self.EnumToLong(FT_Undefined) Compare = self.EnumToLong(FT_Undefined) @@ -307,15 +396,16 @@ class smeshDC(SMESH._objref_SMESH_Gen): return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID, UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision) - ## Creates a criterion by given parameters - # @param elementType is the type of elements(NODE, EDGE, FACE, VOLUME) - # @param CritType is type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. ) - # @param Compare belong to {FT_LessThan, FT_MoreThan, FT_EqualTo} - # @param Treshold is threshold value (range of ids as string, shape, numeric) - # @param UnaryOp is FT_LogicalNOT or FT_Undefined - # @param BinaryOp is binary logical operation FT_LogicalAND, FT_LogicalOR or - # FT_Undefined(must be for the last criterion in criteria) + ## Creates a criterion by the given parameters + # @param elementType the type of elements(NODE, EDGE, FACE, VOLUME) + # @param CritType the type of criterion (FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc.) + # @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo} + # @param Treshold the threshold value (range of ids as string, shape, numeric) + # @param UnaryOp FT_LogicalNOT or FT_Undefined + # @param BinaryOp a binary logical operation FT_LogicalAND, FT_LogicalOR or + # FT_Undefined (must be for the last criterion of all criteria) # @return SMESH.Filter.Criterion + # @ingroup l1_controls def GetCriterion(self,elementType, CritType, Compare = FT_EqualTo, @@ -342,22 +432,22 @@ class smeshDC(SMESH._objref_SMESH_Gen): if CritType in [FT_BelongToGeom, FT_BelongToPlane, FT_BelongToGenSurface, FT_BelongToCylinder, FT_LyingOnGeom]: - # Check treshold + # Checks the treshold if isinstance(aTreshold, geompyDC.GEOM._objref_GEOM_Object): aCriterion.ThresholdStr = GetName(aTreshold) aCriterion.ThresholdID = salome.ObjectToID(aTreshold) else: - print "Error: Treshold should be a shape." + print "Error: The treshold should be a shape." return None elif CritType == FT_RangeOfIds: - # Check treshold + # Checks the treshold if isinstance(aTreshold, str): aCriterion.ThresholdStr = aTreshold else: - print "Error: Treshold should be a string." + print "Error: The treshold should be a string." return None elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_BadOrientedVolume]: - # Here we do not need treshold + # At this point the treshold is unnecessary if aTreshold == FT_LogicalNOT: aCriterion.UnaryOp = self.EnumToLong(FT_LogicalNOT) elif aTreshold in [FT_LogicalAND, FT_LogicalOR]: @@ -368,7 +458,7 @@ class smeshDC(SMESH._objref_SMESH_Gen): aTreshold = float(aTreshold) aCriterion.Threshold = aTreshold except: - print "Error: Treshold should be a number." + print "Error: The treshold should be a number." return None if Treshold == FT_LogicalNOT or UnaryOp == FT_LogicalNOT: @@ -385,13 +475,14 @@ class smeshDC(SMESH._objref_SMESH_Gen): return aCriterion - ## Creates filter by given parameters of criterion - # @param elementType is the type of elements in the group - # @param CritType is type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. ) - # @param Compare belong to {FT_LessThan, FT_MoreThan, FT_EqualTo} - # @param Treshold is threshold value (range of id ids as string, shape, numeric) - # @param UnaryOp is FT_LogicalNOT or FT_Undefined + ## Creates a filter with the given parameters + # @param elementType the type of elements in the group + # @param CritType the type of criterion ( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. ) + # @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo} + # @param Treshold the threshold value (range of id ids as string, shape, numeric) + # @param UnaryOp FT_LogicalNOT or FT_Undefined # @return SMESH_Filter + # @ingroup l1_controls def GetFilter(self,elementType, CritType=FT_Undefined, Compare=FT_EqualTo, @@ -405,9 +496,10 @@ class smeshDC(SMESH._objref_SMESH_Gen): aFilter.SetCriteria(aCriteria) return aFilter - ## Creates numerical functor by its type - # @param theCrierion is FT_...; functor type + ## Creates a numerical functor by its type + # @param theCriterion FT_...; functor type # @return SMESH_NumericalFunctor + # @ingroup l1_controls def GetFunctor(self,theCriterion): aFilterMgr = self.CreateFilterManager() if theCriterion == FT_AspectRatio: @@ -437,20 +529,19 @@ class smeshDC(SMESH._objref_SMESH_Gen): else: print "Error: given parameter is not numerucal functor type." + import omniORB -#Register the new proxy for SMESH_Gen +#Registering the new proxy for SMESH_Gen omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshDC) # Public class: Mesh # ================== -## Class to define a mesh -# -# This class allows to define and manage a mesh. -# It has a set of methods to build a mesh on the given geometry, including definition of sub-meshes. -# Also it has methods to define groups of mesh elements, to modify a mesh (by addition of -# new nodes and elements and by changind of existing entities), to take information +## This class allows defining and managing a mesh. +# It has a set of methods to build a mesh on the given geometry, including the definition of sub-meshes. +# It also has methods to define groups of mesh elements, to modify a mesh (by addition of +# new nodes and elements and by changing the existing entities), to get information # about a mesh and to export a mesh into different formats. class Mesh: @@ -460,10 +551,13 @@ class Mesh: ## Constructor # - # Creates mesh on the shape \a obj (or the empty mesh if obj is equal to 0), - # sets GUI name of this mesh to \a name. + # Creates a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and + # sets the GUI name of this mesh to \a name. + # @param smeshpyD an instance of smeshDC class + # @param geompyD an instance of geompyDC class # @param obj Shape to be meshed or SMESH_Mesh object # @param name Study name of the mesh + # @ingroup l2_construct def __init__(self, smeshpyD, geompyD, obj=0, name=0): self.smeshpyD=smeshpyD self.geompyD=geompyD @@ -482,72 +576,87 @@ class Mesh: elif obj != 0: SetName(self.mesh, GetName(obj)) + if not self.geom: + self.geom = self.mesh.GetShapeToMesh() + self.editor = self.mesh.GetMeshEditor() - ## Method that inits the Mesh object from instance of SMESH_Mesh interface - # @param theMesh is SMESH_Mesh object + ## Initializes the Mesh object from an instance of SMESH_Mesh interface + # @param theMesh a SMESH_Mesh object + # @ingroup l2_construct def SetMesh(self, theMesh): self.mesh = theMesh self.geom = self.mesh.GetShapeToMesh() - ## Method that returns the mesh, that is instance of SMESH_Mesh interface - # @return SMESH_Mesh object + ## Returns the mesh, that is an instance of SMESH_Mesh interface + # @return a SMESH_Mesh object + # @ingroup l2_construct def GetMesh(self): return self.mesh - ## Get mesh name - # @return name of the mesh as a string + ## Gets the name of the mesh + # @return the name of the mesh as a string + # @ingroup l2_construct def GetName(self): name = GetName(self.GetMesh()) return name - ## Set name to mesh - # @param name a new name for the mesh + ## Sets a name to the mesh + # @param name a new name of the mesh + # @ingroup l2_construct def SetName(self, name): SetName(self.GetMesh(), name) - ## Get the subMesh object associated to \a theSubObject geometrical object. - # The subMesh object gives access to nodes and elements IDs. - # @param theSubObject A geometrical object (shape) - # @return object of type SMESH_SubMesh, representing part of mesh, which lays on the given shape - def GetSubMesh(self, theSubObject, name): - submesh = self.mesh.GetSubMesh(theSubObject, name) + ## Gets the subMesh object associated to a \a theSubObject geometrical object. + # The subMesh object gives access to the IDs of nodes and elements. + # @param theSubObject a geometrical object (shape) + # @param theName a name for the submesh + # @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape + # @ingroup l2_submeshes + def GetSubMesh(self, theSubObject, theName): + submesh = self.mesh.GetSubMesh(theSubObject, theName) return submesh - ## Method that returns the shape associated to the mesh - # @return GEOM_Object + ## Returns the shape associated to the mesh + # @return a GEOM_Object + # @ingroup l2_construct def GetShape(self): return self.geom - ## Method that associates given shape to the mesh(entails the mesh recreation) - # @param geom shape to be meshed (GEOM_Object) + ## Associates the given shape to the mesh (entails the recreation of the mesh) + # @param geom the shape to be meshed (GEOM_Object) + # @ingroup l2_construct def SetShape(self, geom): self.mesh = self.smeshpyD.CreateMesh(geom) - ## Return true if hypotheses are defined well - # @param theSubObject subshape of a mesh shape + ## Returns true if the hypotheses are defined well + # @param theSubObject a subshape of a mesh shape # @return True or False + # @ingroup l2_construct def IsReadyToCompute(self, theSubObject): return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject) - ## Return errors of hypotheses definition. - # Errors list is empty if everything is OK. - # @param theSubObject subshape of a mesh shape + ## Returns errors of hypotheses definition. + # The list of errors is empty if everything is OK. + # @param theSubObject a subshape of a mesh shape # @return a list of errors + # @ingroup l2_construct def GetAlgoState(self, theSubObject): return self.smeshpyD.GetAlgoState(self.mesh, theSubObject) - ## Return geometrical object the given element is built on. + ## Returns a geometrical object on which the given element was built. # The returned geometrical object, if not nil, is either found in the - # study or is published by this method with the given name - # @param theElementID an id of the mesh element - # @param theGeomName user defined name of geometrical object + # study or published by this method with the given name + # @param theElementID the id of the mesh element + # @param theGeomName the user-defined name of the geometrical object # @return GEOM::GEOM_Object instance + # @ingroup l2_construct def GetGeometryByMeshElement(self, theElementID, theGeomName): return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName ) - ## Returns mesh dimension depending on that of the underlying shape + ## Returns the mesh dimension depending on the dimension of the underlying shape # @return mesh dimension as an integer value [0,3] + # @ingroup l1_auxiliary def MeshDimension(self): shells = self.geompyD.SubShapeAllIDs( self.geom, geompyDC.ShapeType["SHELL"] ) if len( shells ) > 0 : @@ -563,13 +672,14 @@ class Mesh: ## Creates a segment discretization 1D algorithm. # If the optional \a algo parameter is not set, this algorithm is REGULAR. # \n If the optional \a geom parameter is not set, this algorithm is global. - # Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param algo type of desired algorithm. Possible values are: + # Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param algo the type of the required algorithm. Possible values are: # - smesh.REGULAR, - # - smesh.PYTHON for discretization via python function, + # - smesh.PYTHON for discretization via a python function, # - smesh.COMPOSITE for meshing a set of edges on one face side as a whole. - # @param geom If defined, subshape to be meshed - # @return instance of Mesh_Segment or Mesh_Segment_Python, or Mesh_CompositeSegment class + # @param geom If defined is the subshape to be meshed + # @return an instance of Mesh_Segment or Mesh_Segment_Python, or Mesh_CompositeSegment class + # @ingroup l3_algos_basic def Segment(self, algo=REGULAR, geom=0): ## if Segment(geom) is called by mistake if isinstance( algo, geompyDC.GEOM._objref_GEOM_Object): @@ -585,34 +695,37 @@ class Mesh: else: return Mesh_Segment(self, geom) - ## Enable creation of nodes and segments usable by 2D algoritms. - # Added nodes and segments must be bound to edges and vertices by + ## Enables creation of nodes and segments usable by 2D algoritms. + # The added nodes and segments must be bound to edges and vertices by # SetNodeOnVertex(), SetNodeOnEdge() and SetMeshElementOnShape() - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom subshape to be manually meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom the subshape to be manually meshed # @return StdMeshers_UseExisting_1D algorithm that generates nothing + # @ingroup l3_algos_basic def UseExistingSegments(self, geom=0): algo = Mesh_UseExisting(1,self,geom) return algo.GetAlgorithm() - ## Enable creation of nodes and faces usable by 3D algoritms. - # Added nodes and faces must be bound to geom faces by SetNodeOnFace() + ## Enables creation of nodes and faces usable by 3D algoritms. + # The added nodes and faces must be bound to geom faces by SetNodeOnFace() # and SetMeshElementOnShape() - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom subshape to be manually meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom the subshape to be manually meshed # @return StdMeshers_UseExisting_2D algorithm that generates nothing + # @ingroup l3_algos_basic def UseExistingFaces(self, geom=0): algo = Mesh_UseExisting(2,self,geom) return algo.GetAlgorithm() ## Creates a triangle 2D algorithm for faces. - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. # @param algo values are: smesh.MEFISTO || smesh.NETGEN_1D2D || smesh.NETGEN_2D || smesh.BLSURF - # @param geom If defined, subshape to be meshed (GEOM_Object) + # @param geom If defined, the subshape to be meshed (GEOM_Object) # @return an instance of Mesh_Triangle algorithm + # @ingroup l3_algos_basic def Triangle(self, algo=MEFISTO, geom=0): ## if Triangle(geom) is called by mistake if (isinstance(algo, geompyDC.GEOM._objref_GEOM_Object)): @@ -622,20 +735,22 @@ class Mesh: return Mesh_Triangle(self, algo, geom) ## Creates a quadrangle 2D algorithm for faces. - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom If defined, subshape to be meshed (GEOM_Object) + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom If defined, the subshape to be meshed (GEOM_Object) # @return an instance of Mesh_Quadrangle algorithm + # @ingroup l3_algos_basic def Quadrangle(self, geom=0): return Mesh_Quadrangle(self, geom) ## Creates a tetrahedron 3D algorithm for solids. - # The parameter \a algo permits to choice the algorithm: NETGEN or GHS3D - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. + # The parameter \a algo permits to choose the algorithm: NETGEN or GHS3D + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. # @param algo values are: smesh.NETGEN, smesh.GHS3D, smesh.FULL_NETGEN - # @param geom If defined, subshape to be meshed (GEOM_Object) + # @param geom If defined, the subshape to be meshed (GEOM_Object) # @return an instance of Mesh_Tetrahedron algorithm + # @ingroup l3_algos_basic def Tetrahedron(self, algo=NETGEN, geom=0): ## if Tetrahedron(geom) is called by mistake if ( isinstance( algo, geompyDC.GEOM._objref_GEOM_Object)): @@ -645,11 +760,12 @@ class Mesh: return Mesh_Tetrahedron(self, algo, geom) ## Creates a hexahedron 3D algorithm for solids. - # If the optional \a geom parameter is not sets, this algorithm is global. - # \n Otherwise, this algorithm define a submesh based on \a geom subshape. + # If the optional \a geom parameter is not set, this algorithm is global. + # \n Otherwise, this algorithm defines a submesh based on \a geom subshape. # @param algo possible values are: smesh.Hexa, smesh.Hexotic - # @param geom If defined, subshape to be meshed (GEOM_Object) + # @param geom If defined, the subshape to be meshed (GEOM_Object) # @return an instance of Mesh_Hexahedron algorithm + # @ingroup l3_algos_basic def Hexahedron(self, algo=Hexa, geom=0): ## if Hexahedron(geom, algo) or Hexahedron(geom) is called by mistake if ( isinstance(algo, geompyDC.GEOM._objref_GEOM_Object) ): @@ -657,40 +773,45 @@ class Mesh: elif geom == 0: algo, geom = Hexa, algo return Mesh_Hexahedron(self, algo, geom) - ## Deprecated, only for compatibility! + ## Deprecated, used only for compatibility! # @return an instance of Mesh_Netgen algorithm + # @ingroup l3_algos_basic def Netgen(self, is3D, geom=0): return Mesh_Netgen(self, is3D, geom) ## Creates a projection 1D algorithm for edges. - # If the optional \a geom parameter is not sets, this algorithm is global. - # Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom If defined, subshape to be meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom If defined, the subshape to be meshed # @return an instance of Mesh_Projection1D algorithm + # @ingroup l3_algos_proj def Projection1D(self, geom=0): return Mesh_Projection1D(self, geom) ## Creates a projection 2D algorithm for faces. - # If the optional \a geom parameter is not sets, this algorithm is global. - # Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom If defined, subshape to be meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom If defined, the subshape to be meshed # @return an instance of Mesh_Projection2D algorithm + # @ingroup l3_algos_proj def Projection2D(self, geom=0): return Mesh_Projection2D(self, geom) ## Creates a projection 3D algorithm for solids. - # If the optional \a geom parameter is not sets, this algorithm is global. - # Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom If defined, subshape to be meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom If defined, the subshape to be meshed # @return an instance of Mesh_Projection3D algorithm + # @ingroup l3_algos_proj def Projection3D(self, geom=0): return Mesh_Projection3D(self, geom) ## Creates a 3D extrusion (Prism 3D) or RadialPrism 3D algorithm for solids. - # If the optional \a geom parameter is not sets, this algorithm is global. - # Otherwise, this algorithm define a submesh based on \a geom subshape. - # @param geom If defined, subshape to be meshed + # If the optional \a geom parameter is not set, this algorithm is global. + # Otherwise, this algorithm defines a submesh based on \a geom subshape. + # @param geom If defined, the subshape to be meshed # @return an instance of Mesh_Prism3D or Mesh_RadialPrism3D algorithm + # @ingroup l3_algos_radialp l3_algos_3dextr def Prism(self, geom=0): shape = geom if shape==0: @@ -701,13 +822,13 @@ class Mesh: return Mesh_Prism3D(self, geom) return Mesh_RadialPrism3D(self, geom) - ## Compute the mesh and return the status of the computation + ## Computes the mesh and returns the status of the computation # @return True or False + # @ingroup l2_construct def Compute(self, geom=0): if geom == 0 or not isinstance(geom, geompyDC.GEOM._objref_GEOM_Object): if self.geom == 0: - print "Compute impossible: mesh is not constructed on geom shape." - return 0 + geom = self.mesh.GetShapeToMesh() else: geom = self.geom ok = False @@ -720,7 +841,7 @@ class Mesh: import traceback print "Mesh computation failed, exception caught:" traceback.print_exc() - if not ok: + if True:#not ok: errors = self.smeshpyD.GetAlgoState( self.mesh, geom ) allReasons = "" for err in errors: @@ -742,8 +863,8 @@ class Mesh: reason = ('Hypothesis of %s %sD algorithm "%s" has a bad parameter value' % ( glob, dim, name )) elif err.state == HYP_BAD_GEOMETRY: - reason = ('%s %sD algorithm "%s" is assigned to geometry mismatching' - 'its expectation' % ( glob, dim, name )) + reason = ('%s %sD algorithm "%s" is assigned to mismatching' + 'geometry' % ( glob, dim, name )) else: reason = "For unknown reason."+\ " Revise Mesh.Compute() implementation in smeshDC.py!" @@ -756,7 +877,8 @@ class Mesh: if allReasons != "": print '"' + GetName(self.mesh) + '"',"has not been computed:" print allReasons - else: + ok = False + elif not ok: print '"' + GetName(self.mesh) + '"',"has not been computed." pass pass @@ -768,9 +890,20 @@ class Mesh: pass return ok - ## Compute tetrahedral mesh using AutomaticLength + MEFISTO + NETGEN - # The parameter \a fineness [0,-1] defines mesh fineness + ## Removes all nodes and elements + # @ingroup l2_construct + def Clear(self): + self.mesh.Clear() + if salome.sg.hasDesktop(): + smeshgui = salome.ImportComponentGUI("SMESH") + smeshgui.Init(salome.myStudyId) + smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True ) + salome.sg.updateObjBrowser(1) + + ## Computes a tetrahedral mesh using AutomaticLength + MEFISTO + NETGEN + # @param fineness [0,-1] defines mesh fineness # @return True or False + # @ingroup l3_algos_basic def AutomaticTetrahedralization(self, fineness=0): dim = self.MeshDimension() # assign hypotheses @@ -784,12 +917,13 @@ class Mesh: pass return self.Compute() - ## Compute hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron - # The parameter \a fineness [0,-1] defines mesh fineness + ## Computes an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron + # @param fineness [0,-1] defines mesh fineness # @return True or False + # @ingroup l3_algos_basic def AutomaticHexahedralization(self, fineness=0): dim = self.MeshDimension() - # assign hypotheses + # assign the hypotheses self.RemoveGlobalHypotheses() self.Segment().AutomaticLength(fineness) if dim > 1 : @@ -800,26 +934,30 @@ class Mesh: pass return self.Compute() - ## Assign hypothesis - # @param hyp is a hypothesis to assign - # @param geom is subhape of mesh geometry + ## Assigns a hypothesis + # @param hyp a hypothesis to assign + # @param geom a subhape of mesh geometry # @return SMESH.Hypothesis_Status + # @ingroup l2_hypotheses def AddHypothesis(self, hyp, geom=0): if isinstance( hyp, Mesh_Algorithm ): hyp = hyp.GetAlgorithm() pass if not geom: geom = self.geom + if not geom: + geom = self.mesh.GetShapeToMesh() pass status = self.mesh.AddHypothesis(geom, hyp) isAlgo = hyp._narrow( SMESH_Algo ) TreatHypoStatus( status, GetName( hyp ), GetName( geom ), isAlgo ) return status - ## Unassign hypothesis - # @param hyp is a hypothesis to unassign - # @param geom is subhape of mesh geometry + ## Unassigns a hypothesis + # @param hyp a hypothesis to unassign + # @param geom a subshape of mesh geometry # @return SMESH.Hypothesis_Status + # @ingroup l2_hypotheses def RemoveHypothesis(self, hyp, geom=0): if isinstance( hyp, Mesh_Algorithm ): hyp = hyp.GetAlgorithm() @@ -830,13 +968,15 @@ class Mesh: status = self.mesh.RemoveHypothesis(geom, hyp) return status - ## Get the list of hypothesis added on a geom - # @param geom is subhape of mesh geometry - # @return sequence of SMESH_Hypothesis + ## Gets the list of hypotheses added on a geometry + # @param geom a subshape of mesh geometry + # @return the sequence of SMESH_Hypothesis + # @ingroup l2_hypotheses def GetHypothesisList(self, geom): return self.mesh.GetHypothesisList( geom ) ## Removes all global hypotheses + # @ingroup l2_hypotheses def RemoveGlobalHypotheses(self): current_hyps = self.mesh.GetHypothesisList( self.geom ) for hyp in current_hyps: @@ -844,45 +984,51 @@ class Mesh: pass pass - ## Create a mesh group based on geometric object \a grp - # and give a \a name, \n if this parameter is not defined + ## Creates a mesh group based on the geometric object \a grp + # and gives a \a name, \n if this parameter is not defined # the name is the same as the geometric group name \n # Note: Works like GroupOnGeom(). - # @param grp is a geometric group, a vertex, an edge, a face or a solid - # @param name is the name of the mesh group + # @param grp a geometric group, a vertex, an edge, a face or a solid + # @param name the name of the mesh group # @return SMESH_GroupOnGeom + # @ingroup l2_grps_create def Group(self, grp, name=""): return self.GroupOnGeom(grp, name) - ## Deprecated, only for compatibility! Please, use ExportMED() method instead. - # Export the mesh in a file with the MED format and choice the \a version of MED format - # @param f is the file name + ## Deprecated, used only for compatibility! Please, use ExportMED() method instead. + # Exports the mesh in a file in MED format and chooses the \a version of MED format + # @param f the file name # @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2 + # @ingroup l2_impexp def ExportToMED(self, f, version, opt=0): self.mesh.ExportToMED(f, opt, version) - ## Export the mesh in a file with the MED format + ## Exports the mesh in a file in MED format # @param f is the file name # @param auto_groups boolean parameter for creating/not creating # the groups Group_On_All_Nodes, Group_On_All_Faces, ... ; # the typical use is auto_groups=false. # @param version MED format version(MED_V2_1 or MED_V2_2) + # @ingroup l2_impexp def ExportMED(self, f, auto_groups=0, version=MED_V2_2): self.mesh.ExportToMED(f, auto_groups, version) - ## Export the mesh in a file with the DAT format - # @param f is the file name + ## Exports the mesh in a file in DAT format + # @param f the file name + # @ingroup l2_impexp def ExportDAT(self, f): self.mesh.ExportDAT(f) - ## Export the mesh in a file with the UNV format - # @param f is the file name + ## Exports the mesh in a file in UNV format + # @param f the file name + # @ingroup l2_impexp def ExportUNV(self, f): self.mesh.ExportUNV(f) - ## Export the mesh in a file with the STL format - # @param f is the file name - # @param ascii defined the kind of file contents + ## Export the mesh in a file in STL format + # @param f the file name + # @param ascii defines the file encoding + # @ingroup l2_impexp def ExportSTL(self, f, ascii=1): self.mesh.ExportSTL(f, ascii) @@ -891,18 +1037,22 @@ class Mesh: # ---------------------- ## Creates an empty mesh group - # @param elementType is the type of elements in the group - # @param name is the name of the mesh group + # @param elementType the type of elements in the group + # @param name the name of the mesh group # @return SMESH_Group + # @ingroup l2_grps_create def CreateEmptyGroup(self, elementType, name): return self.mesh.CreateGroup(elementType, name) - ## Creates a mesh group based on geometric object \a grp - # and give a \a name, \n if this parameter is not defined - # the name is the same as the geometric group name - # @param grp is a geometric group, a vertex, an edge, a face or a solid - # @param name is the name of the mesh group + ## Creates a mesh group based on the geometrical object \a grp + # and gives a \a name, \n if this parameter is not defined + # the name is the same as the geometrical group name + # @param grp a geometrical group, a vertex, an edge, a face or a solid + # @param name the name of the mesh group + # @param typ the type of elements in the group. If not set, it is + # automatically detected by the type of the geometry # @return SMESH_GroupOnGeom + # @ingroup l2_grps_create def GroupOnGeom(self, grp, name="", typ=None): if name == "": name = grp.GetName() @@ -939,24 +1089,26 @@ class Mesh: else: return self.mesh.CreateGroupFromGEOM(typ, name, grp) - ## Create a mesh group by the given ids of elements - # @param groupName is the name of the mesh group - # @param elementType is the type of elements in the group - # @param elemIDs is the list of ids + ## Creates a mesh group by the given ids of elements + # @param groupName the name of the mesh group + # @param elementType the type of elements in the group + # @param elemIDs the list of ids # @return SMESH_Group + # @ingroup l2_grps_create def MakeGroupByIds(self, groupName, elementType, elemIDs): group = self.mesh.CreateGroup(elementType, groupName) group.Add(elemIDs) return group - ## Create a mesh group by the given conditions - # @param groupName is the name of the mesh group - # @param elementType is the type of elements in the group - # @param CritType is type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. ) - # @param Compare belong to {FT_LessThan, FT_MoreThan, FT_EqualTo} - # @param Treshold is threshold value (range of id ids as string, shape, numeric) - # @param UnaryOp is FT_LogicalNOT or FT_Undefined + ## Creates a mesh group by the given conditions + # @param groupName the name of the mesh group + # @param elementType the type of elements in the group + # @param CritType the type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. ) + # @param Compare belongs to {FT_LessThan, FT_MoreThan, FT_EqualTo} + # @param Treshold the threshold value (range of id ids as string, shape, numeric) + # @param UnaryOp FT_LogicalNOT or FT_Undefined # @return SMESH_Group + # @ingroup l2_grps_create def MakeGroup(self, groupName, elementType, @@ -968,10 +1120,11 @@ class Mesh: group = self.MakeGroupByCriterion(groupName, aCriterion) return group - ## Create a mesh group by the given criterion - # @param groupName is the name of the mesh group - # @param Criterion is the instance of Criterion class + ## Creates a mesh group by the given criterion + # @param groupName the name of the mesh group + # @param Criterion the instance of Criterion class # @return SMESH_Group + # @ingroup l2_grps_create def MakeGroupByCriterion(self, groupName, Criterion): aFilterMgr = self.smeshpyD.CreateFilterManager() aFilter = aFilterMgr.CreateFilter() @@ -981,10 +1134,11 @@ class Mesh: group = self.MakeGroupByFilter(groupName, aFilter) return group - ## Create a mesh group by the given criteria(list of criterions) - # @param groupName is the name of the mesh group - # @param Criteria is the list of criterions + ## Creates a mesh group by the given criteria (list of criteria) + # @param groupName the name of the mesh group + # @param theCriteria the list of criteria # @return SMESH_Group + # @ingroup l2_grps_create def MakeGroupByCriteria(self, groupName, theCriteria): aFilterMgr = self.smeshpyD.CreateFilterManager() aFilter = aFilterMgr.CreateFilter() @@ -992,25 +1146,28 @@ class Mesh: group = self.MakeGroupByFilter(groupName, aFilter) return group - ## Create a mesh group by the given filter - # @param groupName is the name of the mesh group - # @param Criterion is the instance of Filter class + ## Creates a mesh group by the given filter + # @param groupName the name of the mesh group + # @param theFilter the instance of Filter class # @return SMESH_Group + # @ingroup l2_grps_create def MakeGroupByFilter(self, groupName, theFilter): anIds = theFilter.GetElementsId(self.mesh) anElemType = theFilter.GetElementType() group = self.MakeGroupByIds(groupName, anElemType, anIds) return group - ## Pass mesh elements through the given filter and return ids - # @param theFilter is SMESH_Filter - # @return list of ids + ## Passes mesh elements through the given filter and return IDs of fitting elements + # @param theFilter SMESH_Filter + # @return a list of ids + # @ingroup l1_controls def GetIdsFromFilter(self, theFilter): return theFilter.GetElementsId(self.mesh) - ## Verify whether 2D mesh element has free edges(edges connected to one face only)\n - # Returns list of special structures(borders). - # @return list of SMESH.FreeEdges.Border structure: edge id and two its nodes ids. + ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n + # Returns a list of special structures (borders). + # @return a list of SMESH.FreeEdges.Border structure: edge id and ids of two its nodes. + # @ingroup l1_controls def GetFreeBorders(self): aFilterMgr = self.smeshpyD.CreateFilterManager() aPredicate = aFilterMgr.CreateFreeEdges() @@ -1018,26 +1175,31 @@ class Mesh: aBorders = aPredicate.GetBorders() return aBorders - ## Remove a group + ## Removes a group + # @ingroup l2_grps_delete def RemoveGroup(self, group): self.mesh.RemoveGroup(group) - ## Remove group with its contents + ## Removes a group with its contents + # @ingroup l2_grps_delete def RemoveGroupWithContents(self, group): self.mesh.RemoveGroupWithContents(group) - ## Get the list of groups existing in the mesh - # @return sequence of SMESH_GroupBase + ## Gets the list of groups existing in the mesh + # @return a sequence of SMESH_GroupBase + # @ingroup l2_grps_create def GetGroups(self): return self.mesh.GetGroups() - ## Get number of groups existing in the mesh - # @return quantity of groups as an integer value + ## Gets the number of groups existing in the mesh + # @return the quantity of groups as an integer value + # @ingroup l2_grps_create def NbGroups(self): return self.mesh.NbGroups() - ## Get the list of names of groups existing in the mesh + ## Gets the list of names of groups existing in the mesh # @return list of strings + # @ingroup l2_grps_create def GetGroupNames(self): groups = self.GetGroups() names = [] @@ -1045,24 +1207,27 @@ class Mesh: names.append(group.GetName()) return names - ## Union of two groups - # New group is created. All mesh elements that are - # present in initial groups are added to the new one + ## Produces a union of two groups + # A new group is created. All mesh elements that are + # present in the initial groups are added to the new one # @return an instance of SMESH_Group + # @ingroup l2_grps_operon def UnionGroups(self, group1, group2, name): return self.mesh.UnionGroups(group1, group2, name) - ## Intersection of two groups - # New group is created. All mesh elements that are - # present in both initial groups are added to the new one. + ## Prodices an intersection of two groups + # A new group is created. All mesh elements that are common + # for the two initial groups are added to the new one. # @return an instance of SMESH_Group + # @ingroup l2_grps_operon def IntersectGroups(self, group1, group2, name): return self.mesh.IntersectGroups(group1, group2, name) - ## Cut of two groups - # New group is created. All mesh elements that are present in - # main group but do not present in tool group are added to the new one + ## Produces a cut of two groups + # A new group is created. All mesh elements that are present in + # the main group but are not present in the tool group are added to the new one # @return an instance of SMESH_Group + # @ingroup l2_grps_operon def CutGroups(self, mainGroup, toolGroup, name): return self.mesh.CutGroups(mainGroup, toolGroup, name) @@ -1070,55 +1235,64 @@ class Mesh: # Get some info about mesh: # ------------------------ - ## Get the log of nodes and elements added or removed since previous - # clear of the log. + ## Returns the log of nodes and elements added or removed + # since the previous clear of the log. # @param clearAfterGet log is emptied after Get (safe if concurrents access) # @return list of log_block structures: # commandType # number # coords # indexes + # @ingroup l1_auxiliary def GetLog(self, clearAfterGet): return self.mesh.GetLog(clearAfterGet) - ## Clear the log of nodes and elements added or removed since previous + ## Clears the log of nodes and elements added or removed since the previous # clear. Must be used immediately after GetLog if clearAfterGet is false. + # @ingroup l1_auxiliary def ClearLog(self): self.mesh.ClearLog() - ## Toggle auto color mode on the object. - # @param theAutoColor flag which toggles auto color mode. + ## Toggles auto color mode on the object. + # @param theAutoColor the flag which toggles auto color mode. + # @ingroup l1_auxiliary def SetAutoColor(self, theAutoColor): self.mesh.SetAutoColor(theAutoColor) - ## Get flag of object auto color mode. + ## Gets flag of object auto color mode. # @return True or False + # @ingroup l1_auxiliary def GetAutoColor(self): return self.mesh.GetAutoColor() - ## Get the internal Id + ## Gets the internal ID # @return integer value, which is the internal Id of the mesh + # @ingroup l1_auxiliary def GetId(self): return self.mesh.GetId() ## Get the study Id # @return integer value, which is the study Id of the mesh + # @ingroup l1_auxiliary def GetStudyId(self): return self.mesh.GetStudyId() - ## Check group names for duplications. - # Consider maximum group name length stored in MED file. + ## Checks the group names for duplications. + # Consider the maximum group name length stored in MED file. # @return True or False + # @ingroup l1_auxiliary def HasDuplicatedGroupNamesMED(self): return self.mesh.HasDuplicatedGroupNamesMED() - ## Obtain mesh editor tool + ## Obtains the mesh editor tool # @return an instance of SMESH_MeshEditor + # @ingroup l1_modifying def GetMeshEditor(self): return self.mesh.GetMeshEditor() - ## Get MED Mesh + ## Gets MED Mesh # @return an instance of SALOME_MED::MESH + # @ingroup l1_auxiliary def GetMEDMesh(self): return self.mesh.GetMEDMesh() @@ -1126,167 +1300,195 @@ class Mesh: # Get informations about mesh contents: # ------------------------------------ - ## Returns number of nodes in mesh + ## Returns the number of nodes in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbNodes(self): return self.mesh.NbNodes() - ## Returns number of elements in mesh + ## Returns the number of elements in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbElements(self): return self.mesh.NbElements() - ## Returns number of edges in mesh + ## Returns the number of edges in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbEdges(self): return self.mesh.NbEdges() - ## Returns number of edges with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of edges with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbEdgesOfOrder(self, elementOrder): return self.mesh.NbEdgesOfOrder(elementOrder) - ## Returns number of faces in mesh + ## Returns the number of faces in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbFaces(self): return self.mesh.NbFaces() - ## Returns number of faces with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of faces with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbFacesOfOrder(self, elementOrder): return self.mesh.NbFacesOfOrder(elementOrder) - ## Returns number of triangles in mesh + ## Returns the number of triangles in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbTriangles(self): return self.mesh.NbTriangles() - ## Returns number of triangles with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of triangles with the given order in the mesh + # @param elementOrder is the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbTrianglesOfOrder(self, elementOrder): return self.mesh.NbTrianglesOfOrder(elementOrder) - ## Returns number of quadrangles in mesh + ## Returns the number of quadrangles in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbQuadrangles(self): return self.mesh.NbQuadrangles() - ## Returns number of quadrangles with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of quadrangles with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbQuadranglesOfOrder(self, elementOrder): return self.mesh.NbQuadranglesOfOrder(elementOrder) - ## Returns number of polygons in mesh + ## Returns the number of polygons in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbPolygons(self): return self.mesh.NbPolygons() - ## Returns number of volumes in mesh + ## Returns the number of volumes in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbVolumes(self): return self.mesh.NbVolumes() - ## Returns number of volumes with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of volumes with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbVolumesOfOrder(self, elementOrder): return self.mesh.NbVolumesOfOrder(elementOrder) - ## Returns number of tetrahedrons in mesh + ## Returns the number of tetrahedrons in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbTetras(self): return self.mesh.NbTetras() - ## Returns number of tetrahedrons with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of tetrahedrons with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbTetrasOfOrder(self, elementOrder): return self.mesh.NbTetrasOfOrder(elementOrder) - ## Returns number of hexahedrons in mesh + ## Returns the number of hexahedrons in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbHexas(self): return self.mesh.NbHexas() - ## Returns number of hexahedrons with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of hexahedrons with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbHexasOfOrder(self, elementOrder): return self.mesh.NbHexasOfOrder(elementOrder) - ## Returns number of pyramids in mesh + ## Returns the number of pyramids in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbPyramids(self): return self.mesh.NbPyramids() - ## Returns number of pyramids with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of pyramids with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbPyramidsOfOrder(self, elementOrder): return self.mesh.NbPyramidsOfOrder(elementOrder) - ## Returns number of prisms in mesh + ## Returns the number of prisms in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbPrisms(self): return self.mesh.NbPrisms() - ## Returns number of prisms with given order in mesh - # @param elementOrder is order of elements: + ## Returns the number of prisms with the given order in the mesh + # @param elementOrder the order of elements: # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC # @return an integer value + # @ingroup l1_meshinfo def NbPrismsOfOrder(self, elementOrder): return self.mesh.NbPrismsOfOrder(elementOrder) - ## Returns number of polyhedrons in mesh + ## Returns the number of polyhedrons in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbPolyhedrons(self): return self.mesh.NbPolyhedrons() - ## Returns number of submeshes in mesh + ## Returns the number of submeshes in the mesh # @return an integer value + # @ingroup l1_meshinfo def NbSubMesh(self): return self.mesh.NbSubMesh() - ## Returns list of mesh elements ids - # @return list of integer values + ## Returns the list of mesh elements IDs + # @return the list of integer values + # @ingroup l1_meshinfo def GetElementsId(self): return self.mesh.GetElementsId() - ## Returns list of ids of mesh elements with given type - # @param elementType is required type of elements + ## Returns the list of IDs of mesh elements with the given type + # @param elementType the required type of elements # @return list of integer values + # @ingroup l1_meshinfo def GetElementsByType(self, elementType): return self.mesh.GetElementsByType(elementType) - ## Returns list of mesh nodes ids - # @return list of integer values + ## Returns the list of mesh nodes IDs + # @return the list of integer values + # @ingroup l1_meshinfo def GetNodesId(self): return self.mesh.GetNodesId() - # Get informations about mesh elements: + # Get the information about mesh elements: # ------------------------------------ - ## Returns type of mesh element - # @return value from SMESH::ElementType enumeration + ## Returns the type of mesh element + # @return the value from SMESH::ElementType enumeration + # @ingroup l1_meshinfo def GetElementType(self, id, iselem): return self.mesh.GetElementType(id, iselem) - ## Returns list of submesh elements ids - # @param Shape is geom object(subshape) IOR - # Shape must be subshape of a ShapeToMesh() - # @return list of integer values + ## Returns the list of submesh elements IDs + # @param Shape a geom object(subshape) IOR + # Shape must be the subshape of a ShapeToMesh() + # @return the list of integer values + # @ingroup l1_meshinfo def GetSubMeshElementsId(self, Shape): if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)): ShapeID = Shape.GetSubShapeIndices()[0] @@ -1294,10 +1496,12 @@ class Mesh: ShapeID = Shape return self.mesh.GetSubMeshElementsId(ShapeID) - ## Returns list of submesh nodes ids - # @param Shape is geom object(subshape) IOR - # Shape must be subshape of a ShapeToMesh() - # @return list of integer values + ## Returns the list of submesh nodes IDs + # @param Shape a geom object(subshape) IOR + # Shape must be the subshape of a ShapeToMesh() + # @param all If true, gives all nodes of submesh elements, otherwise gives only submesh nodes + # @return the list of integer values + # @ingroup l1_meshinfo def GetSubMeshNodesId(self, Shape, all): if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)): ShapeID = Shape.GetSubShapeIndices()[0] @@ -1305,10 +1509,11 @@ class Mesh: ShapeID = Shape return self.mesh.GetSubMeshNodesId(ShapeID, all) - ## Returns list of ids of submesh elements with given type - # @param Shape is geom object(subshape) IOR - # Shape must be subshape of a ShapeToMesh() - # @return list of integer values + ## Returns the list of IDs of submesh elements with the given type + # @param Shape a geom object(subshape) IOR + # Shape must be a subshape of a ShapeToMesh() + # @return the list of integer values + # @ingroup l1_meshinfo def GetSubMeshElementType(self, Shape): if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)): ShapeID = Shape.GetSubShapeIndices()[0] @@ -1316,90 +1521,106 @@ class Mesh: ShapeID = Shape return self.mesh.GetSubMeshElementType(ShapeID) - ## Get mesh description + ## Gets the mesh description # @return string value + # @ingroup l1_meshinfo def Dump(self): return self.mesh.Dump() - # Get information about nodes and elements of mesh by its ids: + # Get the information about nodes and elements of a mesh by its IDs: # ----------------------------------------------------------- - ## Get XYZ coordinates of node - # \n If there is not node for given ID - returns empty list + ## Gets XYZ coordinates of a node + # \n If there is no nodes for the given ID - returns an empty list # @return a list of double precision values + # @ingroup l1_meshinfo def GetNodeXYZ(self, id): return self.mesh.GetNodeXYZ(id) - ## For given node returns list of IDs of inverse elements - # \n If there is not node for given ID - returns empty list - # @return list of integer values + ## Returns list of IDs of inverse elements for the given node + # \n If there is no node for the given ID - returns an empty list + # @return a list of integer values + # @ingroup l1_meshinfo def GetNodeInverseElements(self, id): return self.mesh.GetNodeInverseElements(id) - ## @brief Return position of a node on shape + ## @brief Returns the position of a node on the shape # @return SMESH::NodePosition + # @ingroup l1_meshinfo def GetNodePosition(self,NodeID): return self.mesh.GetNodePosition(NodeID) - ## If given element is node returns IDs of shape from position - # \n If there is not node for given ID - returns -1 - # @return integer value + ## If the given element is a node, returns the ID of shape + # \n If there is no node for the given ID - returns -1 + # @return an integer value + # @ingroup l1_meshinfo def GetShapeID(self, id): return self.mesh.GetShapeID(id) - ## For given element returns ID of result shape after - # FindShape() from SMESH_MeshEditor - # \n If there is not element for given ID - returns -1 - # @return integer value + ## Returns the ID of the result shape after + # FindShape() from SMESH_MeshEditor for the given element + # \n If there is no element for the given ID - returns -1 + # @return an integer value + # @ingroup l1_meshinfo def GetShapeIDForElem(self,id): return self.mesh.GetShapeIDForElem(id) - ## Returns number of nodes for given element - # \n If there is not element for given ID - returns -1 - # @return integer value + ## Returns the number of nodes for the given element + # \n If there is no element for the given ID - returns -1 + # @return an integer value + # @ingroup l1_meshinfo def GetElemNbNodes(self, id): return self.mesh.GetElemNbNodes(id) - ## Returns ID of node by given index for given element - # \n If there is not element for given ID - returns -1 - # \n If there is not node for given index - returns -2 - # @return integer value + ## Returns the node ID the given index for the given element + # \n If there is no element for the given ID - returns -1 + # \n If there is no node for the given index - returns -2 + # @return an integer value + # @ingroup l1_meshinfo def GetElemNode(self, id, index): return self.mesh.GetElemNode(id, index) - ## Returns IDs of nodes of given element - # @return list of integer values + ## Returns the IDs of nodes of the given element + # @return a list of integer values + # @ingroup l1_meshinfo def GetElemNodes(self, id): return self.mesh.GetElemNodes(id) - ## Returns true if given node is medium node in given quadratic element + ## Returns true if the given node is the medium node in the given quadratic element + # @ingroup l1_meshinfo def IsMediumNode(self, elementID, nodeID): return self.mesh.IsMediumNode(elementID, nodeID) - ## Returns true if given node is medium node in one of quadratic elements + ## Returns true if the given node is the medium node in one of quadratic elements + # @ingroup l1_meshinfo def IsMediumNodeOfAnyElem(self, nodeID, elementType): return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType) - ## Returns number of edges for given element + ## Returns the number of edges for the given element + # @ingroup l1_meshinfo def ElemNbEdges(self, id): return self.mesh.ElemNbEdges(id) - ## Returns number of faces for given element + ## Returns the number of faces for the given element + # @ingroup l1_meshinfo def ElemNbFaces(self, id): return self.mesh.ElemNbFaces(id) - ## Returns true if given element is polygon + ## Returns true if the given element is a polygon + # @ingroup l1_meshinfo def IsPoly(self, id): return self.mesh.IsPoly(id) - ## Returns true if given element is quadratic + ## Returns true if the given element is quadratic + # @ingroup l1_meshinfo def IsQuadratic(self, id): return self.mesh.IsQuadratic(id) - ## Returns XYZ coordinates of bary center for given element - # \n If there is not element for given ID - returns empty list + ## Returns XYZ coordinates of the barycenter of the given element + # \n If there is no element for the given ID - returns an empty list # @return a list of three double values + # @ingroup l1_meshinfo def BaryCenter(self, id): return self.mesh.BaryCenter(id) @@ -1407,81 +1628,91 @@ class Mesh: # Mesh edition (SMESH_MeshEditor functionality): # --------------------------------------------- - ## Removes elements from mesh by ids - # @param IDsOfElements is list of ids of elements to remove + ## Removes the elements from the mesh by ids + # @param IDsOfElements is a list of ids of elements to remove # @return True or False + # @ingroup l2_modif_del def RemoveElements(self, IDsOfElements): return self.editor.RemoveElements(IDsOfElements) ## Removes nodes from mesh by ids - # @param IDsOfNodes is list of ids of nodes to remove + # @param IDsOfNodes is a list of ids of nodes to remove # @return True or False + # @ingroup l2_modif_del def RemoveNodes(self, IDsOfNodes): return self.editor.RemoveNodes(IDsOfNodes) - ## Add node to mesh by coordinates + ## Add a node to the mesh by coordinates # @return Id of the new node + # @ingroup l2_modif_add def AddNode(self, x, y, z): return self.editor.AddNode( x, y, z) - - ## Create edge either linear or quadratic (this is determined - # by number of given nodes). - # @param IdsOfNodes List of node IDs for creation of element. - # Needed order of nodes in this list corresponds to description + ## Creates a linear or quadratic edge (this is determined + # by the number of given nodes). + # @param IDsOfNodes the list of node IDs for creation of the element. + # The order of nodes in this list should correspond to the description # of MED. \n This description is located by the following link: # http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3. - # @return Id of the new edge + # @return the Id of the new edge + # @ingroup l2_modif_add def AddEdge(self, IDsOfNodes): return self.editor.AddEdge(IDsOfNodes) - ## Create face either linear or quadratic (this is determined - # by number of given nodes). - # @param IdsOfNodes List of node IDs for creation of element. - # Needed order of nodes in this list corresponds to description + ## Creates a linear or quadratic face (this is determined + # by the number of given nodes). + # @param IDsOfNodes the list of node IDs for creation of the element. + # The order of nodes in this list should correspond to the description # of MED. \n This description is located by the following link: # http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3. - # @return Id of the new face + # @return the Id of the new face + # @ingroup l2_modif_add def AddFace(self, IDsOfNodes): return self.editor.AddFace(IDsOfNodes) - ## Add polygonal face to mesh by list of nodes ids - # @return Id of the new face + ## Adds a polygonal face to the mesh by the list of node IDs + # @param IdsOfNodes the list of node IDs for creation of the element. + # @return the Id of the new face + # @ingroup l2_modif_add def AddPolygonalFace(self, IdsOfNodes): return self.editor.AddPolygonalFace(IdsOfNodes) - ## Create volume both similar and quadratic (this is determed - # by number of given nodes). - # @param IdsOfNodes List of node IDs for creation of element. - # Needed order of nodes in this list corresponds to description + ## Creates both simple and quadratic volume (this is determined + # by the number of given nodes). + # @param IDsOfNodes the list of node IDs for creation of the element. + # The order of nodes in this list should correspond to the description # of MED. \n This description is located by the following link: # http://www.salome-platform.org/salome2/web_med_internet/logiciels/medV2.2.2_doc_html/html/modele_de_donnees.html#3. - # @return Id of the new volumic element + # @return the Id of the new volumic element + # @ingroup l2_modif_add def AddVolume(self, IDsOfNodes): return self.editor.AddVolume(IDsOfNodes) - ## Create volume of many faces, giving nodes for each face. - # @param IdsOfNodes List of node IDs for volume creation face by face. - # @param Quantities List of integer values, Quantities[i] - # gives quantity of nodes in face number i. - # @return Id of the new volumic element + ## Creates a volume of many faces, giving nodes for each face. + # @param IdsOfNodes the list of node IDs for volume creation face by face. + # @param Quantities the list of integer values, Quantities[i] + # gives the quantity of nodes in face number i. + # @return the Id of the new volumic element + # @ingroup l2_modif_add def AddPolyhedralVolume (self, IdsOfNodes, Quantities): return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities) - ## Create volume of many faces, giving IDs of existing faces. - # @param IdsOfFaces List of face IDs for volume creation. + ## Creates a volume of many faces, giving the IDs of the existing faces. + # @param IdsOfFaces the list of face IDs for volume creation. # - # Note: The created volume will refer only to nodes - # of the given faces, not to the faces itself. - # @return Id of the new volumic element + # Note: The created volume will refer only to the nodes + # of the given faces, not to the faces themselves. + # @return the Id of the new volumic element + # @ingroup l2_modif_add def AddPolyhedralVolumeByFaces (self, IdsOfFaces): return self.editor.AddPolyhedralVolumeByFaces(IdsOfFaces) - ## @brief Bind a node to a vertex - # @param NodeID - node ID - # @param Vertex - vertex or vertex ID - # @return True if succeed else raise an exception + ## @brief Binds a node to a vertex + # @param NodeID a node ID + # @param Vertex a vertex or vertex ID + # @return True if succeed else raises an exception + # @ingroup l2_modif_add def SetNodeOnVertex(self, NodeID, Vertex): if ( isinstance( Vertex, geompyDC.GEOM._objref_GEOM_Object)): VertexID = Vertex.GetSubShapeIndices()[0] @@ -1494,11 +1725,12 @@ class Mesh: return True - ## @brief Store node position on an edge - # @param NodeID - node ID - # @param Edge - edge or edge ID - # @param paramOnEdge - parameter on edge where the node is located - # @return True if succeed else raise an exception + ## @brief Stores the node position on an edge + # @param NodeID a node ID + # @param Edge an edge or edge ID + # @param paramOnEdge a parameter on the edge where the node is located + # @return True if succeed else raises an exception + # @ingroup l2_modif_add def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge): if ( isinstance( Edge, geompyDC.GEOM._objref_GEOM_Object)): EdgeID = Edge.GetSubShapeIndices()[0] @@ -1510,12 +1742,13 @@ class Mesh: raise ValueError, inst.details.text return True - ## @brief Store node position on a face - # @param NodeID - node ID - # @param Face - face or face ID - # @param u - U parameter on face where the node is located - # @param v - V parameter on face where the node is located - # @return True if succeed else raise an exception + ## @brief Stores node position on a face + # @param NodeID a node ID + # @param Face a face or face ID + # @param u U parameter on the face where the node is located + # @param v V parameter on the face where the node is located + # @return True if succeed else raises an exception + # @ingroup l2_modif_add def SetNodeOnFace(self, NodeID, Face, u, v): if ( isinstance( Face, geompyDC.GEOM._objref_GEOM_Object)): FaceID = Face.GetSubShapeIndices()[0] @@ -1527,10 +1760,11 @@ class Mesh: raise ValueError, inst.details.text return True - ## @brief Bind a node to a solid - # @param NodeID - node ID - # @param Solid - solid or solid ID - # @return True if succeed else raise an exception + ## @brief Binds a node to a solid + # @param NodeID a node ID + # @param Solid a solid or solid ID + # @return True if succeed else raises an exception + # @ingroup l2_modif_add def SetNodeInVolume(self, NodeID, Solid): if ( isinstance( Solid, geompyDC.GEOM._objref_GEOM_Object)): SolidID = Solid.GetSubShapeIndices()[0] @@ -1543,9 +1777,10 @@ class Mesh: return True ## @brief Bind an element to a shape - # @param ElementID - element ID - # @param Shape - shape or shape ID - # @return True if succeed else raise an exception + # @param ElementID an element ID + # @param Shape a shape or shape ID + # @return True if succeed else raises an exception + # @ingroup l2_modif_add def SetMeshElementOnShape(self, ElementID, Shape): if ( isinstance( Shape, geompyDC.GEOM._objref_GEOM_Object)): ShapeID = Shape.GetSubShapeIndices()[0] @@ -1558,131 +1793,147 @@ class Mesh: return True - ## Move node with given id - # @param NodeID id of the node - # @param x new X coordinate - # @param y new Y coordinate - # @param z new Z coordinate + ## Moves the node with the given id + # @param NodeID the id of the node + # @param x a new X coordinate + # @param y a new Y coordinate + # @param z a new Z coordinate # @return True if succeed else False + # @ingroup l2_modif_movenode def MoveNode(self, NodeID, x, y, z): return self.editor.MoveNode(NodeID, x, y, z) - ## Find a node closest to a point - # @param x X coordinate of a point - # @param y Y coordinate of a point - # @param z Z coordinate of a point - # @return id of a node + ## Finds the node closest to a point + # @param x the X coordinate of a point + # @param y the Y coordinate of a point + # @param z the Z coordinate of a point + # @return the ID of a node + # @ingroup l2_modif_throughp def FindNodeClosestTo(self, x, y, z): preview = self.mesh.GetMeshEditPreviewer() return preview.MoveClosestNodeToPoint(x, y, z, -1) - ## Find a node closest to a point and move it to a point location - # @param x X coordinate of a point - # @param y Y coordinate of a point - # @param z Z coordinate of a point - # @return id of a moved node + ## Finds the node closest to a point and moves it to a point location + # @param x the X coordinate of a point + # @param y the Y coordinate of a point + # @param z the Z coordinate of a point + # @return the ID of a moved node + # @ingroup l2_modif_throughp def MeshToPassThroughAPoint(self, x, y, z): return self.editor.MoveClosestNodeToPoint(x, y, z, -1) - ## Replace two neighbour triangles sharing Node1-Node2 link - # with ones built on the same 4 nodes but having other common link. - # @param NodeID1 first node id - # @param NodeID2 second node id - # @return false if proper faces not found + ## Replaces two neighbour triangles sharing Node1-Node2 link + # with the triangles built on the same 4 nodes but having other common link. + # @param NodeID1 the ID of the first node + # @param NodeID2 the ID of the second node + # @return false if proper faces were not found + # @ingroup l2_modif_invdiag def InverseDiag(self, NodeID1, NodeID2): return self.editor.InverseDiag(NodeID1, NodeID2) - ## Replace two neighbour triangles sharing Node1-Node2 link + ## Replaces two neighbour triangles sharing Node1-Node2 link # with a quadrangle built on the same 4 nodes. - # @param NodeID1 first node id - # @param NodeID2 second node id - # @return false if proper faces not found + # @param NodeID1 the ID of the first node + # @param NodeID2 the ID of the second node + # @return false if proper faces were not found + # @ingroup l2_modif_unitetri def DeleteDiag(self, NodeID1, NodeID2): return self.editor.DeleteDiag(NodeID1, NodeID2) - ## Reorient elements by ids - # @param IDsOfElements if undefined reorient all mesh elements + ## Reorients elements by ids + # @param IDsOfElements if undefined reorients all mesh elements # @return True if succeed else False + # @ingroup l2_modif_changori def Reorient(self, IDsOfElements=None): if IDsOfElements == None: IDsOfElements = self.GetElementsId() return self.editor.Reorient(IDsOfElements) - ## Reorient all elements of the object - # @param theObject is mesh, submesh or group + ## Reorients all elements of the object + # @param theObject mesh, submesh or group # @return True if succeed else False + # @ingroup l2_modif_changori def ReorientObject(self, theObject): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() return self.editor.ReorientObject(theObject) - ## Fuse neighbour triangles into quadrangles. + ## Fuses the neighbouring triangles into quadrangles. # @param IDsOfElements The triangles to be fused, - # @param theCriterion is FT_...; used to choose a neighbour to fuse with. - # @param MaxAngle is a max angle between element normals at which fusion + # @param theCriterion is FT_...; used to choose a neighbour to fuse with. + # @param MaxAngle is the maximum angle between element normals at which the fusion # is still performed; theMaxAngle is mesured in radians. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_unitetri def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle): if IDsOfElements == []: IDsOfElements = self.GetElementsId() return self.editor.TriToQuad(IDsOfElements, self.smeshpyD.GetFunctor(theCriterion), MaxAngle) - ## Fuse neighbour triangles of the object into quadrangles + ## Fuses the neighbouring triangles of the object into quadrangles # @param theObject is mesh, submesh or group # @param theCriterion is FT_...; used to choose a neighbour to fuse with. - # @param MaxAngle is a max angle between element normals at which fusion + # @param MaxAngle a max angle between element normals at which the fusion # is still performed; theMaxAngle is mesured in radians. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_unitetri def TriToQuadObject (self, theObject, theCriterion, MaxAngle): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() return self.editor.TriToQuadObject(theObject, self.smeshpyD.GetFunctor(theCriterion), MaxAngle) - ## Split quadrangles into triangles. + ## Splits quadrangles into triangles. # @param IDsOfElements the faces to be splitted. - # @param theCriterion is FT_...; used to choose a diagonal for splitting. + # @param theCriterion FT_...; used to choose a diagonal for splitting. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_cutquadr def QuadToTri (self, IDsOfElements, theCriterion): if IDsOfElements == []: IDsOfElements = self.GetElementsId() return self.editor.QuadToTri(IDsOfElements, self.smeshpyD.GetFunctor(theCriterion)) - ## Split quadrangles into triangles. - # @param theObject object to taking list of elements from, is mesh, submesh or group - # @param theCriterion is FT_...; used to choose a diagonal for splitting. + ## Splits quadrangles into triangles. + # @param theObject the object from which the list of elements is taken, this is mesh, submesh or group + # @param theCriterion FT_...; used to choose a diagonal for splitting. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_cutquadr def QuadToTriObject (self, theObject, theCriterion): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() return self.editor.QuadToTriObject(theObject, self.smeshpyD.GetFunctor(theCriterion)) - ## Split quadrangles into triangles. - # @param theElems The faces to be splitted - # @param the13Diag is used to choose a diagonal for splitting. + ## Splits quadrangles into triangles. + # @param IDsOfElements the faces to be splitted + # @param Diag13 is used to choose a diagonal for splitting. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_cutquadr def SplitQuad (self, IDsOfElements, Diag13): if IDsOfElements == []: IDsOfElements = self.GetElementsId() return self.editor.SplitQuad(IDsOfElements, Diag13) - ## Split quadrangles into triangles. - # @param theObject is object to taking list of elements from, is mesh, submesh or group + ## Splits quadrangles into triangles. + # @param theObject the object from which the list of elements is taken, this is mesh, submesh or group + # @param Diag13 is used to choose a diagonal for splitting. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_cutquadr def SplitQuadObject (self, theObject, Diag13): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() return self.editor.SplitQuadObject(theObject, Diag13) - ## Find better splitting of the given quadrangle. - # @param IDOfQuad ID of the quadrangle to be splitted. - # @param theCriterion is FT_...; a criterion to choose a diagonal for splitting. + ## Finds a better splitting of the given quadrangle. + # @param IDOfQuad the ID of the quadrangle to be splitted. + # @param theCriterion FT_...; a criterion to choose a diagonal for splitting. # @return 1 if 1-3 diagonal is better, 2 if 2-4 # diagonal is better, 0 if error occurs. + # @ingroup l2_modif_cutquadr def BestSplit (self, IDOfQuad, theCriterion): return self.editor.BestSplit(IDOfQuad, self.smeshpyD.GetFunctor(theCriterion)) - ## Split quadrangle faces near triangular facets of volumes + ## Splits quadrangle faces near triangular facets of volumes # + # @ingroup l1_auxiliary def SplitQuadsNearTriangularFacets(self): faces_array = self.GetElementsByType(SMESH.FACE) for face_id in faces_array: @@ -1710,16 +1961,17 @@ class Mesh: isVolumeFound = True self.SplitQuad([face_id], True) # diagonal 1-3 - ## @brief Split hexahedrons into tetrahedrons. + ## @brief Splits hexahedrons into tetrahedrons. # - # Use pattern mapping functionality for splitting. - # @param theObject object to take list of hexahedrons from; is mesh, submesh or group. - # @param theNode000,theNode001 is in range [0,7]; give an orientation of the - # pattern relatively each hexahedron: the (0,0,0) key-point of pattern - # will be mapped into -th node of each volume, the (0,0,1) - # key-point will be mapped into -th node of each volume. - # The (0,0,0) key-point of used pattern corresponds to not split corner. + # This operation uses pattern mapping functionality for splitting. + # @param theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group. + # @param theNode000,theNode001 within the range [0,7]; gives the orientation of the + # pattern relatively each hexahedron: the (0,0,0) key-point of the pattern + # will be mapped into theNode000-th node of each volume, the (0,0,1) + # key-point will be mapped into theNode001-th node of each volume. + # The (0,0,0) key-point of the used pattern corresponds to a non-split corner. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l1_auxiliary def SplitHexaToTetras (self, theObject, theNode000, theNode001): # Pattern: 5.---------.6 # /|#* /| @@ -1769,14 +2021,15 @@ class Mesh: ## @brief Split hexahedrons into prisms. # - # Use pattern mapping functionality for splitting. - # @param theObject object to take list of hexahedrons from; is mesh, submesh or group. - # @param theNode000,theNode001 is in range [0,7]; give an orientation of the - # pattern relatively each hexahedron: the (0,0,0) key-point of pattern - # will be mapped into -th node of each volume, the (0,0,1) - # key-point will be mapped into -th node of each volume. - # The edge (0,0,0)-(0,0,1) of used pattern connects two not split corners. + # Uses the pattern mapping functionality for splitting. + # @param theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken; + # @param theNode000,theNode001 (within the range [0,7]) gives the orientation of the + # pattern relatively each hexahedron: keypoint (0,0,0) of the pattern + # will be mapped into the theNode000-th node of each volume, keypoint (0,0,1) + # will be mapped into the theNode001-th node of each volume. + # Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l1_auxiliary def SplitHexaToPrisms (self, theObject, theNode000, theNode001): # Pattern: 5.---------.6 # /|# /| @@ -1815,19 +2068,20 @@ class Mesh: isDone = pattern.MakeMesh(self.mesh, False, False) if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode() - # split quafrangle faces near triangular facets of volumes + # Splits quafrangle faces near triangular facets of volumes self.SplitQuadsNearTriangularFacets() return isDone - ## Smooth elements - # @param IDsOfElements list if ids of elements to smooth - # @param IDsOfFixedNodes list of ids of fixed nodes. + ## Smoothes elements + # @param IDsOfElements the list if ids of elements to smooth + # @param IDsOfFixedNodes the list of ids of fixed nodes. # Note that nodes built on edges and boundary nodes are always fixed. - # @param MaxNbOfIterations maximum number of iterations + # @param MaxNbOfIterations the maximum number of iterations # @param MaxAspectRatio varies in range [1.0, inf] # @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH) # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_smooth def Smooth(self, IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method): if IDsOfElements == []: @@ -1835,29 +2089,31 @@ class Mesh: return self.editor.Smooth(IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Smooth elements belong to given object - # @param theObject object to smooth - # @param IDsOfFixedNodes list of ids of fixed nodes. + ## Smoothes elements which belong to the given object + # @param theObject the object to smooth + # @param IDsOfFixedNodes the list of ids of fixed nodes. # Note that nodes built on edges and boundary nodes are always fixed. - # @param MaxNbOfIterations maximum number of iterations + # @param MaxNbOfIterations the maximum number of iterations # @param MaxAspectRatio varies in range [1.0, inf] # @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH) # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_smooth def SmoothObject(self, theObject, IDsOfFixedNodes, - MaxNbOfIterations, MaxxAspectRatio, Method): + MaxNbOfIterations, MaxAspectRatio, Method): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() return self.editor.SmoothObject(theObject, IDsOfFixedNodes, - MaxNbOfIterations, MaxxAspectRatio, Method) + MaxNbOfIterations, MaxAspectRatio, Method) - ## Parametric smooth the given elements - # @param IDsOfElements list if ids of elements to smooth - # @param IDsOfFixedNodes list of ids of fixed nodes. + ## Parametrically smoothes the given elements + # @param IDsOfElements the list if ids of elements to smooth + # @param IDsOfFixedNodes the list of ids of fixed nodes. # Note that nodes built on edges and boundary nodes are always fixed. - # @param MaxNbOfIterations maximum number of iterations + # @param MaxNbOfIterations the maximum number of iterations # @param MaxAspectRatio varies in range [1.0, inf] # @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH) # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_smooth def SmoothParametric(self, IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method): if IDsOfElements == []: @@ -1865,14 +2121,15 @@ class Mesh: return self.editor.SmoothParametric(IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Parametric smooth elements belong to given object - # @param theObject object to smooth - # @param IDsOfFixedNodes list of ids of fixed nodes. + ## Parametrically smoothes the elements which belong to the given object + # @param theObject the object to smooth + # @param IDsOfFixedNodes the list of ids of fixed nodes. # Note that nodes built on edges and boundary nodes are always fixed. - # @param MaxNbOfIterations maximum number of iterations + # @param MaxNbOfIterations the maximum number of iterations # @param MaxAspectRatio varies in range [1.0, inf] - # @param Method is Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH) + # @param Method Laplacian(LAPLACIAN_SMOOTH) or Centroidal(CENTROIDAL_SMOOTH) # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_smooth def SmoothParametricObject(self, theObject, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method): if ( isinstance( theObject, Mesh )): @@ -1880,70 +2137,87 @@ class Mesh: return self.editor.SmoothParametricObject(theObject, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Converts all mesh to quadratic one, deletes old elements, replacing - # them with quadratic ones with the same id. + ## Converts the mesh to quadratic, deletes old elements, replacing + # them with quadratic with the same id. + # @ingroup l2_modif_tofromqu def ConvertToQuadratic(self, theForce3d): self.editor.ConvertToQuadratic(theForce3d) - ## Converts all mesh from quadratic to ordinary ones, + ## Converts the mesh from quadratic to ordinary, # deletes old quadratic elements, \n replacing # them with ordinary mesh elements with the same id. # @return TRUE in case of success, FALSE otherwise. + # @ingroup l2_modif_tofromqu def ConvertFromQuadratic(self): return self.editor.ConvertFromQuadratic() ## Renumber mesh nodes + # @ingroup l2_modif_renumber def RenumberNodes(self): self.editor.RenumberNodes() ## Renumber mesh elements + # @ingroup l2_modif_renumber def RenumberElements(self): self.editor.RenumberElements() - ## Generate new elements by rotation of the elements around the axis - # @param IDsOfElements list of ids of elements to sweep - # @param Axix axis of rotation, AxisStruct or line(geom object) - # @param AngleInRadians angle of Rotation - # @param NbOfSteps number of steps + ## Generates new elements by rotation of the elements around the axis + # @param IDsOfElements the list of ids of elements to sweep + # @param Axis the axis of rotation, AxisStruct or line(geom object) + # @param AngleInRadians the angle of Rotation + # @param NbOfSteps the number of steps # @param Tolerance tolerance - # @param MakeGroups to generate new groups from existing ones - # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise - def RotationSweep(self, IDsOfElements, Axix, AngleInRadians, NbOfSteps, Tolerance, MakeGroups=False): + # @param MakeGroups forces the generation of new groups from existing ones + # @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size + # of all steps, else - size of each step + # @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev + def RotationSweep(self, IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance, + MakeGroups=False, TotalAngle=False): if IDsOfElements == []: IDsOfElements = self.GetElementsId() - if ( isinstance( Axix, geompyDC.GEOM._objref_GEOM_Object)): - Axix = self.smeshpyD.GetAxisStruct(Axix) + if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)): + Axis = self.smeshpyD.GetAxisStruct(Axis) + if TotalAngle and NbOfSteps: + AngleInRadians /= NbOfSteps if MakeGroups: - return self.editor.RotationSweepMakeGroups(IDsOfElements, Axix, + return self.editor.RotationSweepMakeGroups(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance) - self.editor.RotationSweep(IDsOfElements, Axix, AngleInRadians, NbOfSteps, Tolerance) + self.editor.RotationSweep(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance) return [] - ## Generate new elements by rotation of the elements of object around the axis - # @param theObject object wich elements should be sweeped - # @param Axix axis of rotation, AxisStruct or line(geom object) - # @param AngleInRadians angle of Rotation + ## Generates new elements by rotation of the elements of object around the axis + # @param theObject object which elements should be sweeped + # @param Axis the axis of rotation, AxisStruct or line(geom object) + # @param AngleInRadians the angle of Rotation # @param NbOfSteps number of steps # @param Tolerance tolerance - # @param MakeGroups to generate new groups from existing ones - # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise - def RotationSweepObject(self, theObject, Axix, AngleInRadians, NbOfSteps, Tolerance, MakeGroups=False): + # @param MakeGroups forces the generation of new groups from existing ones + # @param TotalAngle gives meaning of AngleInRadians: if True then it is an angular size + # of all steps, else - size of each step + # @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev + def RotationSweepObject(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance, + MakeGroups=False, TotalAngle=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() - if ( isinstance( Axix, geompyDC.GEOM._objref_GEOM_Object)): - Axix = self.smeshpyD.GetAxisStruct(Axix) + if ( isinstance( Axis, geompyDC.GEOM._objref_GEOM_Object)): + Axis = self.smeshpyD.GetAxisStruct(Axis) + if TotalAngle and NbOfSteps: + AngleInRadians /= NbOfSteps if MakeGroups: - return self.editor.RotationSweepObjectMakeGroups(theObject, Axix, AngleInRadians, + return self.editor.RotationSweepObjectMakeGroups(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance) - self.editor.RotationSweepObject(theObject, Axix, AngleInRadians, NbOfSteps, Tolerance) + self.editor.RotationSweepObject(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance) return [] - ## Generate new elements by extrusion of the elements with given ids - # @param IDsOfElements list of elements ids for extrusion + ## Generates new elements by extrusion of the elements with given ids + # @param IDsOfElements the list of elements ids for extrusion # @param StepVector vector, defining the direction and value of extrusion # @param NbOfSteps the number of steps - # @param MakeGroups to generate new groups from existing ones - # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @param MakeGroups forces the generation of new groups from existing ones + # @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev def ExtrusionSweep(self, IDsOfElements, StepVector, NbOfSteps, MakeGroups=False): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -1954,16 +2228,18 @@ class Mesh: self.editor.ExtrusionSweep(IDsOfElements, StepVector, NbOfSteps) return [] - ## Generate new elements by extrusion of the elements with given ids + ## Generates new elements by extrusion of the elements with given ids # @param IDsOfElements is ids of elements # @param StepVector vector, defining the direction and value of extrusion # @param NbOfSteps the number of steps - # @param ExtrFlags set flags for performing extrusion + # @param ExtrFlags sets flags for extrusion # @param SewTolerance uses for comparing locations of nodes if flag # EXTRUSION_FLAG_SEW is set - # @param MakeGroups to generate new groups from existing ones + # @param MakeGroups forces the generation of new groups from existing ones # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise - def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps, ExtrFlags, SewTolerance, MakeGroups=False): + # @ingroup l2_modif_extrurev + def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps, + ExtrFlags, SewTolerance, MakeGroups=False): if ( isinstance( StepVector, geompyDC.GEOM._objref_GEOM_Object)): StepVector = self.smeshpyD.GetDirStruct(StepVector) if MakeGroups: @@ -1973,12 +2249,13 @@ class Mesh: ExtrFlags, SewTolerance) return [] - ## Generate new elements by extrusion of the elements belong to object - # @param theObject object wich elements should be processed + ## Generates new elements by extrusion of the elements which belong to the object + # @param theObject the object which elements should be processed # @param StepVector vector, defining the direction and value of extrusion # @param NbOfSteps the number of steps - # @param MakeGroups to generate new groups from existing ones + # @param MakeGroups forces the generation of new groups from existing ones # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev def ExtrusionSweepObject(self, theObject, StepVector, NbOfSteps, MakeGroups=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -1989,12 +2266,13 @@ class Mesh: self.editor.ExtrusionSweepObject(theObject, StepVector, NbOfSteps) return [] - ## Generate new elements by extrusion of the elements belong to object - # @param theObject object wich elements should be processed + ## Generates new elements by extrusion of the elements which belong to the object + # @param theObject object which elements should be processed # @param StepVector vector, defining the direction and value of extrusion # @param NbOfSteps the number of steps # @param MakeGroups to generate new groups from existing ones # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev def ExtrusionSweepObject1D(self, theObject, StepVector, NbOfSteps, MakeGroups=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2005,12 +2283,13 @@ class Mesh: self.editor.ExtrusionSweepObject1D(theObject, StepVector, NbOfSteps) return [] - ## Generate new elements by extrusion of the elements belong to object - # @param theObject object wich elements should be processed + ## Generates new elements by extrusion of the elements which belong to the object + # @param theObject object which elements should be processed # @param StepVector vector, defining the direction and value of extrusion # @param NbOfSteps the number of steps - # @param MakeGroups to generate new groups from existing ones + # @param MakeGroups forces the generation of new groups from existing ones # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_extrurev def ExtrusionSweepObject2D(self, theObject, StepVector, NbOfSteps, MakeGroups=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2021,21 +2300,24 @@ class Mesh: self.editor.ExtrusionSweepObject2D(theObject, StepVector, NbOfSteps) return [] - ## Generate new elements by extrusion of the given elements - # A path of extrusion must be a meshed edge. - # @param IDsOfElements is ids of elements + ## Generates new elements by extrusion of the given elements + # The path of extrusion must be a meshed edge. + # @param IDsOfElements ids of elements # @param PathMesh mesh containing a 1D sub-mesh on the edge, along which proceeds the extrusion - # @param PathShape is shape(edge); as the mesh can be complex, the edge is used to define the sub-mesh for the path - # @param NodeStart the first or the last node on the edge. It is used to define the direction of extrusion - # @param HasAngles allows the shape to be rotated around the path to get the resulting mesh in a helical fashion + # @param PathShape shape(edge) defines the sub-mesh for the path + # @param NodeStart the first or the last node on the edge. Defines the direction of extrusion + # @param HasAngles allows the shape to be rotated around the path + # to get the resulting mesh in a helical fashion # @param Angles list of angles - # @param HasRefPoint allows to use base point - # @param RefPoint point around which the shape is rotated(the mass center of the shape by default). - # User can specify any point as the Base Point and the shape will be rotated with respect to this point. - # @param MakeGroups to generate new groups from existing ones - # @param LinearVariation makes compute rotation angles as linear variation of given Angles along path steps + # @param HasRefPoint allows using the reference point + # @param RefPoint the point around which the shape is rotated (the mass center of the shape by default). + # The User can specify any point as the Reference Point. + # @param MakeGroups forces the generation of new groups from existing ones + # @param LinearVariation forces the computation of rotation angles as linear + # variation of the given Angles along path steps # @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True, # only SMESH::Extrusion_Error otherwise + # @ingroup l2_modif_extrurev def ExtrusionAlongPath(self, IDsOfElements, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint, MakeGroups=False, LinearVariation=False): @@ -2044,28 +2326,36 @@ class Mesh: if ( isinstance( RefPoint, geompyDC.GEOM._objref_GEOM_Object)): RefPoint = self.smeshpyD.GetPointStruct(RefPoint) pass + if ( isinstance( PathMesh, Mesh )): + PathMesh = PathMesh.GetMesh() + if HasAngles and Angles and LinearVariation: + Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) + pass if MakeGroups: - return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh.GetMesh(), + return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh.GetMesh(), PathShape, + return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint) - ## Generate new elements by extrusion of the elements belong to object - # A path of extrusion must be a meshed edge. - # @param IDsOfElements is ids of elements - # @param PathMesh mesh containing a 1D sub-mesh on the edge, along which proceeds the extrusion - # @param PathShape is shape(edge); as the mesh can be complex, the edge is used to define the sub-mesh for the path - # @param NodeStart the first or the last node on the edge. It is used to define the direction of extrusion - # @param HasAngles allows the shape to be rotated around the path to get the resulting mesh in a helical fashion + ## Generates new elements by extrusion of the elements which belong to the object + # The path of extrusion must be a meshed edge. + # @param theObject the object which elements should be processed + # @param PathMesh mesh containing a 1D sub-mesh on the edge, along which the extrusion proceeds + # @param PathShape shape(edge) defines the sub-mesh for the path + # @param NodeStart the first or the last node on the edge. Defines the direction of extrusion + # @param HasAngles allows the shape to be rotated around the path + # to get the resulting mesh in a helical fashion # @param Angles list of angles - # @param HasRefPoint allows to use base point - # @param RefPoint point around which the shape is rotated(the mass center of the shape by default). - # User can specify any point as the Base Point and the shape will be rotated with respect to this point. - # @param MakeGroups to generate new groups from existing ones - # @param LinearVariation makes compute rotation angles as linear variation of given Angles along path steps + # @param HasRefPoint allows using the reference point + # @param RefPoint the point around which the shape is rotated (the mass center of the shape by default). + # The User can specify any point as the Reference Point. + # @param MakeGroups forces the generation of new groups from existing ones + # @param LinearVariation forces the computation of rotation angles as linear + # variation of the given Angles along path steps # @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error if MakeGroups=True, # only SMESH::Extrusion_Error otherwise + # @ingroup l2_modif_extrurev def ExtrusionAlongPathObject(self, theObject, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint, MakeGroups=False, LinearVariation=False): @@ -2073,22 +2363,28 @@ class Mesh: theObject = theObject.GetMesh() if ( isinstance( RefPoint, geompyDC.GEOM._objref_GEOM_Object)): RefPoint = self.smeshpyD.GetPointStruct(RefPoint) + if ( isinstance( PathMesh, Mesh )): + PathMesh = PathMesh.GetMesh() + if HasAngles and Angles and LinearVariation: + Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) + pass if MakeGroups: - return self.editor.ExtrusionAlongPathObjectMakeGroups(theObject, PathMesh.GetMesh(), + return self.editor.ExtrusionAlongPathObjectMakeGroups(theObject, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPathObject(theObject, PathMesh.GetMesh(), PathShape, + return self.editor.ExtrusionAlongPathObject(theObject, PathMesh, PathShape, NodeStart, HasAngles, Angles, HasRefPoint, RefPoint) - ## Symmetrical copy of mesh elements + ## Creates a symmetrical copy of mesh elements # @param IDsOfElements list of elements ids # @param Mirror is AxisStruct or geom object(point, line, plane) # @param theMirrorType is POINT, AXIS or PLANE - # If the Mirror is geom object this parameter is unnecessary - # @param Copy allows to copy element(Copy is 1) or to replace with its mirroring(Copy is 0) - # @param MakeGroups to generate new groups from existing ones (if Copy) + # If the Mirror is a geom object this parameter is unnecessary + # @param Copy allows to copy element (Copy is 1) or to replace with its mirroring (Copy is 0) + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def Mirror(self, IDsOfElements, Mirror, theMirrorType, Copy=0, MakeGroups=False): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2099,14 +2395,15 @@ class Mesh: self.editor.Mirror(IDsOfElements, Mirror, theMirrorType, Copy) return [] - ## Create a new mesh by symmetrical copy of mesh elements - # @param IDsOfElements list of elements ids - # @param Mirror is AxisStruct or geom object(point, line, plane) + ## Creates a new mesh by a symmetrical copy of mesh elements + # @param IDsOfElements the list of elements ids + # @param Mirror is AxisStruct or geom object (point, line, plane) # @param theMirrorType is POINT, AXIS or PLANE - # If the Mirror is geom object this parameter is unnecessary + # If the Mirror is a geom object this parameter is unnecessary # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + # @param NewMeshName a name of the new mesh to create # @return instance of Mesh class + # @ingroup l2_modif_trsf def MirrorMakeMesh(self, IDsOfElements, Mirror, theMirrorType, MakeGroups=0, NewMeshName=""): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2116,14 +2413,15 @@ class Mesh: MakeGroups, NewMeshName) return Mesh(self.smeshpyD,self.geompyD,mesh) - ## Symmetrical copy of object + ## Creates a symmetrical copy of the object # @param theObject mesh, submesh or group - # @param Mirror is AxisStruct or geom object(point, line, plane) + # @param Mirror AxisStruct or geom object (point, line, plane) # @param theMirrorType is POINT, AXIS or PLANE - # If the Mirror is geom object this parameter is unnecessary - # @param Copy allows to copy element(Copy is 1) or to replace with its mirroring(Copy is 0) - # @param MakeGroups to generate new groups from existing ones (if Copy) + # If the Mirror is a geom object this parameter is unnecessary + # @param Copy allows copying the element (Copy is 1) or replacing it with its mirror (Copy is 0) + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def MirrorObject (self, theObject, Mirror, theMirrorType, Copy=0, MakeGroups=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2134,14 +2432,15 @@ class Mesh: self.editor.MirrorObject(theObject, Mirror, theMirrorType, Copy) return [] - ## Create a new mesh by symmetrical copy of object + ## Creates a new mesh by a symmetrical copy of the object # @param theObject mesh, submesh or group - # @param Mirror is AxisStruct or geom object(point, line, plane) - # @param theMirrorType is POINT, AXIS or PLANE - # If the Mirror is geom object this parameter is unnecessary - # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + # @param Mirror AxisStruct or geom object (point, line, plane) + # @param theMirrorType POINT, AXIS or PLANE + # If the Mirror is a geom object this parameter is unnecessary + # @param MakeGroups forces the generation of new groups from existing ones + # @param NewMeshName the name of the new mesh to create # @return instance of Mesh class + # @ingroup l2_modif_trsf def MirrorObjectMakeMesh (self, theObject, Mirror, theMirrorType,MakeGroups=0, NewMeshName=""): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2153,10 +2452,11 @@ class Mesh: ## Translates the elements # @param IDsOfElements list of elements ids - # @param Vector direction of translation(DirStruct or vector) - # @param Copy allows to copy the translated elements - # @param MakeGroups to generate new groups from existing ones (if Copy) + # @param Vector the direction of translation (DirStruct or vector) + # @param Copy allows copying the translated elements + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def Translate(self, IDsOfElements, Vector, Copy, MakeGroups=False): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2167,12 +2467,13 @@ class Mesh: self.editor.Translate(IDsOfElements, Vector, Copy) return [] - ## Create a new mesh of translated elements + ## Creates a new mesh of translated elements # @param IDsOfElements list of elements ids - # @param Vector direction of translation(DirStruct or vector) - # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + # @param Vector the direction of translation (DirStruct or vector) + # @param MakeGroups forces the generation of new groups from existing ones + # @param NewMeshName the name of the newly created mesh # @return instance of Mesh class + # @ingroup l2_modif_trsf def TranslateMakeMesh(self, IDsOfElements, Vector, MakeGroups=False, NewMeshName=""): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2182,11 +2483,12 @@ class Mesh: return Mesh ( self.smeshpyD, self.geompyD, mesh ) ## Translates the object - # @param theObject object to translate(mesh, submesh, or group) - # @param Vector direction of translation(DirStruct or geom vector) - # @param Copy allows to copy the translated elements - # @param MakeGroups to generate new groups from existing ones (if Copy) + # @param theObject the object to translate (mesh, submesh, or group) + # @param Vector direction of translation (DirStruct or geom vector) + # @param Copy allows copying the translated elements + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def TranslateObject(self, theObject, Vector, Copy, MakeGroups=False): if ( isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2197,12 +2499,13 @@ class Mesh: self.editor.TranslateObject(theObject, Vector, Copy) return [] - ## Create a new mesh from translated object - # @param theObject object to translate(mesh, submesh, or group) - # @param Vector direction of translation(DirStruct or geom vector) - # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + ## Creates a new mesh from the translated object + # @param theObject the object to translate (mesh, submesh, or group) + # @param Vector the direction of translation (DirStruct or geom vector) + # @param MakeGroups forces the generation of new groups from existing ones + # @param NewMeshName the name of the newly created mesh # @return instance of Mesh class + # @ingroup l2_modif_trsf def TranslateObjectMakeMesh(self, theObject, Vector, MakeGroups=False, NewMeshName=""): if (isinstance(theObject, Mesh)): theObject = theObject.GetMesh() @@ -2213,11 +2516,12 @@ class Mesh: ## Rotates the elements # @param IDsOfElements list of elements ids - # @param Axis axis of rotation(AxisStruct or geom line) - # @param AngleInRadians angle of rotation(in radians) - # @param Copy allows to copy the rotated elements - # @param MakeGroups to generate new groups from existing ones (if Copy) + # @param Axis the axis of rotation (AxisStruct or geom line) + # @param AngleInRadians the angle of rotation (in radians) + # @param Copy allows copying the rotated elements + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def Rotate (self, IDsOfElements, Axis, AngleInRadians, Copy, MakeGroups=False): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2228,13 +2532,14 @@ class Mesh: self.editor.Rotate(IDsOfElements, Axis, AngleInRadians, Copy) return [] - ## Create a new mesh of rotated elements + ## Creates a new mesh of rotated elements # @param IDsOfElements list of element ids - # @param Axis axis of rotation(AxisStruct or geom line) - # @param AngleInRadians angle of rotation(in radians) - # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + # @param Axis the axis of rotation (AxisStruct or geom line) + # @param AngleInRadians the angle of rotation (in radians) + # @param MakeGroups forces the generation of new groups from existing ones + # @param NewMeshName the name of the newly created mesh # @return instance of Mesh class + # @ingroup l2_modif_trsf def RotateMakeMesh (self, IDsOfElements, Axis, AngleInRadians, MakeGroups=0, NewMeshName=""): if IDsOfElements == []: IDsOfElements = self.GetElementsId() @@ -2245,12 +2550,13 @@ class Mesh: return Mesh( self.smeshpyD, self.geompyD, mesh ) ## Rotates the object - # @param theObject object to rotate(mesh, submesh, or group) - # @param Axis axis of rotation(AxisStruct or geom line) - # @param AngleInRadians angle of rotation(in radians) - # @param Copy allows to copy the rotated elements - # @param MakeGroups to generate new groups from existing ones (if Copy) + # @param theObject the object to rotate( mesh, submesh, or group) + # @param Axis the axis of rotation (AxisStruct or geom line) + # @param AngleInRadians the angle of rotation (in radians) + # @param Copy allows copying the rotated elements + # @param MakeGroups forces the generation of new groups from existing ones (if Copy) # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @ingroup l2_modif_trsf def RotateObject (self, theObject, Axis, AngleInRadians, Copy, MakeGroups=False): if (isinstance(theObject, Mesh)): theObject = theObject.GetMesh() @@ -2261,13 +2567,14 @@ class Mesh: self.editor.RotateObject(theObject, Axis, AngleInRadians, Copy) return [] - ## Create a new mesh from a rotated object - # @param theObject object to rotate (mesh, submesh, or group) - # @param Axis axis of rotation(AxisStruct or geom line) - # @param AngleInRadians angle of rotation(in radians) - # @param MakeGroups to generate new groups from existing ones - # @param NewMeshName is a name of new mesh to create + ## Creates a new mesh from the rotated object + # @param theObject the object to rotate (mesh, submesh, or group) + # @param Axis the axis of rotation (AxisStruct or geom line) + # @param AngleInRadians the angle of rotation (in radians) + # @param MakeGroups forces the generation of new groups from existing ones + # @param NewMeshName the name of the newly created mesh # @return instance of Mesh class + # @ingroup l2_modif_trsf def RotateObjectMakeMesh(self, theObject, Axis, AngleInRadians, MakeGroups=0,NewMeshName=""): if (isinstance( theObject, Mesh )): theObject = theObject.GetMesh() @@ -2277,41 +2584,48 @@ class Mesh: MakeGroups, NewMeshName) return Mesh( self.smeshpyD, self.geompyD, mesh ) - ## Find group of nodes close to each other within Tolerance. - # @param Tolerance tolerance value - # @return list of group of nodes + ## Finds groups of ajacent nodes within Tolerance. + # @param Tolerance the value of tolerance + # @return the list of groups of nodes + # @ingroup l2_modif_trsf def FindCoincidentNodes (self, Tolerance): return self.editor.FindCoincidentNodes(Tolerance) - ## Find group of nodes close to each other within Tolerance. - # @param Tolerance tolerance value + ## Finds groups of ajacent nodes within Tolerance. + # @param Tolerance the value of tolerance # @param SubMeshOrGroup SubMesh or Group - # @return list of group of nodes + # @return the list of groups of nodes + # @ingroup l2_modif_trsf def FindCoincidentNodesOnPart (self, SubMeshOrGroup, Tolerance): return self.editor.FindCoincidentNodesOnPart(SubMeshOrGroup, Tolerance) - ## Merge nodes - # @param GroupsOfNodes list of group of nodes + ## Merges nodes + # @param GroupsOfNodes the list of groups of nodes + # @ingroup l2_modif_trsf def MergeNodes (self, GroupsOfNodes): self.editor.MergeNodes(GroupsOfNodes) - ## Find elements built on the same nodes. + ## Finds the elements built on the same nodes. # @param MeshOrSubMeshOrGroup Mesh or SubMesh, or Group of elements for searching # @return a list of groups of equal elements + # @ingroup l2_modif_trsf def FindEqualElements (self, MeshOrSubMeshOrGroup): return self.editor.FindEqualElements(MeshOrSubMeshOrGroup) - ## Merge elements in each given group. + ## Merges elements in each given group. # @param GroupsOfElementsID groups of elements for merging + # @ingroup l2_modif_trsf def MergeElements(self, GroupsOfElementsID): self.editor.MergeElements(GroupsOfElementsID) - ## Remove all but one of elements built on the same nodes. + ## Leaves one element and removes all other elements built on the same nodes. + # @ingroup l2_modif_trsf def MergeEqualElements(self): self.editor.MergeEqualElements() - ## Sew free borders + ## Sews free borders # @return SMESH::Sew_Error + # @ingroup l2_modif_trsf def SewFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1, FirstNodeID2, SecondNodeID2, LastNodeID2, CreatePolygons, CreatePolyedrs): @@ -2319,27 +2633,30 @@ class Mesh: FirstNodeID2, SecondNodeID2, LastNodeID2, CreatePolygons, CreatePolyedrs) - ## Sew conform free borders + ## Sews conform free borders # @return SMESH::Sew_Error + # @ingroup l2_modif_trsf def SewConformFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1, FirstNodeID2, SecondNodeID2): return self.editor.SewConformFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1, FirstNodeID2, SecondNodeID2) - ## Sew border to side + ## Sews border to side # @return SMESH::Sew_Error + # @ingroup l2_modif_trsf def SewBorderToSide (self, FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder, FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs): return self.editor.SewBorderToSide(FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder, FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs) - ## Sew two sides of a mesh. Nodes belonging to Side1 are - # merged with nodes of elements of Side2. - # Number of elements in theSide1 and in theSide2 must be - # equal and they should have similar node connectivity. - # The nodes to merge should belong to sides borders and + ## Sews two sides of a mesh. The nodes belonging to Side1 are + # merged with the nodes of elements of Side2. + # The number of elements in theSide1 and in theSide2 must be + # equal and they should have similar nodal connectivity. + # The nodes to merge should belong to side borders and # the first node should be linked to the second. # @return SMESH::Sew_Error + # @ingroup l2_modif_trsf def SewSideElements (self, IDsOfSide1Elements, IDsOfSide2Elements, NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge, NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge): @@ -2347,30 +2664,34 @@ class Mesh: NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge, NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge) - ## Set new nodes for given element. + ## Sets new nodes for the given element. # @param ide the element id # @param newIDs nodes ids - # @return If number of nodes is not corresponded to type of element - returns false + # @return If the number of nodes does not correspond to the type of element - returns false + # @ingroup l2_modif_edit def ChangeElemNodes(self, ide, newIDs): return self.editor.ChangeElemNodes(ide, newIDs) - ## If during last operation of MeshEditor some nodes were - # created this method returns list of its IDs, \n - # if new nodes not created - returns empty list - # @return list of integer values (can be empty) + ## If during the last operation of MeshEditor some nodes were + # created, this method returns the list of their IDs, \n + # if new nodes were not created - returns empty list + # @return the list of integer values (can be empty) + # @ingroup l1_auxiliary def GetLastCreatedNodes(self): return self.editor.GetLastCreatedNodes() - ## If during last operation of MeshEditor some elements were - # created this method returns list of its IDs, \n - # if new elements not creared - returns empty list - # @return list of integer values (can be empty) + ## If during the last operation of MeshEditor some elements were + # created this method returns the list of their IDs, \n + # if new elements were not created - returns empty list + # @return the list of integer values (can be empty) + # @ingroup l1_auxiliary def GetLastCreatedElems(self): return self.editor.GetLastCreatedElems() -## Mother class to define algorithm, recommended to do not use directly. +## The mother class to define algorithm, it is not recommended to use it directly. # # More details. +# @ingroup l2_algorithms class Mesh_Algorithm: # @class Mesh_Algorithm # @brief Class Mesh_Algorithm @@ -2383,8 +2704,8 @@ class Mesh_Algorithm: self.subm = None self.algo = None - ## Find hypothesis in study by its type name and parameters. - # Find only those hypothesis, which was created in smeshpyD engine. + ## Finds a hypothesis in the study by its type name and parameters. + # Finds only the hypotheses created in smeshpyD engine. # @return SMESH.SMESH_Hypothesis def FindHypothesis (self, hypname, args, CompareMethod, smeshpyD): study = smeshpyD.GetCurrentStudy() @@ -2392,10 +2713,10 @@ class Mesh_Algorithm: scomp = study.FindComponent(smeshpyD.ComponentDataType()) if scomp is not None: res,hypRoot = scomp.FindSubObject(SMESH.Tag_HypothesisRoot) - # is hypotheses root label exists? + # Check if the root label of the hypotheses exists if res and hypRoot is not None: iter = study.NewChildIterator(hypRoot) - # check all published hypotheses + # Check all published hypotheses while iter.More(): hypo_so_i = iter.Value() attr = hypo_so_i.FindAttribute("AttributeIOR")[1] @@ -2403,14 +2724,14 @@ class Mesh_Algorithm: anIOR = attr.Value() hypo_o_i = salome.orb.string_to_object(anIOR) if hypo_o_i is not None: - # is hypothesis? + # Check if this is a hypothesis hypo_i = hypo_o_i._narrow(SMESH.SMESH_Hypothesis) if hypo_i is not None: - # belongs to this engine? + # Check if the hypothesis belongs to current engine if smeshpyD.GetObjectId(hypo_i) > 0: - # is it the needed hypothesis? + # Check if this is the required hypothesis if hypo_i.GetName() == hypname: - # check args + # Check arguments if CompareMethod(hypo_i, args): # found!!! return hypo_i @@ -2425,8 +2746,8 @@ class Mesh_Algorithm: pass return None - ## Find algorithm in study by its type name. - # Find only those algorithm, which was created in smeshpyD engine. + ## Finds the algorithm in the study by its type name. + # Finds only the algorithms, which have been created in smeshpyD engine. # @return SMESH.SMESH_Algo def FindAlgorithm (self, algoname, smeshpyD): study = smeshpyD.GetCurrentStudy() @@ -2434,10 +2755,10 @@ class Mesh_Algorithm: scomp = study.FindComponent(smeshpyD.ComponentDataType()) if scomp is not None: res,hypRoot = scomp.FindSubObject(SMESH.Tag_AlgorithmsRoot) - # is algorithms root label exists? + # Check if the root label of the algorithms exists if res and hypRoot is not None: iter = study.NewChildIterator(hypRoot) - # check all published algorithms + # Check all published algorithms while iter.More(): algo_so_i = iter.Value() attr = algo_so_i.FindAttribute("AttributeIOR")[1] @@ -2445,12 +2766,12 @@ class Mesh_Algorithm: anIOR = attr.Value() algo_o_i = salome.orb.string_to_object(anIOR) if algo_o_i is not None: - # is algorithm? + # Check if this is an algorithm algo_i = algo_o_i._narrow(SMESH.SMESH_Algo) if algo_i is not None: - # belongs to this engine? + # Checks if the algorithm belongs to the current engine if smeshpyD.GetObjectId(algo_i) > 0: - # is it the needed algorithm? + # Check if this is the required algorithm if algo_i.GetName() == algoname: # found!!! return algo_i @@ -2464,31 +2785,31 @@ class Mesh_Algorithm: pass return None - ## If the algorithm is global, return 0; \n - # else return the submesh associated to this algorithm. + ## If the algorithm is global, returns 0; \n + # else returns the submesh associated to this algorithm. def GetSubMesh(self): return self.subm - ## Return the wrapped mesher. + ## Returns the wrapped mesher. def GetAlgorithm(self): return self.algo - ## Get list of hypothesis that can be used with this algorithm + ## Gets the list of hypothesis that can be used with this algorithm def GetCompatibleHypothesis(self): mylist = [] if self.algo: mylist = self.algo.GetCompatibleHypothesis() return mylist - ## Get name of algo + ## Gets the name of the algorithm def GetName(self): GetName(self.algo) - ## Set name to algo + ## Sets the name to the algorithm def SetName(self, name): SetName(self.algo, name) - ## Get id of algo + ## Gets the id of the algorithm def GetId(self): return self.algo.GetId() @@ -2562,6 +2883,7 @@ class Mesh_Algorithm: ## Class to define a segment 1D algorithm for discretization # # More details. +# @ingroup l3_algos_basic class Mesh_Segment(Mesh_Algorithm): ## Private constructor. @@ -2569,13 +2891,13 @@ class Mesh_Segment(Mesh_Algorithm): Mesh_Algorithm.__init__(self) self.Create(mesh, geom, "Regular_1D") - ## Define "LocalLength" hypothesis to cut an edge in several segments with the same length + ## Defines "LocalLength" hypothesis to cut an edge in several segments with the same length # @param l for the length of segments that cut an edge - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new - # @param p precision, used for number of segments calculation. - # It must be pozitive, meaningfull values are in range [0,1]. - # In general, number of segments is calculated with formula: + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - creates a new one + # @param p precision, used for calculation of the number of segments. + # The precision should be a positive, meaningful value within the range [0,1]. + # In general, the number of segments is calculated with the formula: # nb = ceil((edge_length / l) - p) # Function ceil rounds its argument to the higher integer. # So, p=0 means rounding of (edge_length / l) to the higher integer, @@ -2583,6 +2905,7 @@ class Mesh_Segment(Mesh_Algorithm): # p=1 means rounding of (edge_length / l) to the lower integer. # Default value is 1e-07. # @return an instance of StdMeshers_LocalLength hypothesis + # @ingroup l3_hypos_1dhyps def LocalLength(self, l, UseExisting=0, p=1e-07): hyp = self.Hypothesis("LocalLength", [l,p], UseExisting=UseExisting, CompareMethod=self.CompareLocalLength) @@ -2591,18 +2914,19 @@ class Mesh_Segment(Mesh_Algorithm): return hyp ## Private method - ## Check if the given "LocalLength" hypothesis has the same parameters as given arguments + ## Checks if the given "LocalLength" hypothesis has the same parameters as the given arguments def CompareLocalLength(self, hyp, args): if IsEqual(hyp.GetLength(), args[0]): return IsEqual(hyp.GetPrecision(), args[1]) return False - ## Define "NumberOfSegments" hypothesis to cut an edge in several fixed number of segments + ## Defines "NumberOfSegments" hypothesis to cut an edge in a fixed number of segments # @param n for the number of segments that cut an edge # @param s for the scale factor (optional) - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - create a new one # @return an instance of StdMeshers_NumberOfSegments hypothesis + # @ingroup l3_hypos_1dhyps def NumberOfSegments(self, n, s=[], UseExisting=0): if s == []: hyp = self.Hypothesis("NumberOfSegments", [n], UseExisting=UseExisting, @@ -2616,7 +2940,7 @@ class Mesh_Segment(Mesh_Algorithm): return hyp ## Private method - ## Check if the given "NumberOfSegments" hypothesis has the same parameters as given arguments + ## Checks if the given "NumberOfSegments" hypothesis has the same parameters as the given arguments def CompareNumberOfSegments(self, hyp, args): if hyp.GetNumberOfSegments() == args[0]: if len(args) == 1: @@ -2627,12 +2951,13 @@ class Mesh_Segment(Mesh_Algorithm): return True return False - ## Define "Arithmetic1D" hypothesis to cut an edge in several segments with arithmetic length increasing - # @param start for the length of the first segment - # @param end for the length of the last segment - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + ## Defines "Arithmetic1D" hypothesis to cut an edge in several segments with increasing arithmetic length + # @param start defines the length of the first segment + # @param end defines the length of the last segment + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - creates a new one # @return an instance of StdMeshers_Arithmetic1D hypothesis + # @ingroup l3_hypos_1dhyps def Arithmetic1D(self, start, end, UseExisting=0): hyp = self.Hypothesis("Arithmetic1D", [start, end], UseExisting=UseExisting, CompareMethod=self.CompareArithmetic1D) @@ -2641,19 +2966,20 @@ class Mesh_Segment(Mesh_Algorithm): return hyp ## Private method - ## Check if the given "Arithmetic1D" hypothesis has the same parameters as given arguments + ## Check if the given "Arithmetic1D" hypothesis has the same parameters as the given arguments def CompareArithmetic1D(self, hyp, args): if IsEqual(hyp.GetLength(1), args[0]): if IsEqual(hyp.GetLength(0), args[1]): return True return False - ## Define "StartEndLength" hypothesis to cut an edge in several segments with geometric length increasing - # @param start for the length of the first segment - # @param end for the length of the last segment - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + ## Defines "StartEndLength" hypothesis to cut an edge in several segments with increasing geometric length + # @param start defines the length of the first segment + # @param end defines the length of the last segment + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - creates a new one # @return an instance of StdMeshers_StartEndLength hypothesis + # @ingroup l3_hypos_1dhyps def StartEndLength(self, start, end, UseExisting=0): hyp = self.Hypothesis("StartEndLength", [start, end], UseExisting=UseExisting, CompareMethod=self.CompareStartEndLength) @@ -2661,53 +2987,57 @@ class Mesh_Segment(Mesh_Algorithm): hyp.SetLength(end , 0) return hyp - ## Check if the given "StartEndLength" hypothesis has the same parameters as given arguments + ## Check if the given "StartEndLength" hypothesis has the same parameters as the given arguments def CompareStartEndLength(self, hyp, args): if IsEqual(hyp.GetLength(1), args[0]): if IsEqual(hyp.GetLength(0), args[1]): return True return False - ## Define "Deflection1D" hypothesis + ## Defines "Deflection1D" hypothesis # @param d for the deflection - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - create a new one + # @ingroup l3_hypos_1dhyps def Deflection1D(self, d, UseExisting=0): hyp = self.Hypothesis("Deflection1D", [d], UseExisting=UseExisting, CompareMethod=self.CompareDeflection1D) hyp.SetDeflection(d) return hyp - ## Check if the given "Deflection1D" hypothesis has the same parameters as given arguments + ## Check if the given "Deflection1D" hypothesis has the same parameters as the given arguments def CompareDeflection1D(self, hyp, args): return IsEqual(hyp.GetDeflection(), args[0]) - ## Define "Propagation" hypothesis that propagate all other hypothesis on all others edges that are in - # the opposite side in the case of quadrangular faces + ## Defines "Propagation" hypothesis that propagates all other hypotheses on all other edges that are at + # the opposite side in case of quadrangular faces + # @ingroup l3_hypos_additi def Propagation(self): return self.Hypothesis("Propagation", UseExisting=1, CompareMethod=self.CompareEqualHyp) - ## Define "AutomaticLength" hypothesis + ## Defines "AutomaticLength" hypothesis # @param fineness for the fineness [0-1] - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for an existing hypothesis created with the + # same parameters, else (default) - create a new one + # @ingroup l3_hypos_1dhyps def AutomaticLength(self, fineness=0, UseExisting=0): hyp = self.Hypothesis("AutomaticLength",[fineness],UseExisting=UseExisting, CompareMethod=self.CompareAutomaticLength) hyp.SetFineness( fineness ) return hyp - ## Check if the given "AutomaticLength" hypothesis has the same parameters as given arguments + ## Checks if the given "AutomaticLength" hypothesis has the same parameters as the given arguments def CompareAutomaticLength(self, hyp, args): return IsEqual(hyp.GetFineness(), args[0]) - ## Define "SegmentLengthAroundVertex" hypothesis + ## Defines "SegmentLengthAroundVertex" hypothesis # @param length for the segment length - # @param vertex for the length localization: vertex index [0,1] | vertex object. - # Any other integer value means what hypo will be set on the + # @param vertex for the length localization: the vertex index [0,1] | vertex object. + # Any other integer value means that the hypothesis will be set on the # whole 1D shape, where Mesh_Segment algorithm is assigned. - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for an existing hypothesis created with + # the same parameters, else (default) - creates a new one + # @ingroup l3_algos_segmarv def LengthNearVertex(self, length, vertex=0, UseExisting=0): import types store_geom = self.geom @@ -2741,16 +3071,19 @@ class Mesh_Segment(Mesh_Algorithm): hyp.SetLength( length ) return hyp - ## Check if the given "LengthNearVertex" hypothesis has the same parameters as given arguments + ## Checks if the given "LengthNearVertex" hypothesis has the same parameters as the given arguments + # @ingroup l3_algos_segmarv def CompareLengthNearVertex(self, hyp, args): return IsEqual(hyp.GetLength(), args[0]) - ## Define "QuadraticMesh" hypothesis, forcing construction of quadratic edges. - # If the 2D mesher sees that all boundary edges are quadratic ones, + ## Defines "QuadraticMesh" hypothesis, forcing construction of quadratic edges. + # If the 2D mesher sees that all boundary edges are quadratic, # it generates quadratic faces, else it generates linear faces using - # medium nodes as if they were vertex ones. + # medium nodes as if they are vertices. # The 3D mesher generates quadratic volumes only if all boundary faces - # are quadratic ones, else it fails. + # are quadratic, else it fails. + # + # @ingroup l3_hypos_additi def QuadraticMesh(self): hyp = self.Hypothesis("QuadraticMesh", UseExisting=1, CompareMethod=self.CompareEqualHyp) return hyp @@ -2758,9 +3091,9 @@ class Mesh_Segment(Mesh_Algorithm): # Public class: Mesh_CompositeSegment # -------------------------- -## Class to define a segment 1D algorithm for discretization -# -# More details. +## Defines a segment 1D algorithm for discretization +# +# @ingroup l3_algos_basic class Mesh_CompositeSegment(Mesh_Segment): ## Private constructor. @@ -2771,9 +3104,9 @@ class Mesh_CompositeSegment(Mesh_Segment): # Public class: Mesh_Segment_Python # --------------------------------- -## Class to define a segment 1D algorithm for discretization with python function +## Defines a segment 1D algorithm for discretization with python function # -# More details. +# @ingroup l3_algos_basic class Mesh_Segment_Python(Mesh_Segment): ## Private constructor. @@ -2781,11 +3114,12 @@ class Mesh_Segment_Python(Mesh_Segment): import Python1dPlugin self.Create(mesh, geom, "Python_1D", "libPython1dEngine.so") - ## Define "PythonSplit1D" hypothesis based on the Erwan Adam patch, awaiting equivalent SALOME functionality + ## Defines "PythonSplit1D" hypothesis # @param n for the number of segments that cut an edge - # @param func for the python function that calculate the length of all segments - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param func for the python function that calculates the length of all segments + # @param UseExisting if ==true - searches for the existing hypothesis created with + # the same parameters, else (default) - creates a new one + # @ingroup l3_hypos_1dhyps def PythonSplit1D(self, n, func, UseExisting=0): hyp = self.Hypothesis("PythonSplit1D", [n], "libPython1dEngine.so", UseExisting=UseExisting, CompareMethod=self.ComparePythonSplit1D) @@ -2793,7 +3127,7 @@ class Mesh_Segment_Python(Mesh_Segment): hyp.SetPythonLog10RatioFunction(func) return hyp - ## Check if the given "PythonSplit1D" hypothesis has the same parameters as given arguments + ## Checks if the given "PythonSplit1D" hypothesis has the same parameters as the given arguments def ComparePythonSplit1D(self, hyp, args): #if hyp.GetNumberOfSegments() == args[0]: # if hyp.GetPythonLog10RatioFunction() == args[1]: @@ -2803,9 +3137,9 @@ class Mesh_Segment_Python(Mesh_Segment): # Public class: Mesh_Triangle # --------------------------- -## Class to define a triangle 2D algorithm +## Defines a triangle 2D algorithm # -# More details. +# @ingroup l3_algos_basic class Mesh_Triangle(Mesh_Algorithm): # default values @@ -2826,7 +3160,7 @@ class Mesh_Triangle(Mesh_Algorithm): elif algoType == BLSURF: import BLSURFPlugin self.Create(mesh, geom, "BLSURF", "libBLSURFEngine.so") - self.SetPhysicalMesh() + #self.SetPhysicalMesh() - PAL19680 elif algoType == NETGEN: if noNETGENPlugin: print "Warning: NETGENPlugin module unavailable" @@ -2840,12 +3174,13 @@ class Mesh_Triangle(Mesh_Algorithm): self.Create(mesh, geom, "NETGEN_2D_ONLY", "libNETGENEngine.so") pass - ## Define "MaxElementArea" hypothesis to give the maximum area of each triangle + ## Defines "MaxElementArea" hypothesis basing on the definition of the maximum area of each triangle # @param area for the maximum area of each triangle - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for an existing hypothesis created with the + # same parameters, else (default) - creates a new one # # Only for algoType == MEFISTO || NETGEN_2D + # @ingroup l3_hypos_2dhyps def MaxElementArea(self, area, UseExisting=0): if self.algoType == MEFISTO or self.algoType == NETGEN_2D: hyp = self.Hypothesis("MaxElementArea", [area], UseExisting=UseExisting, @@ -2856,14 +3191,15 @@ class Mesh_Triangle(Mesh_Algorithm): print "Netgen 1D-2D algo doesn't support this hypothesis" return None - ## Check if the given "MaxElementArea" hypothesis has the same parameters as given arguments + ## Checks if the given "MaxElementArea" hypothesis has the same parameters as the given arguments def CompareMaxElementArea(self, hyp, args): return IsEqual(hyp.GetMaxElementArea(), args[0]) - ## Define "LengthFromEdges" hypothesis to build triangles + ## Defines "LengthFromEdges" hypothesis to build triangles # based on the length of the edges taken from the wire # # Only for algoType == MEFISTO || NETGEN_2D + # @ingroup l3_hypos_2dhyps def LengthFromEdges(self): if self.algoType == MEFISTO or self.algoType == NETGEN_2D: hyp = self.Hypothesis("LengthFromEdges", UseExisting=1, CompareMethod=self.CompareEqualHyp) @@ -2872,46 +3208,102 @@ class Mesh_Triangle(Mesh_Algorithm): print "Netgen 1D-2D algo doesn't support this hypothesis" return None - ## Set PhysicalMesh - # @param thePhysicalMesh is: - # DefaultSize or Custom - def SetPhysicalMesh(self, thePhysicalMesh=1): - if self.params == 0: - self.Parameters() - self.params.SetPhysicalMesh(thePhysicalMesh) + ## Sets a way to define size of mesh elements to generate. + # @param thePhysicalMesh is: DefaultSize or Custom. + # @ingroup l3_hypos_blsurf + def SetPhysicalMesh(self, thePhysicalMesh=DefaultSize): + # Parameter of BLSURF algo + self.Parameters().SetPhysicalMesh(thePhysicalMesh) - ## Set PhySize flag + ## Sets size of mesh elements to generate. + # @ingroup l3_hypos_blsurf def SetPhySize(self, theVal): - if self.params == 0: - self.Parameters() - self.params.SetPhySize(theVal) - - ## Set GeometricMesh - # @param theGeometricMesh is: - # DefaultGeom or Custom + # Parameter of BLSURF algo + self.Parameters().SetPhySize(theVal) + + ## Sets lower boundary of mesh element size (PhySize). + # @ingroup l3_hypos_blsurf + def SetPhyMin(self, theVal=-1): + # Parameter of BLSURF algo + self.Parameters().SetPhyMin(theVal) + + ## Sets upper boundary of mesh element size (PhySize). + # @ingroup l3_hypos_blsurf + def SetPhyMax(self, theVal=-1): + # Parameter of BLSURF algo + self.Parameters().SetPhyMax(theVal) + + ## Sets a way to define maximum angular deflection of mesh from CAD model. + # @param theGeometricMesh is: DefaultGeom or Custom + # @ingroup l3_hypos_blsurf def SetGeometricMesh(self, theGeometricMesh=0): - if self.params == 0: - self.Parameters() - if self.params.GetPhysicalMesh() == 0: theGeometricMesh = 1 + # Parameter of BLSURF algo + if self.Parameters().GetPhysicalMesh() == 0: theGeometricMesh = 1 self.params.SetGeometricMesh(theGeometricMesh) - ## Set AngleMeshS flag + ## Sets angular deflection (in degrees) of a mesh face from CAD surface. + # @ingroup l3_hypos_blsurf def SetAngleMeshS(self, theVal=_angleMeshS): - if self.params == 0: - self.Parameters() - if self.params.GetGeometricMesh() == 0: theVal = self._angleMeshS + # Parameter of BLSURF algo + if self.Parameters().GetGeometricMesh() == 0: theVal = self._angleMeshS self.params.SetAngleMeshS(theVal) - ## Set Gradation flag + ## Sets angular deflection (in degrees) of a mesh edge from CAD curve. + # @ingroup l3_hypos_blsurf + def SetAngleMeshC(self, theVal=_angleMeshS): + # Parameter of BLSURF algo + if self.Parameters().GetGeometricMesh() == 0: theVal = self._angleMeshS + self.params.SetAngleMeshC(theVal) + + ## Sets lower boundary of mesh element size computed to respect angular deflection. + # @ingroup l3_hypos_blsurf + def SetGeoMin(self, theVal=-1): + # Parameter of BLSURF algo + self.Parameters().SetGeoMin(theVal) + + ## Sets upper boundary of mesh element size computed to respect angular deflection. + # @ingroup l3_hypos_blsurf + def SetGeoMax(self, theVal=-1): + # Parameter of BLSURF algo + self.Parameters().SetGeoMax(theVal) + + ## Sets maximal allowed ratio between the lengths of two adjacent edges. + # @ingroup l3_hypos_blsurf def SetGradation(self, theVal=_gradation): - if self.params == 0: - self.Parameters() - if self.params.GetGeometricMesh() == 0: theVal = self._gradation + # Parameter of BLSURF algo + if self.Parameters().GetGeometricMesh() == 0: theVal = self._gradation self.params.SetGradation(theVal) - ## Set QuadAllowed flag - # - # Only for algoType == NETGEN || NETGEN_2D + ## Sets topology usage way. + # @param way defines how mesh conformity is assured
    + #
  • FromCAD - mesh conformity is assured by conformity of a shape
    • + #
  • PreProcess or PreProcessPlus - by pre-processing a CAD model
+ # @ingroup l3_hypos_blsurf + def SetTopology(self, way): + # Parameter of BLSURF algo + self.Parameters().SetTopology(way) + + ## To respect geometrical edges or not. + # @ingroup l3_hypos_blsurf + def SetDecimesh(self, toIgnoreEdges=False): + # Parameter of BLSURF algo + self.Parameters().SetDecimesh(toIgnoreEdges) + + ## Sets verbosity level in the range 0 to 100. + # @ingroup l3_hypos_blsurf + def SetVerbosity(self, level): + # Parameter of BLSURF algo + self.Parameters().SetVerbosity(level) + + ## Sets advanced option value. + # @ingroup l3_hypos_blsurf + def SetOptionValue(self, optionName, level): + # Parameter of BLSURF algo + self.Parameters().SetOptionValue(optionName,level) + + ## Sets QuadAllowed flag. + # Only for algoType == NETGEN || NETGEN_2D || BLSURF + # @ingroup l3_hypos_netgen l3_hypos_blsurf def SetQuadAllowed(self, toAllow=True): if self.algoType == NETGEN_2D: if toAllow: # add QuadranglePreference @@ -2924,16 +3316,17 @@ class Mesh_Triangle(Mesh_Algorithm): pass pass return - if self.params == 0: - self.Parameters() - if self.params: + if self.Parameters(): self.params.SetQuadAllowed(toAllow) return - ## Define "Netgen 2D Parameters" hypothesis + ## Defines "Netgen 2D Parameters" hypothesis # - # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def Parameters(self): + # Only for algoType == NETGEN + if self.params: + return self.params if self.algoType == NETGEN: self.params = self.Hypothesis("NETGEN_Parameters_2D", [], "libNETGENEngine.so", UseExisting=0) @@ -2951,86 +3344,73 @@ class Mesh_Triangle(Mesh_Algorithm): return self.params return None - ## Set MaxSize + ## Sets MaxSize # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetMaxSize(self, theSize): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetMaxSize(theSize) - ## Set SecondOrder flag + ## Sets SecondOrder flag # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetSecondOrder(self, theVal): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetSecondOrder(theVal) - ## Set Optimize flag + ## Sets Optimize flag # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetOptimize(self, theVal): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetOptimize(theVal) - ## Set Fineness + ## Sets Fineness # @param theFineness is: # VeryCoarse, Coarse, Moderate, Fine, VeryFine or Custom # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetFineness(self, theFineness): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetFineness(theFineness) - ## Set GrowthRate + ## Sets GrowthRate # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetGrowthRate(self, theRate): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetGrowthRate(theRate) - ## Set NbSegPerEdge + ## Sets NbSegPerEdge # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetNbSegPerEdge(self, theVal): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetNbSegPerEdge(theVal) - ## Set NbSegPerRadius + ## Sets NbSegPerRadius # # Only for algoType == NETGEN + # @ingroup l3_hypos_netgen def SetNbSegPerRadius(self, theVal): - if self.params == 0: - self.Parameters() - if self.params is not None: + if self.Parameters(): self.params.SetNbSegPerRadius(theVal) - ## Set Decimesh flag - def SetDecimesh(self, toAllow=False): - if self.params == 0: - self.Parameters() - self.params.SetDecimesh(toAllow) - pass # Public class: Mesh_Quadrangle # ----------------------------- -## Class to define a quadrangle 2D algorithm +## Defines a quadrangle 2D algorithm # -# More details. +# @ingroup l3_algos_basic class Mesh_Quadrangle(Mesh_Algorithm): ## Private constructor. @@ -3038,20 +3418,32 @@ class Mesh_Quadrangle(Mesh_Algorithm): Mesh_Algorithm.__init__(self) self.Create(mesh, geom, "Quadrangle_2D") - ## Define "QuadranglePreference" hypothesis, forcing construction - # of quadrangles if the number of nodes on opposite edges is not the same - # in the case where the global number of nodes on edges is even + ## Defines "QuadranglePreference" hypothesis, forcing construction + # of quadrangles if the number of nodes on the opposite edges is not the same + # while the total number of nodes on edges is even + # + # @ingroup l3_hypos_additi def QuadranglePreference(self): hyp = self.Hypothesis("QuadranglePreference", UseExisting=1, CompareMethod=self.CompareEqualHyp) return hyp + ## Defines "TrianglePreference" hypothesis, forcing construction + # of triangles in the refinement area if the number of nodes + # on the opposite edges is not the same + # + # @ingroup l3_hypos_additi + def TrianglePreference(self): + hyp = self.Hypothesis("TrianglePreference", UseExisting=1, + CompareMethod=self.CompareEqualHyp) + return hyp + # Public class: Mesh_Tetrahedron # ------------------------------ -## Class to define a tetrahedron 3D algorithm +## Defines a tetrahedron 3D algorithm # -# More details. +# @ingroup l3_algos_basic class Mesh_Tetrahedron(Mesh_Algorithm): params = 0 @@ -3065,93 +3457,172 @@ class Mesh_Tetrahedron(Mesh_Algorithm): self.Create(mesh, geom, "NETGEN_3D", "libNETGENEngine.so") pass - elif algoType == GHS3D: - import GHS3DPlugin - self.Create(mesh, geom, "GHS3D_3D" , "libGHS3DEngine.so") - pass - elif algoType == FULL_NETGEN: if noNETGENPlugin: print "Warning: NETGENPlugin module has not been imported." self.Create(mesh, geom, "NETGEN_2D3D", "libNETGENEngine.so") pass + elif algoType == GHS3D: + import GHS3DPlugin + self.Create(mesh, geom, "GHS3D_3D" , "libGHS3DEngine.so") + pass + self.algoType = algoType - ## Define "MaxElementVolume" hypothesis to give the maximun volume of each tetrahedral - # @param vol for the maximum volume of each tetrahedral - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + ## Defines "MaxElementVolume" hypothesis to give the maximun volume of each tetrahedron + # @param vol for the maximum volume of each tetrahedron + # @param UseExisting if ==true - searches for the existing hypothesis created with + # the same parameters, else (default) - creates a new one + # @ingroup l3_hypos_maxvol def MaxElementVolume(self, vol, UseExisting=0): hyp = self.Hypothesis("MaxElementVolume", [vol], UseExisting=UseExisting, CompareMethod=self.CompareMaxElementVolume) hyp.SetMaxElementVolume(vol) return hyp - ## Check if the given "MaxElementVolume" hypothesis has the same parameters as given arguments + ## Checks if the given "MaxElementVolume" hypothesis has the same parameters as the given arguments def CompareMaxElementVolume(self, hyp, args): return IsEqual(hyp.GetMaxElementVolume(), args[0]) - ## Define "Netgen 3D Parameters" hypothesis + ## Defines "Netgen 3D Parameters" hypothesis + # @ingroup l3_hypos_netgen def Parameters(self): + if self.params: + return self.params if (self.algoType == FULL_NETGEN): self.params = self.Hypothesis("NETGEN_Parameters", [], "libNETGENEngine.so", UseExisting=0) return self.params - else: - print "Algo doesn't support this hypothesis" - return None + if (self.algoType == GHS3D): + self.params = self.Hypothesis("GHS3D_Parameters", [], + "libGHS3DEngine.so", UseExisting=0) + return self.params + + print "Algo doesn't support this hypothesis" + return None - ## Set MaxSize + ## Sets MaxSize + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetMaxSize(self, theSize): - if self.params == 0: - self.Parameters() - self.params.SetMaxSize(theSize) + self.Parameters().SetMaxSize(theSize) - ## Set SecondOrder flag + ## Sets SecondOrder flag + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetSecondOrder(self, theVal): - if self.params == 0: - self.Parameters() - self.params.SetSecondOrder(theVal) + self.Parameters().SetSecondOrder(theVal) - ## Set Optimize flag + ## Sets Optimize flag + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetOptimize(self, theVal): - if self.params == 0: - self.Parameters() - self.params.SetOptimize(theVal) + self.Parameters().SetOptimize(theVal) - ## Set Fineness + ## Sets Fineness # @param theFineness is: # VeryCoarse, Coarse, Moderate, Fine, VeryFine or Custom + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetFineness(self, theFineness): - if self.params == 0: - self.Parameters() - self.params.SetFineness(theFineness) + self.Parameters().SetFineness(theFineness) - ## Set GrowthRate + ## Sets GrowthRate + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetGrowthRate(self, theRate): - if self.params == 0: - self.Parameters() - self.params.SetGrowthRate(theRate) + self.Parameters().SetGrowthRate(theRate) - ## Set NbSegPerEdge + ## Sets NbSegPerEdge + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetNbSegPerEdge(self, theVal): - if self.params == 0: - self.Parameters() - self.params.SetNbSegPerEdge(theVal) + self.Parameters().SetNbSegPerEdge(theVal) - ## Set NbSegPerRadius + ## Sets NbSegPerRadius + # Parameter of FULL_NETGEN + # @ingroup l3_hypos_netgen def SetNbSegPerRadius(self, theVal): - if self.params == 0: - self.Parameters() - self.params.SetNbSegPerRadius(theVal) + self.Parameters().SetNbSegPerRadius(theVal) + + ## To mesh "holes" in a solid or not. Default is to mesh. + # @ingroup l3_hypos_ghs3dh + def SetToMeshHoles(self, toMesh): + # Parameter of GHS3D + self.Parameters().SetToMeshHoles(toMesh) + + ## Set Optimization level: + # None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization. + # Default is Medium_Optimization + # @ingroup l3_hypos_ghs3dh + def SetOptimizationLevel(self, level): + # Parameter of GHS3D + self.Parameters().SetOptimizationLevel(level) + + ## Maximal size of memory to be used by the algorithm (in Megabytes). + # @ingroup l3_hypos_ghs3dh + def SetMaximumMemory(self, MB): + # Advanced parameter of GHS3D + self.Parameters().SetMaximumMemory(MB) + + ## Initial size of memory to be used by the algorithm (in Megabytes) in + # automatic memory adjustment mode. + # @ingroup l3_hypos_ghs3dh + def SetInitialMemory(self, MB): + # Advanced parameter of GHS3D + self.Parameters().SetInitialMemory(MB) + + ## Path to working directory. + # @ingroup l3_hypos_ghs3dh + def SetWorkingDirectory(self, path): + # Advanced parameter of GHS3D + self.Parameters().SetWorkingDirectory(path) + + ## To keep working files or remove them. Log file remains in case of errors anyway. + # @ingroup l3_hypos_ghs3dh + def SetKeepFiles(self, toKeep): + # Advanced parameter of GHS3D + self.Parameters().SetKeepFiles(toKeep) + + ## To set verbose level [0-10].
    + #
  • 0 - no standard output, + #
  • 2 - prints the data, quality statistics of the skin and final meshes and + # indicates when the final mesh is being saved. In addition the software + # gives indication regarding the CPU time. + #
  • 10 - same as 2 plus the main steps in the computation, quality statistics + # histogram of the skin mesh, quality statistics histogram together with + # the characteristics of the final mesh.
+ # @ingroup l3_hypos_ghs3dh + def SetVerboseLevel(self, level): + # Advanced parameter of GHS3D + self.Parameters().SetVerboseLevel(level) + + ## To create new nodes. + # @ingroup l3_hypos_ghs3dh + def SetToCreateNewNodes(self, toCreate): + # Advanced parameter of GHS3D + self.Parameters().SetToCreateNewNodes(toCreate) + + ## To use boundary recovery version which tries to create mesh on a very poor + # quality surface mesh. + # @ingroup l3_hypos_ghs3dh + def SetToUseBoundaryRecoveryVersion(self, toUse): + # Advanced parameter of GHS3D + self.Parameters().SetToUseBoundaryRecoveryVersion(toUse) + + ## Sets command line option as text. + # @ingroup l3_hypos_ghs3dh + def SetTextOption(self, option): + # Advanced parameter of GHS3D + self.Parameters().SetTextOption(option) # Public class: Mesh_Hexahedron # ------------------------------ -## Class to define a hexahedron 3D algorithm +## Defines a hexahedron 3D algorithm # -# More details. +# @ingroup l3_algos_basic class Mesh_Hexahedron(Mesh_Algorithm): params = 0 @@ -3172,7 +3643,8 @@ class Mesh_Hexahedron(Mesh_Algorithm): self.Create(mesh, geom, "Hexotic_3D", "libHexoticEngine.so") pass - ## Define "MinMaxQuad" hypothesis to give the three hexotic parameters + ## Defines "MinMaxQuad" hypothesis to give three hexotic parameters + # @ingroup l3_hypos_hexotic def MinMaxQuad(self, min=3, max=8, quad=True): self.params = self.Hypothesis("Hexotic_Parameters", [], "libHexoticEngine.so", UseExisting=0) @@ -3185,12 +3657,13 @@ class Mesh_Hexahedron(Mesh_Algorithm): # Public class: Mesh_Netgen # ------------------------------ -## Class to define a NETGEN-based 2D or 3D algorithm -# that need no discrete boundary (i.e. independent) +## Defines a NETGEN-based 2D or 3D algorithm +# that needs no discrete boundary (i.e. independent) # # This class is deprecated, only for compatibility! # # More details. +# @ingroup l3_algos_basic class Mesh_Netgen(Mesh_Algorithm): is3D = 0 @@ -3211,7 +3684,7 @@ class Mesh_Netgen(Mesh_Algorithm): self.Create(mesh, geom, "NETGEN_2D", "libNETGENEngine.so") pass - ## Define hypothesis containing parameters of the algorithm + ## Defines the hypothesis containing parameters of the algorithm def Parameters(self): if self.is3D: hyp = self.Hypothesis("NETGEN_Parameters", [], @@ -3224,9 +3697,9 @@ class Mesh_Netgen(Mesh_Algorithm): # Public class: Mesh_Projection1D # ------------------------------ -## Class to define a projection 1D algorithm +## Defines a projection 1D algorithm +# @ingroup l3_algos_proj # -# More details. class Mesh_Projection1D(Mesh_Algorithm): ## Private constructor. @@ -3234,16 +3707,16 @@ class Mesh_Projection1D(Mesh_Algorithm): Mesh_Algorithm.__init__(self) self.Create(mesh, geom, "Projection_1D") - ## Define "Source Edge" hypothesis, specifying a meshed edge to - # take a mesh pattern from, and optionally association of vertices - # between the source edge and a target one (where a hipothesis is assigned to) - # @param edge to take nodes distribution from - # @param mesh to take nodes distribution from (optional) - # @param srcV is vertex of \a edge to associate with \a tgtV (optional) - # @param tgtV is vertex of \a the edge where the algorithm is assigned, + ## Defines "Source Edge" hypothesis, specifying a meshed edge, from where + # a mesh pattern is taken, and, optionally, the association of vertices + # between the source edge and a target edge (to which a hypothesis is assigned) + # @param edge from which nodes distribution is taken + # @param mesh from which nodes distribution is taken (optional) + # @param srcV a vertex of \a edge to associate with \a tgtV (optional) + # @param tgtV a vertex of \a the edge to which the algorithm is assigned, # to associate with \a srcV (optional) - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting if ==true - searches for the existing hypothesis created with + # the same parameters, else (default) - creates a new one def SourceEdge(self, edge, mesh=None, srcV=None, tgtV=None, UseExisting=0): hyp = self.Hypothesis("ProjectionSource1D", [edge,mesh,srcV,tgtV], UseExisting=0) @@ -3255,18 +3728,18 @@ class Mesh_Projection1D(Mesh_Algorithm): hyp.SetVertexAssociation( srcV, tgtV ) return hyp - ## Check if the given "SourceEdge" hypothesis has the same parameters as given arguments + ## Checks if the given "SourceEdge" hypothesis has the same parameters as the given arguments #def CompareSourceEdge(self, hyp, args): - # # seems to be not really useful to reuse existing "SourceEdge" hypothesis + # # it does not seem to be useful to reuse the existing "SourceEdge" hypothesis # return False # Public class: Mesh_Projection2D # ------------------------------ -## Class to define a projection 2D algorithm +## Defines a projection 2D algorithm +# @ingroup l3_algos_proj # -# More details. class Mesh_Projection2D(Mesh_Algorithm): ## Private constructor. @@ -3274,21 +3747,21 @@ class Mesh_Projection2D(Mesh_Algorithm): Mesh_Algorithm.__init__(self) self.Create(mesh, geom, "Projection_2D") - ## Define "Source Face" hypothesis, specifying a meshed face to - # take a mesh pattern from, and optionally association of vertices - # between the source face and a target one (where a hipothesis is assigned to) - # @param face to take mesh pattern from - # @param mesh to take mesh pattern from (optional) - # @param srcV1 is vertex of \a face to associate with \a tgtV1 (optional) - # @param tgtV1 is vertex of \a the face where the algorithm is assigned, - # to associate with \a srcV1 (optional) - # @param srcV2 is vertex of \a face to associate with \a tgtV1 (optional) - # @param tgtV2 is vertex of \a the face where the algorithm is assigned, - # to associate with \a srcV2 (optional) - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + ## Defines "Source Face" hypothesis, specifying a meshed face, from where + # a mesh pattern is taken, and, optionally, the association of vertices + # between the source face and the target face (to which a hypothesis is assigned) + # @param face from which the mesh pattern is taken + # @param mesh from which the mesh pattern is taken (optional) + # @param srcV1 a vertex of \a face to associate with \a tgtV1 (optional) + # @param tgtV1 a vertex of \a the face to which the algorithm is assigned, + # to associate with \a srcV1 (optional) + # @param srcV2 a vertex of \a face to associate with \a tgtV1 (optional) + # @param tgtV2 a vertex of \a the face to which the algorithm is assigned, + # to associate with \a srcV2 (optional) + # @param UseExisting if ==true - forces the search for the existing hypothesis created with + # the same parameters, else (default) - forces the creation a new one # - # Note: association vertices must belong to one edge of a face + # Note: all association vertices must belong to one edge of a face def SourceFace(self, face, mesh=None, srcV1=None, tgtV1=None, srcV2=None, tgtV2=None, UseExisting=0): hyp = self.Hypothesis("ProjectionSource2D", [face,mesh,srcV1,tgtV1,srcV2,tgtV2], @@ -3301,17 +3774,17 @@ class Mesh_Projection2D(Mesh_Algorithm): hyp.SetVertexAssociation( srcV1, srcV2, tgtV1, tgtV2 ) return hyp - ## Check if the given "SourceFace" hypothesis has the same parameters as given arguments + ## Checks if the given "SourceFace" hypothesis has the same parameters as the given arguments #def CompareSourceFace(self, hyp, args): - # # seems to be not really useful to reuse existing "SourceFace" hypothesis + # # it does not seem to be useful to reuse the existing "SourceFace" hypothesis # return False # Public class: Mesh_Projection3D # ------------------------------ -## Class to define a projection 3D algorithm +## Defines a projection 3D algorithm +# @ingroup l3_algos_proj # -# More details. class Mesh_Projection3D(Mesh_Algorithm): ## Private constructor. @@ -3319,19 +3792,19 @@ class Mesh_Projection3D(Mesh_Algorithm): Mesh_Algorithm.__init__(self) self.Create(mesh, geom, "Projection_3D") - ## Define "Source Shape 3D" hypothesis, specifying a meshed solid to - # take a mesh pattern from, and optionally association of vertices - # between the source solid and a target one (where a hipothesis is assigned to) - # @param solid to take mesh pattern from - # @param mesh to take mesh pattern from (optional) - # @param srcV1 is vertex of \a solid to associate with \a tgtV1 (optional) - # @param tgtV1 is vertex of \a the solid where the algorithm is assigned, + ## Defines the "Source Shape 3D" hypothesis, specifying a meshed solid, from where + # the mesh pattern is taken, and, optionally, the association of vertices + # between the source and the target solid (to which a hipothesis is assigned) + # @param solid from where the mesh pattern is taken + # @param mesh from where the mesh pattern is taken (optional) + # @param srcV1 a vertex of \a solid to associate with \a tgtV1 (optional) + # @param tgtV1 a vertex of \a the solid where the algorithm is assigned, # to associate with \a srcV1 (optional) - # @param srcV2 is vertex of \a solid to associate with \a tgtV1 (optional) - # @param tgtV2 is vertex of \a the solid where the algorithm is assigned, + # @param srcV2 a vertex of \a solid to associate with \a tgtV1 (optional) + # @param tgtV2 a vertex of \a the solid to which the algorithm is assigned, # to associate with \a srcV2 (optional) - # @param UseExisting - if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param UseExisting - if ==true - searches for the existing hypothesis created with + # the same parameters, else (default) - creates a new one # # Note: association vertices must belong to one edge of a solid def SourceShape3D(self, solid, mesh=0, srcV1=0, tgtV1=0, @@ -3347,7 +3820,7 @@ class Mesh_Projection3D(Mesh_Algorithm): hyp.SetVertexAssociation( srcV1, srcV2, tgtV1, tgtV2 ) return hyp - ## Check if the given "SourceShape3D" hypothesis has the same parameters as given arguments + ## Checks if the given "SourceShape3D" hypothesis has the same parameters as given arguments #def CompareSourceShape3D(self, hyp, args): # # seems to be not really useful to reuse existing "SourceShape3D" hypothesis # return False @@ -3356,9 +3829,9 @@ class Mesh_Projection3D(Mesh_Algorithm): # Public class: Mesh_Prism # ------------------------ -## Class to define a 3D extrusion algorithm +## Defines a 3D extrusion algorithm +# @ingroup l3_algos_3dextr # -# More details. class Mesh_Prism3D(Mesh_Algorithm): ## Private constructor. @@ -3369,9 +3842,9 @@ class Mesh_Prism3D(Mesh_Algorithm): # Public class: Mesh_RadialPrism # ------------------------------- -## Class to define a Radial Prism 3D algorithm +## Defines a Radial Prism 3D algorithm +# @ingroup l3_algos_radialp # -# More details. class Mesh_RadialPrism3D(Mesh_Algorithm): ## Private constructor. @@ -3386,23 +3859,24 @@ class Mesh_RadialPrism3D(Mesh_Algorithm): def Get3DHypothesis(self): return self.distribHyp - ## Private method creating 1D hypothes and storing it in the LayerDistribution - # hypothes. Returns the created hypothes + ## Private method creating a 1D hypothesis and storing it in the LayerDistribution + # hypothesis. Returns the created hypothesis def OwnHypothesis(self, hypType, args=[], so="libStdMeshersEngine.so"): #print "OwnHypothesis",hypType if not self.nbLayers is None: self.mesh.GetMesh().RemoveHypothesis( self.geom, self.nbLayers ) self.mesh.GetMesh().AddHypothesis( self.geom, self.distribHyp ) - study = self.mesh.smeshpyD.GetCurrentStudy() # prevent publishing of own 1D hypothesis + study = self.mesh.smeshpyD.GetCurrentStudy() # prevents publishing own 1D hypothesis hyp = self.mesh.smeshpyD.CreateHypothesis(hypType, so) - self.mesh.smeshpyD.SetCurrentStudy( study ) # anable publishing + self.mesh.smeshpyD.SetCurrentStudy( study ) # enables publishing self.distribHyp.SetLayerDistribution( hyp ) return hyp - ## Define "NumberOfLayers" hypothesis, specifying a number of layers of + ## Defines "NumberOfLayers" hypothesis, specifying the number of layers of # prisms to build between the inner and outer shells - # @param UseExisting if ==true - search existing hypothesis created with - # same parameters, else (default) - create new + # @param n number of layers + # @param UseExisting if ==true - searches for the existing hypothesis created with + # the same parameters, else (default) - creates a new one def NumberOfLayers(self, n, UseExisting=0): self.mesh.GetMesh().RemoveHypothesis( self.geom, self.distribHyp ) self.nbLayers = self.Hypothesis("NumberOfLayers", [n], UseExisting=UseExisting, @@ -3410,24 +3884,24 @@ class Mesh_RadialPrism3D(Mesh_Algorithm): self.nbLayers.SetNumberOfLayers( n ) return self.nbLayers - ## Check if the given "NumberOfLayers" hypothesis has the same parameters as given arguments + ## Checks if the given "NumberOfLayers" hypothesis has the same parameters as the given arguments def CompareNumberOfLayers(self, hyp, args): return IsEqual(hyp.GetNumberOfLayers(), args[0]) - ## Define "LocalLength" hypothesis, specifying segment length - # to build between the inner and outer shells - # @param l for the length of segments - # @param p for the precision of rounding + ## Defines "LocalLength" hypothesis, specifying the segment length + # to build between the inner and the outer shells + # @param l the length of segments + # @param p the precision of rounding def LocalLength(self, l, p=1e-07): hyp = self.OwnHypothesis("LocalLength", [l,p]) hyp.SetLength(l) hyp.SetPrecision(p) return hyp - ## Define "NumberOfSegments" hypothesis, specifying a number of layers of - # prisms to build between the inner and outer shells - # @param n for the number of segments - # @param s for the scale factor (optional) + ## Defines "NumberOfSegments" hypothesis, specifying the number of layers of + # prisms to build between the inner and the outer shells. + # @param n the number of layers + # @param s the scale factor (optional) def NumberOfSegments(self, n, s=[]): if s == []: hyp = self.OwnHypothesis("NumberOfSegments", [n]) @@ -3438,18 +3912,18 @@ class Mesh_RadialPrism3D(Mesh_Algorithm): hyp.SetNumberOfSegments(n) return hyp - ## Define "Arithmetic1D" hypothesis, specifying distribution of segments - # to build between the inner and outer shells as arithmetic length increasing - # @param start for the length of the first segment - # @param end for the length of the last segment + ## Defines "Arithmetic1D" hypothesis, specifying the distribution of segments + # to build between the inner and the outer shells with a length that changes in arithmetic progression + # @param start the length of the first segment + # @param end the length of the last segment def Arithmetic1D(self, start, end ): hyp = self.OwnHypothesis("Arithmetic1D", [start, end]) hyp.SetLength(start, 1) hyp.SetLength(end , 0) return hyp - ## Define "StartEndLength" hypothesis, specifying distribution of segments - # to build between the inner and outer shells as geometric length increasing + ## Defines "StartEndLength" hypothesis, specifying distribution of segments + # to build between the inner and the outer shells as geometric length increasing # @param start for the length of the first segment # @param end for the length of the last segment def StartEndLength(self, start, end): @@ -3458,9 +3932,9 @@ class Mesh_RadialPrism3D(Mesh_Algorithm): hyp.SetLength(end , 0) return hyp - ## Define "AutomaticLength" hypothesis, specifying number of segments + ## Defines "AutomaticLength" hypothesis, specifying the number of segments # to build between the inner and outer shells - # @param fineness for the fineness [0-1] + # @param fineness defines the quality of the mesh within the range [0-1] def AutomaticLength(self, fineness=0): hyp = self.OwnHypothesis("AutomaticLength") hyp.SetFineness( fineness )