X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=src%2FSMESH_SWIG%2FsmeshBuilder.py;h=d5e80de438af0cfb0d40cc32296b0de678e73c82;hp=24c48355d492c3d5da046cf2713a661334de6f4c;hb=0003e6b4fcc95a0aec695ceef8371dee28baf417;hpb=1b1945a31c3f8023b9261d34b17c2027af7a5974 diff --git a/src/SMESH_SWIG/smeshBuilder.py b/src/SMESH_SWIG/smeshBuilder.py index 24c48355d..d5e80de43 100644 --- a/src/SMESH_SWIG/smeshBuilder.py +++ b/src/SMESH_SWIG/smeshBuilder.py @@ -1,4 +1,4 @@ -# Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE +# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Lesser General Public @@ -27,12 +27,15 @@ ## @defgroup l1_creating Creating meshes ## @{ ## @defgroup l2_impexp Importing and exporting meshes +## @{ +## @details +## These are methods of class \ref smeshBuilder.smeshBuilder "smeshBuilder" +## @} ## @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 @@ -46,8 +49,7 @@ ## @defgroup l3_hypos_additi Additional Hypotheses ## @} -## @defgroup l2_submeshes Constructing submeshes -## @defgroup l2_compounds Building Compounds +## @defgroup l2_submeshes Constructing sub-meshes ## @defgroup l2_editing Editing Meshes ## @} @@ -56,7 +58,6 @@ ## @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 @@ -68,16 +69,13 @@ ## @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 elements +## @defgroup l2_modif_changori Changing orientation of elements ## @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 +## @defgroup l2_modif_duplicat Duplication of nodes and elements (to emulate cracks) ## @} ## @defgroup l1_measurements Measurements @@ -92,7 +90,10 @@ from salome.smesh.smesh_algorithm import Mesh_Algorithm import SALOME import SALOMEDS import os +import collections +## Private class used to workaround a problem that sometimes isinstance(m, Mesh) returns False +# class MeshMeta(type): def __instancecheck__(cls, inst): """Implement isinstance(inst, cls).""" @@ -106,7 +107,7 @@ class MeshMeta(type): ## @addtogroup l1_auxiliary ## @{ -## Converts an angle from degrees to radians +## Convert an angle from degrees to radians def DegreesToRadians(AngleInDegrees): from math import pi return AngleInDegrees * pi / 180.0 @@ -123,7 +124,7 @@ def ParseParameters(*args): Parameters = "" hasVariables = False varModifFun=None - if args and callable( args[-1] ): + if args and isinstance( args[-1], collections.Callable): args, varModifFun = args[:-1], args[-1] for parameter in args: @@ -132,7 +133,7 @@ def ParseParameters(*args): if isinstance(parameter,str): # check if there is an inexistent variable name if not notebook.isVariable(parameter): - raise ValueError, "Variable with name '" + parameter + "' doesn't exist!!!" + raise ValueError("Variable with name '" + parameter + "' doesn't exist!!!") parameter = notebook.get(parameter) hasVariables = True if varModifFun: @@ -147,25 +148,28 @@ def ParseParameters(*args): Result.append( hasVariables ) return Result -# Parse parameters converting variables to radians +## Parse parameters while converting variables to radians def ParseAngles(*args): return ParseParameters( *( args + (DegreesToRadians, ))) -# Substitute PointStruct.__init__() to create SMESH.PointStruct using notebook variables. -# Parameters are stored in PointStruct.parameters attribute +## Substitute PointStruct.__init__() to create SMESH.PointStruct using notebook variables. +# Parameters are stored in PointStruct.parameters attribute def __initPointStruct(point,*args): point.x, point.y, point.z, point.parameters,hasVars = ParseParameters(*args) pass SMESH.PointStruct.__init__ = __initPointStruct -# Substitute AxisStruct.__init__() to create SMESH.AxisStruct using notebook variables. -# Parameters are stored in AxisStruct.parameters attribute +## Substitute AxisStruct.__init__() to create SMESH.AxisStruct using notebook variables. +# Parameters are stored in AxisStruct.parameters attribute def __initAxisStruct(ax,*args): + if len( args ) != 6: + raise RuntimeError("Bad nb args (%s) passed in SMESH.AxisStruct(x,y,z,dx,dy,dz)"%(len( args ))) ax.x, ax.y, ax.z, ax.vx, ax.vy, ax.vz, ax.parameters,hasVars = ParseParameters(*args) pass SMESH.AxisStruct.__init__ = __initAxisStruct smeshPrecisionConfusion = 1.e-07 +## Compare real values using smeshPrecisionConfusion as tolerance def IsEqual(val1, val2, tol=smeshPrecisionConfusion): if abs(val1 - val2) < tol: return True @@ -173,7 +177,7 @@ def IsEqual(val1, val2, tol=smeshPrecisionConfusion): NO_NAME = "NoName" -## Gets object name +## Return object name def GetName(obj): if obj: # object not null @@ -204,9 +208,9 @@ def GetName(obj): # unknown non-CORBA object, having GetName() method return obj.GetName() pass - raise RuntimeError, "Null or invalid object" + raise RuntimeError("Null or invalid object") -## Prints error message if a hypothesis was not assigned. +## Print error message if a hypothesis was not assigned. def TreatHypoStatus(status, hypName, geomName, isAlgo, mesh): if isAlgo: hypType = "algorithm" @@ -232,7 +236,7 @@ def TreatHypoStatus(status, hypName, geomName, isAlgo, mesh): elif status == HYP_BAD_SUBSHAPE : reason = "the shape is neither the main one, nor its sub-shape, nor a valid group" elif status == HYP_BAD_GEOMETRY: - reason = "geometry mismatches the expectation of the algorithm" + reason = "the algorithm is not applicable to this geometry" elif status == HYP_HIDDEN_ALGO: reason = "it is hidden by an algorithm of an upper dimension, which generates elements of all dimensions" elif status == HYP_HIDING_ALGO: @@ -249,13 +253,13 @@ def TreatHypoStatus(status, hypName, geomName, isAlgo, mesh): if mesh: meshName = GetName( mesh ) if meshName and meshName != NO_NAME: - where = '"%s" in "%s"' % ( geomName, meshName ) + where = '"%s" shape in "%s" mesh ' % ( geomName, meshName ) if status < HYP_UNKNOWN_FATAL and where: - print '"%s" was assigned to %s but %s' %( hypName, where, reason ) + print('"%s" was assigned to %s but %s' %( hypName, where, reason )) elif where: - print '"%s" was not assigned to %s : %s' %( hypName, where, reason ) + print('"%s" was not assigned to %s : %s' %( hypName, where, reason )) else: - print '"%s" was not assigned : %s' %( hypName, reason ) + print('"%s" was not assigned : %s' %( hypName, reason )) pass ## Private method. Add geom (sub-shape of the main shape) into the study if not yet there @@ -270,7 +274,7 @@ def AssureGeomPublished(mesh, geom, name=''): mesh.geompyD.init_geom( mesh.smeshpyD.GetCurrentStudy()) ## get a name if not name and geom.GetShapeType() != geomBuilder.GEOM.COMPOUND: - # for all groups SubShapeName() returns "Compound_-1" + # for all groups SubShapeName() return "Compound_-1" name = mesh.geompyD.SubShapeName(geom, mesh.geom) if not name: name = "%s_%s"%(geom.GetShapeType(), id(geom)%10000) @@ -282,7 +286,7 @@ def AssureGeomPublished(mesh, geom, name=''): def FirstVertexOnCurve(mesh, edge): vv = mesh.geompyD.SubShapeAll( edge, geomBuilder.geomBuilder.ShapeType["VERTEX"]) if not vv: - raise TypeError, "Given object has no vertices" + raise TypeError("Given object has no vertices") if len( vv ) == 1: return vv[0] v0 = mesh.geompyD.MakeVertexOnCurve(edge,0.) xyz = mesh.geompyD.PointCoordinates( v0 ) # coords of the first vertex @@ -307,10 +311,10 @@ engine = None doLcc = False created = False -## This class allows to create, load or manipulate meshes -# It has a set of methods to create load or copy meshes, to combine several meshes. -# It also has methods to get infos on meshes. -class smeshBuilder(object, SMESH._objref_SMESH_Gen): +## This class allows to create, load or manipulate meshes. +# It has a set of methods to create, load or copy meshes, to combine several meshes, etc. +# It also has methods to get infos and measure meshes. +class smeshBuilder(SMESH._objref_SMESH_Gen): # MirrorType enumeration POINT = SMESH_MeshEditor.POINT @@ -324,12 +328,12 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): PrecisionConfusion = smeshPrecisionConfusion # TopAbs_State enumeration - [TopAbs_IN, TopAbs_OUT, TopAbs_ON, TopAbs_UNKNOWN] = range(4) + [TopAbs_IN, TopAbs_OUT, TopAbs_ON, TopAbs_UNKNOWN] = list(range(4)) # Methods of splitting a hexahedron into tetrahedra Hex_5Tet, Hex_6Tet, Hex_24Tet, Hex_2Prisms, Hex_4Prisms = 1, 2, 3, 1, 2 - def __new__(cls): + def __new__(cls, *args): global engine global smeshInst global doLcc @@ -366,29 +370,31 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): #print "====2 ", smeshInst return smeshInst - def __init__(self): + def __init__(self, *args): global created #print "--------------- smeshbuilder __init__ ---", created if not created: - created = True - SMESH._objref_SMESH_Gen.__init__(self) + created = True + SMESH._objref_SMESH_Gen.__init__(self, *args) ## Dump component to the Python script # This method overrides IDL function to allow default values for the parameters. + # @ingroup l1_auxiliary def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True): return SMESH._objref_SMESH_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile) ## Set mode of DumpPython(), \a historical or \a snapshot. - # In the \a historical mode, the Python Dump script includes all commands - # performed by SMESH engine. In the \a snapshot mode, commands - # relating to objects removed from the Study are excluded from the script - # as well as commands not influencing the current state of meshes + # In the \a historical mode, the Python Dump script includes all commands + # performed by SMESH engine. In the \a snapshot mode, commands + # relating to objects removed from the Study are excluded from the script + # as well as commands not influencing the current state of meshes + # @ingroup l1_auxiliary def SetDumpPythonHistorical(self, isHistorical): if isHistorical: val = "true" else: val = "false" SMESH._objref_SMESH_Gen.SetOption(self, "historical_python_dump", val) - ## Sets the current study and Geometry component + ## Set the current study and Geometry component # @ingroup l1_auxiliary def init_smesh(self,theStudy,geompyD = None): #print "init_smesh" @@ -397,7 +403,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): global notebook notebook.myStudy = theStudy - ## Creates a mesh. This can be either an empty mesh, possibly having an underlying geometry, + ## Create a mesh. This can be either an empty mesh, possibly having an underlying geometry, # or a mesh wrapping a CORBA mesh given as a parameter. # @param obj either (1) a CORBA mesh (SMESH._objref_SMESH_Mesh) got e.g. by calling # salome.myStudy.FindObjectID("0:1:2:3").GetObject() or @@ -411,15 +417,15 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): obj,name = name,obj return Mesh(self,self.geompyD,obj,name) - ## Returns a long value from enumeration - # @ingroup l1_controls + ## Return a long value from enumeration + # @ingroup l1_auxiliary def EnumToLong(self,theItem): return theItem._v - ## Returns a string representation of the color. + ## Return a string representation of the color. # To be used with filters. # @param c color value (SALOMEDS.Color) - # @ingroup l1_controls + # @ingroup l1_auxiliary def ColorToString(self,c): val = "" if isinstance(c, SALOMEDS.Color): @@ -427,10 +433,10 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): elif isinstance(c, str): val = c else: - raise ValueError, "Color value should be of string or SALOMEDS.Color type" + raise ValueError("Color value should be of string or SALOMEDS.Color type") return val - ## Gets PointStruct from vertex + ## Get PointStruct from vertex # @param theVertex a GEOM object(vertex) # @return SMESH.PointStruct # @ingroup l1_auxiliary @@ -438,14 +444,14 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): [x, y, z] = self.geompyD.PointCoordinates(theVertex) return PointStruct(x,y,z) - ## Gets DirStruct from vector + ## Get DirStruct from vector # @param theVector a GEOM object(vector) # @return SMESH.DirStruct # @ingroup l1_auxiliary def GetDirStruct(self,theVector): vertices = self.geompyD.SubShapeAll( theVector, geomBuilder.geomBuilder.ShapeType["VERTEX"] ) if(len(vertices) != 2): - print "Error: vector object is incorrect." + print("Error: vector object is incorrect.") return None p1 = self.geompyD.PointCoordinates(vertices[0]) p2 = self.geompyD.PointCoordinates(vertices[1]) @@ -453,7 +459,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): dirst = DirStruct(pnt) return dirst - ## Makes DirStruct from a triplet + ## Make DirStruct from a triplet # @param x,y,z vector components # @return SMESH.DirStruct # @ingroup l1_auxiliary @@ -496,7 +502,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): # From SMESH_Gen interface: # ------------------------ - ## Sets the given name to the object + ## Set the given name to the object # @param obj the object to rename # @param name a new object name # @ingroup l1_auxiliary @@ -508,22 +514,20 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): ior = salome.orb.object_to_string(obj) SMESH._objref_SMESH_Gen.SetName(self, ior, name) - ## Sets the current mode + ## Set the current mode # @ingroup l1_auxiliary def SetEmbeddedMode( self,theMode ): - #self.SetEmbeddedMode(theMode) SMESH._objref_SMESH_Gen.SetEmbeddedMode(self,theMode) - ## Gets the current mode + ## Get the current mode # @ingroup l1_auxiliary def IsEmbeddedMode(self): - #return self.IsEmbeddedMode() return SMESH._objref_SMESH_Gen.IsEmbeddedMode(self) - ## Sets the current study + ## Set the current study. Calling SetCurrentStudy( None ) allows to + # switch OFF automatic pubilishing in the Study of mesh objects. # @ingroup l1_auxiliary def SetCurrentStudy( self, theStudy, geompyD = None ): - #self.SetCurrentStudy(theStudy) if not geompyD: from salome.geom import geomBuilder geompyD = geomBuilder.geom @@ -543,13 +547,12 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): pass pass - ## Gets the current study + ## Get the current study # @ingroup l1_auxiliary def GetCurrentStudy(self): - #return self.GetCurrentStudy() return SMESH._objref_SMESH_Gen.GetCurrentStudy(self) - ## Creates a Mesh object importing data from the given UNV file + ## Create a Mesh object importing data from the given UNV file # @return an instance of Mesh class # @ingroup l2_impexp def CreateMeshesFromUNV( self,theFileName ): @@ -557,7 +560,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aMesh = Mesh(self, self.geompyD, aSmeshMesh) return aMesh - ## Creates a Mesh object(s) importing data from the given MED file + ## Create a Mesh object(s) importing data from the given MED file # @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus ) # @ingroup l2_impexp def CreateMeshesFromMED( self,theFileName ): @@ -565,7 +568,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ] return aMeshes, aStatus - ## Creates a Mesh object(s) importing data from the given SAUV file + ## Create a Mesh object(s) importing data from the given SAUV file # @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus ) # @ingroup l2_impexp def CreateMeshesFromSAUV( self,theFileName ): @@ -573,7 +576,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ] return aMeshes, aStatus - ## Creates a Mesh object importing data from the given STL file + ## Create a Mesh object importing data from the given STL file # @return an instance of Mesh class # @ingroup l2_impexp def CreateMeshesFromSTL( self, theFileName ): @@ -581,7 +584,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aMesh = Mesh(self, self.geompyD, aSmeshMesh) return aMesh - ## Creates Mesh objects importing data from the given CGNS file + ## Create Mesh objects importing data from the given CGNS file # @return a tuple ( list of Mesh class instances, SMESH.DriverMED_ReadStatus ) # @ingroup l2_impexp def CreateMeshesFromCGNS( self, theFileName ): @@ -589,7 +592,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aMeshes = [ Mesh(self, self.geompyD, m) for m in aSmeshMeshes ] return aMeshes, aStatus - ## Creates a Mesh object importing data from the given GMF file. + ## Create a Mesh object importing data from the given GMF file. # GMF files must have .mesh extension for the ASCII format and .meshb for # the binary format. # @return [ an instance of Mesh class, SMESH.ComputeError ] @@ -598,17 +601,19 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aSmeshMesh, error = SMESH._objref_SMESH_Gen.CreateMeshesFromGMF(self, theFileName, True) - if error.comment: print "*** CreateMeshesFromGMF() errors:\n", error.comment + if error.comment: print("*** CreateMeshesFromGMF() errors:\n", error.comment) return Mesh(self, self.geompyD, aSmeshMesh), error - ## Concatenate the given meshes into one mesh. - # @return an instance of Mesh class - # @param meshes the meshes to combine into one mesh + ## Concatenate the given meshes into one mesh. All groups of input meshes will be + # present in the new mesh. + # @param meshes the meshes, sub-meshes and groups to combine into one mesh # @param uniteIdenticalGroups if true, groups with same names are united, else they are renamed - # @param mergeNodesAndElements if true, equal nodes and elements aremerged + # @param mergeNodesAndElements if true, equal nodes and elements are merged # @param mergeTolerance tolerance for merging nodes - # @param allGroups forces creation of groups of all elements + # @param allGroups forces creation of groups corresponding to every input mesh # @param name name of a new mesh + # @return an instance of Mesh class + # @ingroup l1_creating def Concatenate( self, meshes, uniteIdenticalGroups, mergeNodesAndElements = False, mergeTolerance = 1e-5, allGroups = False, name = ""): @@ -635,29 +640,30 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): # @param toCopyGroups to create in the new mesh groups the copied elements belongs to # @param toKeepIDs to preserve order of the copied elements or not # @return an instance of Mesh class + # @ingroup l1_creating def CopyMesh( self, meshPart, meshName, toCopyGroups=False, toKeepIDs=False): if (isinstance( meshPart, Mesh )): meshPart = meshPart.GetMesh() mesh = SMESH._objref_SMESH_Gen.CopyMesh( self,meshPart,meshName,toCopyGroups,toKeepIDs ) return Mesh(self, self.geompyD, mesh) - ## From SMESH_Gen interface + ## Return IDs of sub-shapes # @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 a pattern + ## Create a pattern mapper. # @return an instance of SMESH_Pattern # # Example of Patterns usage - # @ingroup l2_modif_patterns + # @ingroup l1_modifying def GetPattern(self): return SMESH._objref_SMESH_Gen.GetPattern(self) - ## Sets number of segments per diagonal of boundary box of geometry by which - # default segment length of appropriate 1D hypotheses is defined. - # Default value is 10 + ## Set number of segments per diagonal of boundary box of geometry, by which + # default segment length of appropriate 1D hypotheses is defined in GUI. + # Default value is 10. # @ingroup l1_auxiliary def SetBoundaryBoxSegmentation(self, nbSegments): SMESH._objref_SMESH_Gen.SetBoundaryBoxSegmentation(self,nbSegments) @@ -665,7 +671,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): # Filtering. Auxiliary functions: # ------------------------------ - ## Creates an empty criterion + ## Create an empty criterion # @return SMESH.Filter.Criterion # @ingroup l1_controls def GetEmptyCriterion(self): @@ -682,17 +688,19 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): return Filter.Criterion(Type, Compare, Threshold, ThresholdStr, ThresholdID, UnaryOp, BinaryOp, Tolerance, TypeOfElement, Precision) - ## Creates a criterion by the given parameters + ## Create a criterion by the given parameters # \n Criterion structures allow to define complex filters by combining them with logical operations (AND / OR) (see example below) - # @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 elementType the type of elements(SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME) + # @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.) + # Type SMESH.FunctorType._items in the Python Console to see all values. + # Note that the items starting from FT_LessThan are not suitable for CritType. + # @param Compare belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo} # @param Threshold 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) - # @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface, - # FT_LyingOnGeom, FT_CoplanarFaces criteria + # @param UnaryOp SMESH.FT_LogicalNOT or SMESH.FT_Undefined + # @param BinaryOp a binary logical operation SMESH.FT_LogicalAND, SMESH.FT_LogicalOR or + # SMESH.FT_Undefined + # @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface, + # SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces criteria # @return SMESH.Filter.Criterion # # Example of Criteria usage @@ -705,7 +713,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): BinaryOp=FT_Undefined, Tolerance=1e-07): if not CritType in SMESH.FunctorType._items: - raise TypeError, "CritType should be of SMESH.FunctorType" + raise TypeError("CritType should be of SMESH.FunctorType") aCriterion = self.GetEmptyCriterion() aCriterion.TypeOfElement = elementType aCriterion.Type = self.EnumToLong(CritType) @@ -727,7 +735,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): if CritType in [FT_BelongToGeom, FT_BelongToPlane, FT_BelongToGenSurface, FT_BelongToCylinder, FT_LyingOnGeom]: - # Checks that Threshold is GEOM object + # Check that Threshold is GEOM object if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): aCriterion.ThresholdStr = GetName(aThreshold) aCriterion.ThresholdID = aThreshold.GetStudyEntry() @@ -736,35 +744,50 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): if not name: name = "%s_%s"%(aThreshold.GetShapeType(), id(aThreshold)%10000) aCriterion.ThresholdID = self.geompyD.addToStudy( aThreshold, name ) - #raise RuntimeError, "Threshold shape must be published" + # or a name of GEOM object + elif isinstance( aThreshold, str ): + aCriterion.ThresholdStr = aThreshold else: - print "Error: The Threshold should be a shape." - return None + raise TypeError("The Threshold should be a shape.") if isinstance(UnaryOp,float): aCriterion.Tolerance = UnaryOp UnaryOp = FT_Undefined pass + elif CritType == FT_BelongToMeshGroup: + # Check that Threshold is a group + if isinstance(aThreshold, SMESH._objref_SMESH_GroupBase): + if aThreshold.GetType() != elementType: + raise ValueError("Group type mismatches Element type") + aCriterion.ThresholdStr = aThreshold.GetName() + aCriterion.ThresholdID = salome.orb.object_to_string( aThreshold ) + study = self.GetCurrentStudy() + if study: + so = study.FindObjectIOR( aCriterion.ThresholdID ) + if so: + entry = so.GetID() + if entry: + aCriterion.ThresholdID = entry + else: + raise TypeError("The Threshold should be a Mesh Group") elif CritType == FT_RangeOfIds: - # Checks that Threshold is string + # Check that Threshold is string if isinstance(aThreshold, str): aCriterion.ThresholdStr = aThreshold else: - print "Error: The Threshold should be a string." - return None + raise TypeError("The Threshold should be a string.") elif CritType == FT_CoplanarFaces: - # Checks the Threshold + # Check the Threshold if isinstance(aThreshold, int): aCriterion.ThresholdID = str(aThreshold) elif isinstance(aThreshold, str): ID = int(aThreshold) if ID < 1: - raise ValueError, "Invalid ID of mesh face: '%s'"%aThreshold + raise ValueError("Invalid ID of mesh face: '%s'"%aThreshold) aCriterion.ThresholdID = aThreshold else: - raise ValueError,\ - "The Threshold should be an ID of mesh face and not '%s'"%aThreshold + raise TypeError("The Threshold should be an ID of mesh face and not '%s'"%aThreshold) elif CritType == FT_ConnectedElements: - # Checks the Threshold + # Check the Threshold if isinstance(aThreshold, geomBuilder.GEOM._objref_GEOM_Object): # shape aCriterion.ThresholdID = aThreshold.GetStudyEntry() if not aCriterion.ThresholdID: @@ -776,7 +799,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aCriterion.Threshold = aThreshold elif isinstance(aThreshold, list): # 3 point coordinates if len( aThreshold ) < 3: - raise ValueError, "too few point coordinates, must be 3" + raise ValueError("too few point coordinates, must be 3") aCriterion.ThresholdStr = " ".join( [str(c) for c in aThreshold[:3]] ) elif isinstance(aThreshold, str): if aThreshold.isdigit(): @@ -784,11 +807,10 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): else: aCriterion.ThresholdStr = aThreshold # hope that it's point coordinates else: - raise ValueError,\ - "The Threshold should either a VERTEX, or a node ID, "\ - "or a list of point coordinates and not '%s'"%aThreshold + raise TypeError("The Threshold should either a VERTEX, or a node ID, "\ + "or a list of point coordinates and not '%s'"%aThreshold) elif CritType == FT_ElemGeomType: - # Checks the Threshold + # Check the Threshold try: aCriterion.Threshold = self.EnumToLong(aThreshold) assert( aThreshold in SMESH.GeometryType._items ) @@ -796,12 +818,11 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): if isinstance(aThreshold, int): aCriterion.Threshold = aThreshold else: - print "Error: The Threshold should be an integer or SMESH.GeometryType." - return None + raise TypeError("The Threshold should be an integer or SMESH.GeometryType.") pass pass elif CritType == FT_EntityType: - # Checks the Threshold + # Check the Threshold try: aCriterion.Threshold = self.EnumToLong(aThreshold) assert( aThreshold in SMESH.EntityType._items ) @@ -809,18 +830,16 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): if isinstance(aThreshold, int): aCriterion.Threshold = aThreshold else: - print "Error: The Threshold should be an integer or SMESH.EntityType." - return None + raise TypeError("The Threshold should be an integer or SMESH.EntityType.") pass pass - + elif CritType == FT_GroupColor: - # Checks the Threshold + # Check the Threshold try: aCriterion.ThresholdStr = self.ColorToString(aThreshold) except: - print "Error: The threshold value should be of SALOMEDS.Color type" - return None + raise TypeError("The threshold value should be of SALOMEDS.Color type") pass elif CritType in [FT_FreeBorders, FT_FreeEdges, FT_FreeNodes, FT_FreeFaces, FT_LinearOrQuadratic, FT_BadOrientedVolume, @@ -838,7 +857,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aThreshold = float(aThreshold) aCriterion.Threshold = aThreshold except: - print "Error: The Threshold should be a number." + raise TypeError("The Threshold should be a number.") return None if Threshold == FT_LogicalNOT or UnaryOp == FT_LogicalNOT: @@ -855,14 +874,16 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): return aCriterion - ## 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 Threshold the threshold value (range of id ids as string, shape, numeric) - # @param UnaryOp FT_LogicalNOT or FT_Undefined - # @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface, - # FT_LyingOnGeom, FT_CoplanarFaces and FT_EqualNodes criteria + ## Create a filter with the given parameters + # @param elementType the type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME) + # @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.) + # Type SMESH.FunctorType._items in the Python Console to see all values. + # Note that the items starting from FT_LessThan are not suitable for CritType. + # @param Compare belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo} + # @param Threshold the threshold value (range of ids as string, shape, numeric) + # @param UnaryOp SMESH.FT_LogicalNOT or SMESH.FT_Undefined + # @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface, + # SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces and SMESH.FT_EqualNodes criteria # @param mesh the mesh to initialize the filter with # @return SMESH_Filter # @@ -887,7 +908,7 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aFilterMgr.UnRegister() return aFilter - ## Creates a filter from criteria + ## Create a filter from criteria # @param criteria a list of criteria # @param binOp binary operator used when binary operator of criteria is undefined # @return SMESH_Filter @@ -904,8 +925,10 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): aFilterMgr.UnRegister() return aFilter - ## Creates a numerical functor by its type - # @param theCriterion FT_...; functor type + ## Create a numerical functor by its type + # @param theCriterion functor type - an item of SMESH.FunctorType enumeration. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @return SMESH_NumericalFunctor # @ingroup l1_controls def GetFunctor(self,theCriterion): @@ -941,12 +964,16 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): functor = aFilterMgr.CreateLength() elif theCriterion == FT_Length2D: functor = aFilterMgr.CreateLength2D() + elif theCriterion == FT_NodeConnectivityNumber: + functor = aFilterMgr.CreateNodeConnectivityNumber() + elif theCriterion == FT_BallDiameter: + functor = aFilterMgr.CreateBallDiameter() else: - print "Error: given parameter is not numerical functor type." + print("Error: given parameter is not numerical functor type.") aFilterMgr.UnRegister() return functor - ## Creates hypothesis + ## Create hypothesis # @param theHType mesh hypothesis type (string) # @param theLibName mesh plug-in library name # @return created hypothesis instance @@ -962,12 +989,12 @@ class smeshBuilder(object, SMESH._objref_SMESH_Gen): if not meth_name.startswith("Get") and \ not meth_name in dir ( SMESH._objref_SMESH_Hypothesis ): method = getattr ( hyp.__class__, meth_name ) - if callable(method): + if isinstance(method, collections.Callable): setattr( hyp, meth_name, hypMethodWrapper( hyp, method )) return hyp - ## Gets the mesh statistic + ## Get the mesh statistic # @return dictionary "element type" - "count of elements" # @ingroup l1_meshinfo def GetMeshInfo(self, obj): @@ -1138,7 +1165,7 @@ omniORB.registerObjref(SMESH._objref_SMESH_Gen._NP_RepositoryId, smeshBuilder) # import salome # salome.salome_init() # from salome.smesh import smeshBuilder -# smesh = smeshBuilder.New(theStudy) +# smesh = smeshBuilder.New(salome.myStudy) # \endcode # @param study SALOME study, generally obtained by salome.myStudy. # @param instance CORBA proxy of SMESH Engine. If None, the default Engine is used. @@ -1153,7 +1180,7 @@ def New( study, instance=None): import salome salome.salome_init() from salome.smesh import smeshBuilder - smesh = smeshBuilder.New(theStudy) + smesh = smeshBuilder.New(salome.myStudy) Parameters: study SALOME study, generally obtained by salome.myStudy. @@ -1166,7 +1193,7 @@ def New( study, instance=None): global doLcc engine = instance if engine is None: - doLcc = True + doLcc = True smeshInst = smeshBuilder() assert isinstance(smeshInst,smeshBuilder), "Smesh engine class is %s but should be smeshBuilder.smeshBuilder. Import salome.smesh.smeshBuilder before creating the instance."%smeshInst.__class__ smeshInst.init_smesh(study) @@ -1180,17 +1207,15 @@ def New( study, instance=None): # 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: - __metaclass__ = MeshMeta - +# about a mesh and to export a mesh in different formats. +class Mesh(metaclass=MeshMeta): geom = 0 mesh = 0 editor = 0 ## Constructor # - # Creates a mesh on the shape \a obj (or an empty mesh if \a obj is equal to 0) and + # Create 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 smeshBuilder class # @param geompyD an instance of geomBuilder class @@ -1240,7 +1265,6 @@ class Mesh: for attrName in dir(self): attr = getattr( self, attrName ) if isinstance( attr, algoCreator ): - #print "algoCreator ", attrName setattr( self, attrName, attr.copy( self )) pass pass @@ -1252,8 +1276,8 @@ class Mesh: #self.mesh.UnRegister() pass pass - - ## Initializes the Mesh object from an instance of SMESH_Mesh interface + + ## Initialize the Mesh object from an instance of SMESH_Mesh interface # @param theMesh a SMESH_Mesh object # @ingroup l2_construct def SetMesh(self, theMesh): @@ -1265,60 +1289,76 @@ class Mesh: self.geom = self.mesh.GetShapeToMesh() pass - ## Returns the mesh, that is an instance of SMESH_Mesh interface + ## Return the mesh, that is an instance of SMESH_Mesh interface # @return a SMESH_Mesh object # @ingroup l2_construct def GetMesh(self): return self.mesh - ## Gets the name of the mesh + ## Get 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 - ## Sets a name to the mesh + ## Set a name to the mesh # @param name a new name of the mesh # @ingroup l2_construct def SetName(self, name): self.smeshpyD.SetName(self.GetMesh(), name) - ## Gets the subMesh object associated to a \a theSubObject geometrical object. - # The subMesh object gives access to the IDs of nodes and elements. + ## Get a sub-mesh object associated to a \a geom geometrical object. # @param geom a geometrical object (shape) - # @param name a name for the submesh - # @return an object of type SMESH_SubMesh, representing a part of mesh, which lies on the given shape + # @param name a name for the sub-mesh in the Object Browser + # @return an object of type SMESH.SMESH_subMesh, representing a part of mesh, + # which lies on the given shape + # + # The sub-mesh object gives access to the IDs of nodes and elements. + # The sub-mesh object has the following methods: + # - SMESH.SMESH_subMesh.GetNumberOfElements() + # - SMESH.SMESH_subMesh.GetNumberOfNodes( all ) + # - SMESH.SMESH_subMesh.GetElementsId() + # - SMESH.SMESH_subMesh.GetElementsByType( ElementType ) + # - SMESH.SMESH_subMesh.GetNodesId() + # - SMESH.SMESH_subMesh.GetSubShape() + # - SMESH.SMESH_subMesh.GetFather() + # - SMESH.SMESH_subMesh.GetId() + # @note A sub-mesh is implicitly created when a sub-shape is specified at + # creating an algorithm, for example: algo1D = mesh.Segment(geom=Edge_1) + # creates a sub-mesh on @c Edge_1 and assign Wire Discretization algorithm to it. + # The created sub-mesh can be retrieved from the algorithm: + # submesh = algo1D.GetSubMesh() # @ingroup l2_submeshes def GetSubMesh(self, geom, name): AssureGeomPublished( self, geom, name ) submesh = self.mesh.GetSubMesh( geom, name ) return submesh - ## Returns the shape associated to the mesh + ## Return the shape associated to the mesh # @return a GEOM_Object # @ingroup l2_construct def GetShape(self): return self.geom - ## Associates the given shape to the mesh (entails the recreation of the mesh) + ## Associate 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) - ## Loads mesh from the study after opening the study + ## Load mesh from the study after opening the study def Load(self): self.mesh.Load() - ## Returns true if the hypotheses are defined well + ## Return true if the hypotheses are defined well # @param theSubObject a sub-shape of a mesh shape # @return True or False # @ingroup l2_construct def IsReadyToCompute(self, theSubObject): return self.smeshpyD.IsReadyToCompute(self.mesh, theSubObject) - ## Returns errors of hypotheses definition. + ## Return errors of hypotheses definition. # The list of errors is empty if everything is OK. # @param theSubObject a sub-shape of a mesh shape # @return a list of errors @@ -1326,20 +1366,20 @@ class Mesh: def GetAlgoState(self, theSubObject): return self.smeshpyD.GetAlgoState(self.mesh, theSubObject) - ## Returns a geometrical object on which the given element was built. + ## Return a geometrical object on which the given element was built. # The returned geometrical object, if not nil, is either found in the # 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 + # @ingroup l1_meshinfo def GetGeometryByMeshElement(self, theElementID, theGeomName): return self.smeshpyD.GetGeometryByMeshElement( self.mesh, theElementID, theGeomName ) - ## Returns the mesh dimension depending on the dimension of the underlying shape + ## Return the mesh dimension depending on the dimension of the underlying shape # or, if the mesh is not based on any shape, basing on deimension of elements # @return mesh dimension as an integer value [0,3] - # @ingroup l1_auxiliary + # @ingroup l1_meshinfo def MeshDimension(self): if self.mesh.HasShapeToMesh(): shells = self.geompyD.SubShapeAllIDs( self.geom, self.geompyD.ShapeType["SOLID"] ) @@ -1357,10 +1397,11 @@ class Mesh: if self.NbEdges() > 0: return 1 return 0 - ## Evaluates size of prospective mesh on a shape + ## Evaluate size of prospective mesh on a shape # @return a list where i-th element is a number of elements of i-th SMESH.EntityType # To know predicted number of e.g. edges, inquire it this way # Evaluate()[ EnumToLong( Entity_Edge )] + # @ingroup l2_construct def Evaluate(self, geom=0): if geom == 0 or not isinstance(geom, geomBuilder.GEOM._objref_GEOM_Object): if self.geom == 0: @@ -1370,7 +1411,7 @@ class Mesh: return self.smeshpyD.Evaluate(self.mesh, geom) - ## Computes the mesh and returns the status of the computation + ## Compute the mesh and return the status of the computation # @param geom geomtrical shape on which mesh data should be computed # @param discardModifs if True and the mesh has been edited since # a last total re-compute and that may prevent successful partial re-compute, @@ -1389,50 +1430,22 @@ class Mesh: if discardModifs and self.mesh.HasModificationsToDiscard(): # issue 0020693 self.mesh.Clear() ok = self.smeshpyD.Compute(self.mesh, geom) - except SALOME.SALOME_Exception, ex: - print "Mesh computation failed, exception caught:" - print " ", ex.details.text + except SALOME.SALOME_Exception as ex: + print("Mesh computation failed, exception caught:") + print(" ", ex.details.text) except: import traceback - print "Mesh computation failed, exception caught:" + print("Mesh computation failed, exception caught:") traceback.print_exc() if True:#not ok: allReasons = "" # Treat compute errors computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, geom ) + shapeText = "" for err in computeErrors: - shapeText = "" if self.mesh.HasShapeToMesh(): - try: - mainIOR = salome.orb.object_to_string(geom) - for sname in salome.myStudyManager.GetOpenStudies(): - s = salome.myStudyManager.GetStudyByName(sname) - if not s: continue - mainSO = s.FindObjectIOR(mainIOR) - if not mainSO: continue - if err.subShapeID == 1: - shapeText = ' on "%s"' % mainSO.GetName() - subIt = s.NewChildIterator(mainSO) - while subIt.More(): - subSO = subIt.Value() - subIt.Next() - obj = subSO.GetObject() - if not obj: continue - go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object ) - if not go: continue - ids = go.GetSubShapeIndices() - if len(ids) == 1 and ids[0] == err.subShapeID: - shapeText = ' on "%s"' % subSO.GetName() - break - if not shapeText: - shape = self.geompyD.GetSubShape( geom, [err.subShapeID]) - if shape: - shapeText = " on %s #%s" % (shape.GetShapeType(), err.subShapeID) - else: - shapeText = " on subshape #%s" % (err.subShapeID) - except: - shapeText = " on subshape #%s" % (err.subShapeID) + shapeText = " on %s" % self.GetSubShapeName( err.subShapeID ) errText = "" stdErrors = ["OK", #COMPERR_OK "Invalid input mesh", #COMPERR_BAD_INPUT_MESH @@ -1452,7 +1465,7 @@ class Mesh: errText = "code %s" % -err.code if errText: errText += ". " errText += err.comment - if allReasons != "":allReasons += "\n" + if allReasons: allReasons += "\n" if ok: allReasons += '- "%s"%s - %s' %(err.algoName, shapeText, errText) else: @@ -1490,7 +1503,7 @@ class Mesh: reason = ("For unknown reason. " "Developer, revise Mesh.Compute() implementation in smeshBuilder.py!") pass - if allReasons != "":allReasons += "\n" + if allReasons: allReasons += "\n" allReasons += "- " + reason pass if not ok or allReasons != "": @@ -1499,53 +1512,151 @@ class Mesh: else: msg += " has not been computed" if allReasons != "": msg += ":" else: msg += "." - print msg - print allReasons + print(msg) + print(allReasons) pass if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0: - smeshgui = salome.ImportComponentGUI("SMESH") - smeshgui.Init(self.mesh.GetStudyId()) - smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) ) - if refresh: salome.sg.updateObjBrowser(1) - pass + if not isinstance( refresh, list): # not a call from subMesh.Compute() + smeshgui = salome.ImportComponentGUI("SMESH") + smeshgui.Init(self.mesh.GetStudyId()) + smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), ok, (self.NbNodes()==0) ) + if refresh: salome.sg.updateObjBrowser(True) + return ok - ## Return submesh objects list in meshing order - # @return list of list of submesh objects + ## Return a list of error messages (SMESH.ComputeError) of the last Compute() + # @ingroup l2_construct + def GetComputeErrors(self, shape=0 ): + if shape == 0: + shape = self.mesh.GetShapeToMesh() + return self.smeshpyD.GetComputeErrors( self.mesh, shape ) + + ## Return a name of a sub-shape by its ID + # @param subShapeID a unique ID of a sub-shape + # @return a string describing the sub-shape; possible variants: + # - "Face_12" (published sub-shape) + # - FACE #3 (not published sub-shape) + # - sub-shape #3 (invalid sub-shape ID) + # - #3 (error in this function) + # @ingroup l1_auxiliary + def GetSubShapeName(self, subShapeID ): + if not self.mesh.HasShapeToMesh(): + return "" + try: + shapeText = "" + mainIOR = salome.orb.object_to_string( self.GetShape() ) + for sname in salome.myStudyManager.GetOpenStudies(): + s = salome.myStudyManager.GetStudyByName(sname) + if not s: continue + mainSO = s.FindObjectIOR(mainIOR) + if not mainSO: continue + if subShapeID == 1: + shapeText = '"%s"' % mainSO.GetName() + subIt = s.NewChildIterator(mainSO) + while subIt.More(): + subSO = subIt.Value() + subIt.Next() + obj = subSO.GetObject() + if not obj: continue + go = obj._narrow( geomBuilder.GEOM._objref_GEOM_Object ) + if not go: continue + try: + ids = self.geompyD.GetSubShapeID( self.GetShape(), go ) + except: + continue + if ids == subShapeID: + shapeText = '"%s"' % subSO.GetName() + break + if not shapeText: + shape = self.geompyD.GetSubShape( self.GetShape(), [subShapeID]) + if shape: + shapeText = '%s #%s' % (shape.GetShapeType(), subShapeID) + else: + shapeText = 'sub-shape #%s' % (subShapeID) + except: + shapeText = "#%s" % (subShapeID) + return shapeText + + ## Return a list of sub-shapes meshing of which failed, grouped into GEOM groups by + # error of an algorithm + # @param publish if @c True, the returned groups will be published in the study + # @return a list of GEOM groups each named after a failed algorithm + # @ingroup l2_construct + def GetFailedShapes(self, publish=False): + + algo2shapes = {} + computeErrors = self.smeshpyD.GetComputeErrors( self.mesh, self.GetShape() ) + for err in computeErrors: + shape = self.geompyD.GetSubShape( self.GetShape(), [err.subShapeID]) + if not shape: continue + if err.algoName in algo2shapes: + algo2shapes[ err.algoName ].append( shape ) + else: + algo2shapes[ err.algoName ] = [ shape ] + pass + + groups = [] + for algoName, shapes in list(algo2shapes.items()): + while shapes: + groupType = self.smeshpyD.EnumToLong( shapes[0].GetShapeType() ) + otherTypeShapes = [] + sameTypeShapes = [] + group = self.geompyD.CreateGroup( self.geom, groupType ) + for shape in shapes: + if shape.GetShapeType() == shapes[0].GetShapeType(): + sameTypeShapes.append( shape ) + else: + otherTypeShapes.append( shape ) + self.geompyD.UnionList( group, sameTypeShapes ) + if otherTypeShapes: + group.SetName( "%s %s" % ( algoName, shapes[0].GetShapeType() )) + else: + group.SetName( algoName ) + groups.append( group ) + shapes = otherTypeShapes + pass + if publish: + for group in groups: + self.geompyD.addToStudyInFather( self.geom, group, group.GetName() ) + return groups + + ## Return sub-mesh objects list in meshing order + # @return list of lists of sub-meshes # @ingroup l2_construct def GetMeshOrder(self): return self.mesh.GetMeshOrder() - ## Return submesh objects list in meshing order - # @return list of list of submesh objects + ## Set order in which concurrent sub-meshes should be meshed + # @param submeshes list of lists of sub-meshes # @ingroup l2_construct def SetMeshOrder(self, submeshes): return self.mesh.SetMeshOrder(submeshes) - ## Removes all nodes and elements - # @refresh if @c True, Object browser is automatically updated (when running in GUI) + ## Remove all nodes and elements generated on geometry. Imported elements remain. + # @param refresh if @c True, Object browser is automatically updated (when running in GUI) # @ingroup l2_construct def Clear(self, refresh=False): self.mesh.Clear() - if ( salome.sg.hasDesktop() and + if ( salome.sg.hasDesktop() and salome.myStudyManager.GetStudyByID( self.mesh.GetStudyId() ) ): smeshgui = salome.ImportComponentGUI("SMESH") smeshgui.Init(self.mesh.GetStudyId()) smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True ) - if refresh: salome.sg.updateObjBrowser(1) + if refresh: salome.sg.updateObjBrowser(True) - ## Removes all nodes and elements of indicated shape - # @refresh if @c True, Object browser is automatically updated (when running in GUI) - # @ingroup l2_construct + ## Remove all nodes and elements of indicated shape + # @param refresh if @c True, Object browser is automatically updated (when running in GUI) + # @param geomId the ID of a sub-shape to remove elements on + # @ingroup l2_submeshes def ClearSubMesh(self, geomId, refresh=False): self.mesh.ClearSubMesh(geomId) if salome.sg.hasDesktop(): smeshgui = salome.ImportComponentGUI("SMESH") smeshgui.Init(self.mesh.GetStudyId()) smeshgui.SetMeshIcon( salome.ObjectToID( self.mesh ), False, True ) - if refresh: salome.sg.updateObjBrowser(1) + if refresh: salome.sg.updateObjBrowser(True) - ## Computes a tetrahedral mesh using AutomaticLength + MEFISTO + Tetrahedron + ## Compute a tetrahedral mesh using AutomaticLength + MEFISTO + Tetrahedron # @param fineness [0.0,1.0] defines mesh fineness # @return True or False # @ingroup l3_algos_basic @@ -1562,7 +1673,7 @@ class Mesh: pass return self.Compute() - ## Computes an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron + ## Compute an hexahedral mesh using AutomaticLength + Quadrangle + Hexahedron # @param fineness [0.0, 1.0] defines mesh fineness # @return True or False # @ingroup l3_algos_basic @@ -1579,12 +1690,14 @@ class Mesh: pass return self.Compute() - ## Assigns a hypothesis + ## Assign a hypothesis # @param hyp a hypothesis to assign # @param geom a subhape of mesh geometry # @return SMESH.Hypothesis_Status - # @ingroup l2_hypotheses + # @ingroup l2_editing def AddHypothesis(self, hyp, geom=0): + if isinstance( hyp, geomBuilder.GEOM._objref_GEOM_Object ): + hyp, geom = geom, hyp if isinstance( hyp, Mesh_Algorithm ): hyp = hyp.GetAlgorithm() pass @@ -1597,9 +1710,10 @@ class Mesh: if self.mesh.HasShapeToMesh(): hyp_type = hyp.GetName() lib_name = hyp.GetLibName() - checkAll = ( not geom.IsSame( self.mesh.GetShapeToMesh() )) - if checkAll and geom: - checkAll = geom.GetType() == 37 + # checkAll = ( not geom.IsSame( self.mesh.GetShapeToMesh() )) + # if checkAll and geom: + # checkAll = geom.GetType() == 37 + checkAll = False isApplicable = self.smeshpyD.IsApplicable(hyp_type, lib_name, geom, checkAll) if isApplicable: AssureGeomPublished( self, geom, "shape for %s" % hyp.GetName()) @@ -1618,7 +1732,7 @@ class Mesh: # @param hyp a hypothesis to check # @param geom a subhape of mesh geometry # @return True of False - # @ingroup l2_hypotheses + # @ingroup l2_editing def IsUsedHypothesis(self, hyp, geom): if not hyp: # or not geom return False @@ -1631,11 +1745,11 @@ class Mesh: return True return False - ## Unassigns a hypothesis + ## Unassign a hypothesis # @param hyp a hypothesis to unassign # @param geom a sub-shape of mesh geometry # @return SMESH.Hypothesis_Status - # @ingroup l2_hypotheses + # @ingroup l2_editing def RemoveHypothesis(self, hyp, geom=0): if not hyp: return None @@ -1650,18 +1764,18 @@ class Mesh: return self.mesh.RemoveHypothesis( shape, hyp ) hypName = GetName( hyp ) geoName = GetName( shape ) - print "WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName ) + print("WARNING: RemoveHypothesis() failed as '%s' is not assigned to '%s' shape" % ( hypName, geoName )) return None - ## Gets the list of hypotheses added on a geometry + ## Get the list of hypotheses added on a geometry # @param geom a sub-shape of mesh geometry # @return the sequence of SMESH_Hypothesis - # @ingroup l2_hypotheses + # @ingroup l2_editing def GetHypothesisList(self, geom): return self.mesh.GetHypothesisList( geom ) - ## Removes all global hypotheses - # @ingroup l2_hypotheses + ## Remove all global hypotheses + # @ingroup l2_editing def RemoveGlobalHypotheses(self): current_hyps = self.mesh.GetHypothesisList( self.geom ) for hyp in current_hyps: @@ -1669,27 +1783,29 @@ class Mesh: pass pass - ## Exports the mesh in a file in MED format and chooses the \a version of MED format + ## Export the mesh in a file in MED format ## allowing to overwrite the file if it exists or add the exported data to its contents # @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) + # the typical use is auto_groups=False. + # @param version MED format version (MED_V2_1 or MED_V2_2, + # the latter meaning any current version). The parameter is + # obsolete since MED_V2_1 is no longer supported. # @param overwrite boolean parameter for overwriting/not overwriting the file # @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh - # @param autoDimension: if @c True (default), a space dimension of a MED mesh can be either + # @param autoDimension if @c True (default), a space dimension of a MED mesh can be either # - 1D if all mesh nodes lie on OX coordinate axis, or # - 2D if all mesh nodes lie on XOY coordinate plane, or - # - 3D in the rest cases. + # - 3D in the rest cases.
# If @a autoDimension is @c False, the space dimension is always 3. - # @param fields : list of GEOM fields defined on the shape to mesh. - # @param geomAssocFields : each character of this string means a need to export a + # @param fields list of GEOM fields defined on the shape to mesh. + # @param geomAssocFields each character of this string means a need to export a # corresponding field; correspondence between fields and characters is following: - # - 'v' stands for _vertices_ field; - # - 'e' stands for _edges_ field; - # - 'f' stands for _faces_ field; - # - 's' stands for _solids_ field. + # - 'v' stands for "_vertices _" field; + # - 'e' stands for "_edges _" field; + # - 'f' stands for "_faces _" field; + # - 's' stands for "_solids _" field. # @ingroup l2_impexp def ExportMED(self, f, auto_groups=0, version=MED_V2_2, overwrite=1, meshPart=None, autoDimension=True, fields=[], geomAssocFields=''): @@ -1703,7 +1819,7 @@ class Mesh: else: self.mesh.ExportToMEDX(f, auto_groups, version, overwrite, autoDimension) - ## Exports the mesh in a file in SAUV format + ## Export the mesh in a file in SAUV 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, ... ; @@ -1712,7 +1828,7 @@ class Mesh: def ExportSAUV(self, f, auto_groups=0): self.mesh.ExportSAUV(f, auto_groups) - ## Exports the mesh in a file in DAT format + ## Export the mesh in a file in DAT format # @param f the file name # @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh # @ingroup l2_impexp @@ -1726,7 +1842,7 @@ class Mesh: else: self.mesh.ExportDAT(f) - ## Exports the mesh in a file in UNV format + ## Export the mesh in a file in UNV format # @param f the file name # @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh # @ingroup l2_impexp @@ -1755,7 +1871,7 @@ class Mesh: else: self.mesh.ExportSTL(f, ascii) - ## Exports the mesh in a file in CGNS format + ## Export the mesh in a file in CGNS format # @param f is the file name # @param overwrite boolean parameter for overwriting/not overwriting the file # @param meshPart a part of mesh (group, sub-mesh) to export instead of the mesh @@ -1771,7 +1887,7 @@ class Mesh: meshPart = self.mesh self.mesh.ExportCGNS(meshPart, f, overwrite) - ## Exports the mesh in a file in GMF format. + ## Export the mesh in a file in GMF format. # GMF files must have .mesh extension for the ASCII format and .meshb for # the bynary format. Other extensions are not allowed. # @param f is the file name @@ -1788,36 +1904,38 @@ class Mesh: meshPart = self.mesh self.mesh.ExportGMF(meshPart, f, True) - ## Deprecated, used only for compatibility! Please, use ExportToMEDX() method instead. - # Exports the mesh in a file in MED format and chooses the \a version of MED format - ## allowing to overwrite the file if it exists or add the exported data to its contents + ## Deprecated, used only for compatibility! Please, use ExportMED() method instead. + # Export the mesh in a file in MED format + # allowing to overwrite the file if it exists or add the exported data to its contents # @param f the file name - # @param version values are SMESH.MED_V2_1, SMESH.MED_V2_2 + # @param version MED format version (MED_V2_1 or MED_V2_2, + # the latter meaning any current version). The parameter is + # obsolete since MED_V2_1 is no longer supported. # @param opt boolean parameter for creating/not creating # the groups Group_On_All_Nodes, Group_On_All_Faces, ... # @param overwrite boolean parameter for overwriting/not overwriting the file - # @param autoDimension: if @c True (default), a space dimension of a MED mesh can be either + # @param autoDimension if @c True (default), a space dimension of a MED mesh can be either # - 1D if all mesh nodes lie on OX coordinate axis, or # - 2D if all mesh nodes lie on XOY coordinate plane, or - # - 3D in the rest cases. - # + # - 3D in the rest cases.
# If @a autoDimension is @c False, the space dimension is always 3. # @ingroup l2_impexp - def ExportToMED(self, f, version, opt=0, overwrite=1, autoDimension=True): + def ExportToMED(self, f, version=MED_V2_2, opt=0, overwrite=1, autoDimension=True): self.mesh.ExportToMEDX(f, opt, version, overwrite, autoDimension) # Operations with groups: # ---------------------- - ## Creates an empty mesh group - # @param elementType the type of elements in the group + ## Create an empty mesh group + # @param elementType the type of elements in the group; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME) # @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 the geometric object \a grp + ## Create 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(). @@ -1828,13 +1946,14 @@ class Mesh: def Group(self, grp, name=""): return self.GroupOnGeom(grp, name) - ## Creates a mesh group based on the geometrical object \a grp + ## Create 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 + # @param typ the type of elements in the group; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). 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): @@ -1859,17 +1978,17 @@ class Mesh: elif tgeo == "COMPOUND": sub = self.geompyD.SubShapeAll( shape, self.geompyD.ShapeType["SHAPE"]) if not sub: - raise ValueError,"_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape) + raise ValueError("_groupTypeFromShape(): empty geometric group or compound '%s'" % GetName(shape)) return self._groupTypeFromShape( sub[0] ) else: - raise ValueError, \ - "_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape) + raise ValueError("_groupTypeFromShape(): invalid geometry '%s'" % GetName(shape)) return typ - ## Creates a mesh group with given \a name based on the \a filter which + ## Create a mesh group with given \a name based on the \a filter which ## is a special type of group dynamically updating it's contents during ## mesh modification - # @param typ the type of elements in the group + # @param typ the type of elements in the group; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). # @param name the name of the mesh group # @param filter the filter defining group contents # @return SMESH_GroupOnFilter @@ -1877,10 +1996,11 @@ class Mesh: def GroupOnFilter(self, typ, name, filter): return self.mesh.CreateGroupFromFilter(typ, name, filter) - ## Creates a mesh group by the given ids of elements + ## Create 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 + # @param elementType the type of elements in the group; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). + # @param elemIDs either the list of ids, group, sub-mesh, or filter # @return SMESH_Group # @ingroup l2_grps_create def MakeGroupByIds(self, groupName, elementType, elemIDs): @@ -1893,15 +2013,17 @@ class Mesh: group.Add(elemIDs) return group - ## Creates a mesh group by the given conditions + ## Create 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 Threshold the threshold value (range of id ids as string, shape, numeric) - # @param UnaryOp FT_LogicalNOT or FT_Undefined - # @param Tolerance the tolerance used by FT_BelongToGeom, FT_BelongToSurface, - # FT_LyingOnGeom, FT_CoplanarFaces criteria + # @param elementType the type of elements(SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME) + # @param CritType the type of criterion (SMESH.FT_Taper, SMESH.FT_Area, etc.) + # Type SMESH.FunctorType._items in the Python Console to see all values. + # Note that the items starting from FT_LessThan are not suitable for CritType. + # @param Compare belongs to {SMESH.FT_LessThan, SMESH.FT_MoreThan, SMESH.FT_EqualTo} + # @param Threshold the threshold value (range of ids as string, shape, numeric) + # @param UnaryOp SMESH.FT_LogicalNOT or SMESH.FT_Undefined + # @param Tolerance the tolerance used by SMESH.FT_BelongToGeom, SMESH.FT_BelongToSurface, + # SMESH.FT_LyingOnGeom, SMESH.FT_CoplanarFaces criteria # @return SMESH_GroupOnFilter # @ingroup l2_grps_create def MakeGroup(self, @@ -1916,7 +2038,7 @@ class Mesh: group = self.MakeGroupByCriterion(groupName, aCriterion) return group - ## Creates a mesh group by the given criterion + ## Create a mesh group by the given criterion # @param groupName the name of the mesh group # @param Criterion the instance of Criterion class # @return SMESH_GroupOnFilter @@ -1924,7 +2046,7 @@ class Mesh: def MakeGroupByCriterion(self, groupName, Criterion): return self.MakeGroupByCriteria( groupName, [Criterion] ) - ## Creates a mesh group by the given criteria (list of criteria) + ## Create a mesh group by the given criteria (list of criteria) # @param groupName the name of the mesh group # @param theCriteria the list of criteria # @param binOp binary operator used when binary operator of criteria is undefined @@ -1935,7 +2057,7 @@ class Mesh: group = self.MakeGroupByFilter(groupName, aFilter) return group - ## Creates a mesh group by the given filter + ## Create a mesh group by the given filter # @param groupName the name of the mesh group # @param theFilter the instance of Filter class # @return SMESH_GroupOnFilter @@ -1947,29 +2069,42 @@ class Mesh: group = self.GroupOnFilter( theFilter.GetElementType(), groupName, theFilter ) return group - ## Removes a group + ## Remove a group # @ingroup l2_grps_delete def RemoveGroup(self, group): self.mesh.RemoveGroup(group) - ## Removes a group with its contents + ## Remove a group with its contents # @ingroup l2_grps_delete def RemoveGroupWithContents(self, group): self.mesh.RemoveGroupWithContents(group) - ## Gets the list of groups existing in the mesh in the order of creation (starting from the oldest one) + ## Get the list of groups existing in the mesh in the order + # of creation (starting from the oldest one) + # @param elemType type of elements the groups contain; either of + # (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME); + # by default groups of elements of all types are returned # @return a sequence of SMESH_GroupBase # @ingroup l2_grps_create - def GetGroups(self): - return self.mesh.GetGroups() + def GetGroups(self, elemType = SMESH.ALL): + groups = self.mesh.GetGroups() + if elemType == SMESH.ALL: + return groups + typedGroups = [] + for g in groups: + if g.GetType() == elemType: + typedGroups.append( g ) + pass + pass + return typedGroups - ## Gets the number of groups existing in the mesh + ## Get 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() - ## Gets the list of names of groups existing in the mesh + ## Get the list of names of groups existing in the mesh # @return list of strings # @ingroup l2_grps_create def GetGroupNames(self): @@ -1979,7 +2114,26 @@ class Mesh: names.append(group.GetName()) return names - ## Produces a union of two groups + ## Find groups by name and type + # @param name name of the group of interest + # @param elemType type of elements the groups contain; either of + # (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME); + # by default one group of any type of elements is returned + # if elemType == SMESH.ALL then all groups of any type are returned + # @return a list of SMESH_GroupBase's + # @ingroup l2_grps_create + def GetGroupByName(self, name, elemType = None): + groups = [] + for group in self.GetGroups(): + if group.GetName() == name: + if elemType is None: + return [group] + if ( elemType == SMESH.ALL or + group.GetType() == elemType ): + groups.append( group ) + return groups + + ## Produce 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 @@ -1987,15 +2141,15 @@ class Mesh: def UnionGroups(self, group1, group2, name): return self.mesh.UnionGroups(group1, group2, name) - ## Produces a union list of groups + ## Produce a union list of groups. # New group is created. All mesh elements that are present in # initial groups are added to the new one # @return an instance of SMESH_Group # @ingroup l2_grps_operon def UnionListOfGroups(self, groups, name): - return self.mesh.UnionListOfGroups(groups, name) + return self.mesh.UnionListOfGroups(groups, name) - ## Prodices an intersection of two groups + ## Prodice 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 @@ -2003,15 +2157,15 @@ class Mesh: def IntersectGroups(self, group1, group2, name): return self.mesh.IntersectGroups(group1, group2, name) - ## Produces an intersection of groups + ## Produce an intersection of groups. # New group is created. All mesh elements that are present in all # initial groups simultaneously are added to the new one # @return an instance of SMESH_Group # @ingroup l2_grps_operon def IntersectListOfGroups(self, groups, name): - return self.mesh.IntersectListOfGroups(groups, name) + return self.mesh.IntersectListOfGroups(groups, name) - ## Produces a cut of two groups + ## Produce 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 @@ -2019,33 +2173,50 @@ class Mesh: def CutGroups(self, main_group, tool_group, name): return self.mesh.CutGroups(main_group, tool_group, name) - ## Produces a cut of groups + ## Produce a cut of groups. # A new group is created. All mesh elements that are present in main groups # but do not present in tool groups are added to the new one # @return an instance of SMESH_Group # @ingroup l2_grps_operon def CutListOfGroups(self, main_groups, tool_groups, name): - return self.mesh.CutListOfGroups(main_groups, tool_groups, name) + return self.mesh.CutListOfGroups(main_groups, tool_groups, name) - ## Produces a group of elements of specified type using list of existing groups - # A new group is created. System - # 1) extracts all nodes on which groups elements are built - # 2) combines all elements of specified dimension laying on these nodes + ## + # Create a standalone group of entities basing on nodes of other groups. + # \param groups - list of reference groups, sub-meshes or filters, of any type. + # \param elemType - a type of elements to include to the new group; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME). + # \param name - a name of the new group. + # \param nbCommonNodes - a criterion of inclusion of an element to the new group + # basing on number of element nodes common with reference \a groups. + # Meaning of possible values are: + # - SMESH.ALL_NODES - include if all nodes are common, + # - SMESH.MAIN - include if all corner nodes are common (meaningful for a quadratic mesh), + # - SMESH.AT_LEAST_ONE - include if one or more node is common, + # - SMEHS.MAJORITY - include if half of nodes or more are common. + # \param underlyingOnly - if \c True (default), an element is included to the + # new group provided that it is based on nodes of an element of \a groups; + # in this case the reference \a groups are supposed to be of higher dimension + # than \a elemType, which can be useful for example to get all faces lying on + # volumes of the reference \a groups. # @return an instance of SMESH_Group # @ingroup l2_grps_operon - def CreateDimGroup(self, groups, elem_type, name): - return self.mesh.CreateDimGroup(groups, elem_type, name) + def CreateDimGroup(self, groups, elemType, name, + nbCommonNodes = SMESH.ALL_NODES, underlyingOnly = True): + if isinstance( groups, SMESH._objref_SMESH_IDSource ): + groups = [groups] + return self.mesh.CreateDimGroup(groups, elemType, name, nbCommonNodes, underlyingOnly) ## Convert group on geom into standalone group - # @ingroup l2_grps_delete + # @ingroup l2_grps_operon def ConvertToStandalone(self, group): return self.mesh.ConvertToStandalone(group) # Get some info about mesh: # ------------------------ - ## Returns the log of nodes and elements added or removed + ## Return 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: @@ -2057,25 +2228,27 @@ class Mesh: def GetLog(self, clearAfterGet): return self.mesh.GetLog(clearAfterGet) - ## Clears the log of nodes and elements added or removed since the previous + ## Clear 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() - ## Toggles auto color mode on the object. + ## Toggle auto color mode on the object. # @param theAutoColor the flag which toggles auto color mode. - # @ingroup l1_auxiliary + # + # If switched on, a default color of a new group in Create Group dialog is chosen randomly. + # @ingroup l1_grouping def SetAutoColor(self, theAutoColor): self.mesh.SetAutoColor(theAutoColor) - ## Gets flag of object auto color mode. + ## Get flag of object auto color mode. # @return True or False - # @ingroup l1_auxiliary + # @ingroup l1_grouping def GetAutoColor(self): return self.mesh.GetAutoColor() - ## Gets the internal ID + ## Get the internal ID # @return integer value, which is the internal Id of the mesh # @ingroup l1_auxiliary def GetId(self): @@ -2087,14 +2260,14 @@ class Mesh: def GetStudyId(self): return self.mesh.GetStudyId() - ## Checks the group names for duplications. + ## Check the group names for duplications. # Consider the maximum group name length stored in MED file. # @return True or False - # @ingroup l1_auxiliary + # @ingroup l1_grouping def HasDuplicatedGroupNamesMED(self): return self.mesh.HasDuplicatedGroupNamesMED() - ## Obtains the mesh editor tool + ## Obtain the mesh editor tool # @return an instance of SMESH_MeshEditor # @ingroup l1_modifying def GetMeshEditor(self): @@ -2102,228 +2275,241 @@ class Mesh: ## Wrap a list of IDs of elements or nodes into SMESH_IDSource which # can be passed as argument to a method accepting mesh, group or sub-mesh + # @param ids list of IDs + # @param elemType type of elements; this parameter is used to distinguish + # IDs of nodes from IDs of elements; by default ids are treated as + # IDs of elements; use SMESH.NODE if ids are IDs of nodes. # @return an instance of SMESH_IDSource + # @warning call UnRegister() for the returned object as soon as it is no more useful: + # idSrc = mesh.GetIDSource( [1,3,5], SMESH.NODE ) + # mesh.DoSomething( idSrc ) + # idSrc.UnRegister() # @ingroup l1_auxiliary - def GetIDSource(self, ids, elemType): + def GetIDSource(self, ids, elemType = SMESH.ALL): + if isinstance( ids, int ): + ids = [ids] return self.editor.MakeIDSource(ids, elemType) # Get informations about mesh contents: # ------------------------------------ - ## Gets the mesh stattistic + ## Get the mesh stattistic # @return dictionary type element - count of elements # @ingroup l1_meshinfo def GetMeshInfo(self, obj = None): if not obj: obj = self.mesh return self.smeshpyD.GetMeshInfo(obj) - ## Returns the number of nodes in the mesh + ## Return the number of nodes in the mesh # @return an integer value # @ingroup l1_meshinfo def NbNodes(self): return self.mesh.NbNodes() - ## Returns the number of elements in the mesh + ## Return the number of elements in the mesh # @return an integer value # @ingroup l1_meshinfo def NbElements(self): return self.mesh.NbElements() - ## Returns the number of 0d elements in the mesh + ## Return the number of 0d elements in the mesh # @return an integer value # @ingroup l1_meshinfo def Nb0DElements(self): return self.mesh.Nb0DElements() - ## Returns the number of ball discrete elements in the mesh + ## Return the number of ball discrete elements in the mesh # @return an integer value # @ingroup l1_meshinfo def NbBalls(self): return self.mesh.NbBalls() - ## Returns the number of edges in the mesh + ## Return the number of edges in the mesh # @return an integer value # @ingroup l1_meshinfo def NbEdges(self): return self.mesh.NbEdges() - ## Returns the number of edges with the given order in the mesh + ## Return the number of edges with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbEdgesOfOrder(self, elementOrder): return self.mesh.NbEdgesOfOrder(elementOrder) - ## Returns the number of faces in the mesh + ## Return the number of faces in the mesh # @return an integer value # @ingroup l1_meshinfo def NbFaces(self): return self.mesh.NbFaces() - ## Returns the number of faces with the given order in the mesh + ## Return the number of faces with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbFacesOfOrder(self, elementOrder): return self.mesh.NbFacesOfOrder(elementOrder) - ## Returns the number of triangles in the mesh + ## Return the number of triangles in the mesh # @return an integer value # @ingroup l1_meshinfo def NbTriangles(self): return self.mesh.NbTriangles() - ## Returns the number of triangles with the given order in the mesh + ## Return 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 + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbTrianglesOfOrder(self, elementOrder): return self.mesh.NbTrianglesOfOrder(elementOrder) - ## Returns the number of biquadratic triangles in the mesh + ## Return the number of biquadratic triangles in the mesh # @return an integer value # @ingroup l1_meshinfo def NbBiQuadTriangles(self): return self.mesh.NbBiQuadTriangles() - ## Returns the number of quadrangles in the mesh + ## Return the number of quadrangles in the mesh # @return an integer value # @ingroup l1_meshinfo def NbQuadrangles(self): return self.mesh.NbQuadrangles() - ## Returns the number of quadrangles with the given order in the mesh + ## Return the number of quadrangles with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbQuadranglesOfOrder(self, elementOrder): return self.mesh.NbQuadranglesOfOrder(elementOrder) - ## Returns the number of biquadratic quadrangles in the mesh + ## Return the number of biquadratic quadrangles in the mesh # @return an integer value # @ingroup l1_meshinfo def NbBiQuadQuadrangles(self): return self.mesh.NbBiQuadQuadrangles() - ## Returns the number of polygons in the mesh + ## Return the number of polygons of given order in the mesh + # @param elementOrder the order of elements: + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo - def NbPolygons(self): - return self.mesh.NbPolygons() + def NbPolygons(self, elementOrder = SMESH.ORDER_ANY): + return self.mesh.NbPolygonsOfOrder(elementOrder) - ## Returns the number of volumes in the mesh + ## Return the number of volumes in the mesh # @return an integer value # @ingroup l1_meshinfo def NbVolumes(self): return self.mesh.NbVolumes() - ## Returns the number of volumes with the given order in the mesh + ## Return the number of volumes with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbVolumesOfOrder(self, elementOrder): return self.mesh.NbVolumesOfOrder(elementOrder) - ## Returns the number of tetrahedrons in the mesh + ## Return the number of tetrahedrons in the mesh # @return an integer value # @ingroup l1_meshinfo def NbTetras(self): return self.mesh.NbTetras() - ## Returns the number of tetrahedrons with the given order in the mesh + ## Return the number of tetrahedrons with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbTetrasOfOrder(self, elementOrder): return self.mesh.NbTetrasOfOrder(elementOrder) - ## Returns the number of hexahedrons in the mesh + ## Return the number of hexahedrons in the mesh # @return an integer value # @ingroup l1_meshinfo def NbHexas(self): return self.mesh.NbHexas() - ## Returns the number of hexahedrons with the given order in the mesh + ## Return the number of hexahedrons with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbHexasOfOrder(self, elementOrder): return self.mesh.NbHexasOfOrder(elementOrder) - ## Returns the number of triquadratic hexahedrons in the mesh + ## Return the number of triquadratic hexahedrons in the mesh # @return an integer value # @ingroup l1_meshinfo def NbTriQuadraticHexas(self): return self.mesh.NbTriQuadraticHexas() - ## Returns the number of pyramids in the mesh + ## Return the number of pyramids in the mesh # @return an integer value # @ingroup l1_meshinfo def NbPyramids(self): return self.mesh.NbPyramids() - ## Returns the number of pyramids with the given order in the mesh + ## Return the number of pyramids with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbPyramidsOfOrder(self, elementOrder): return self.mesh.NbPyramidsOfOrder(elementOrder) - ## Returns the number of prisms in the mesh + ## Return the number of prisms in the mesh # @return an integer value # @ingroup l1_meshinfo def NbPrisms(self): return self.mesh.NbPrisms() - ## Returns the number of prisms with the given order in the mesh + ## Return the number of prisms with the given order in the mesh # @param elementOrder the order of elements: - # ORDER_ANY, ORDER_LINEAR or ORDER_QUADRATIC + # SMESH.ORDER_ANY, SMESH.ORDER_LINEAR or SMESH.ORDER_QUADRATIC # @return an integer value # @ingroup l1_meshinfo def NbPrismsOfOrder(self, elementOrder): return self.mesh.NbPrismsOfOrder(elementOrder) - ## Returns the number of hexagonal prisms in the mesh + ## Return the number of hexagonal prisms in the mesh # @return an integer value # @ingroup l1_meshinfo def NbHexagonalPrisms(self): return self.mesh.NbHexagonalPrisms() - ## Returns the number of polyhedrons in the mesh + ## Return the number of polyhedrons in the mesh # @return an integer value # @ingroup l1_meshinfo def NbPolyhedrons(self): return self.mesh.NbPolyhedrons() - ## Returns the number of submeshes in the mesh + ## Return the number of submeshes in the mesh # @return an integer value # @ingroup l1_meshinfo def NbSubMesh(self): return self.mesh.NbSubMesh() - ## Returns the list of mesh elements IDs + ## Return the list of mesh elements IDs # @return the list of integer values # @ingroup l1_meshinfo def GetElementsId(self): return self.mesh.GetElementsId() - ## Returns the list of IDs of mesh elements with the given type - # @param elementType the required type of elements (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME) + ## Return the list of IDs of mesh elements with the given type + # @param elementType the required type of elements, either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME) # @return list of integer values # @ingroup l1_meshinfo def GetElementsByType(self, elementType): return self.mesh.GetElementsByType(elementType) - ## Returns the list of mesh nodes IDs + ## Return the list of mesh nodes IDs # @return the list of integer values # @ingroup l1_meshinfo def GetNodesId(self): @@ -2332,62 +2518,65 @@ class Mesh: # Get the information about mesh elements: # ------------------------------------ - ## Returns the type of mesh element + ## Return the type of mesh element # @return the value from SMESH::ElementType enumeration + # Type SMESH.ElementType._items in the Python Console to see all possible values. # @ingroup l1_meshinfo - def GetElementType(self, id, iselem): + def GetElementType(self, id, iselem=True): return self.mesh.GetElementType(id, iselem) - ## Returns the geometric type of mesh element + ## Return the geometric type of mesh element # @return the value from SMESH::EntityType enumeration + # Type SMESH.EntityType._items in the Python Console to see all possible values. # @ingroup l1_meshinfo def GetElementGeomType(self, id): return self.mesh.GetElementGeomType(id) - ## Returns the shape type of mesh element - # @return the value from SMESH::GeometryType enumeration + ## Return the shape type of mesh element + # @return the value from SMESH::GeometryType enumeration. + # Type SMESH.GeometryType._items in the Python Console to see all possible values. # @ingroup l1_meshinfo def GetElementShape(self, id): return self.mesh.GetElementShape(id) - ## Returns the list of submesh elements IDs - # @param Shape a geom object(sub-shape) IOR + ## Return the list of submesh elements IDs + # @param Shape a geom object(sub-shape) # Shape must be the sub-shape of a ShapeToMesh() # @return the list of integer values # @ingroup l1_meshinfo def GetSubMeshElementsId(self, Shape): - if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)): - ShapeID = Shape.GetSubShapeIndices()[0] + if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object): + ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape ) else: ShapeID = Shape return self.mesh.GetSubMeshElementsId(ShapeID) - ## Returns the list of submesh nodes IDs - # @param Shape a geom object(sub-shape) IOR + ## Return the list of submesh nodes IDs + # @param Shape a geom object(sub-shape) # Shape must be the sub-shape 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, geomBuilder.GEOM._objref_GEOM_Object)): + if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object): ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape ) else: ShapeID = Shape return self.mesh.GetSubMeshNodesId(ShapeID, all) - ## Returns type of elements on given shape - # @param Shape a geom object(sub-shape) IOR + ## Return type of elements on given shape + # @param Shape a geom object(sub-shape) # Shape must be a sub-shape of a ShapeToMesh() # @return element type # @ingroup l1_meshinfo def GetSubMeshElementType(self, Shape): - if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)): - ShapeID = Shape.GetSubShapeIndices()[0] + if isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object): + ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape ) else: ShapeID = Shape return self.mesh.GetSubMeshElementType(ShapeID) - ## Gets the mesh description + ## Get the mesh description # @return string value # @ingroup l1_meshinfo def Dump(self): @@ -2397,127 +2586,128 @@ class Mesh: # Get the information about nodes and elements of a mesh by its IDs: # ----------------------------------------------------------- - ## Gets XYZ coordinates of a node - # \n If there is no nodes for the given ID - returns an empty list + ## Get XYZ coordinates of a node + # \n If there is no nodes for the given ID - return an empty list # @return a list of double precision values # @ingroup l1_meshinfo def GetNodeXYZ(self, id): return self.mesh.GetNodeXYZ(id) - ## 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 list of IDs of inverse elements for the given node + # \n If there is no node for the given ID - return an empty list # @return a list of integer values # @ingroup l1_meshinfo def GetNodeInverseElements(self, id): return self.mesh.GetNodeInverseElements(id) - ## @brief Returns the position of a node on the shape + ## Return the position of a node on the shape # @return SMESH::NodePosition # @ingroup l1_meshinfo def GetNodePosition(self,NodeID): return self.mesh.GetNodePosition(NodeID) - ## @brief Returns the position of an element on the shape + ## Return the position of an element on the shape # @return SMESH::ElementPosition # @ingroup l1_meshinfo def GetElementPosition(self,ElemID): return self.mesh.GetElementPosition(ElemID) - ## 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 + ## Return the ID of the shape, on which the given node was generated. + # @return an integer value > 0 or -1 if there is no node for the given + # ID or the node is not assigned to any geometry # @ingroup l1_meshinfo def GetShapeID(self, id): return self.mesh.GetShapeID(id) - ## 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 + ## Return the ID of the shape, on which the given element was generated. + # @return an integer value > 0 or -1 if there is no element for the given + # ID or the element is not assigned to any geometry # @ingroup l1_meshinfo def GetShapeIDForElem(self,id): return self.mesh.GetShapeIDForElem(id) - ## 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 + ## Return the number of nodes of the given element + # @return an integer value > 0 or -1 if there is no element for the given ID # @ingroup l1_meshinfo def GetElemNbNodes(self, id): return self.mesh.GetElemNbNodes(id) - ## Returns the node ID the given (zero based) 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 the node ID the given (zero based) index for the given element + # \n If there is no element for the given ID - return -1 + # \n If there is no node for the given index - return -2 # @return an integer value # @ingroup l1_meshinfo def GetElemNode(self, id, index): return self.mesh.GetElemNode(id, index) - ## Returns the IDs of nodes of the given element + ## Return 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 the given node is the medium node in the given quadratic element + ## Return 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 the given node is the medium node in one of quadratic elements + ## Return true if the given node is the medium node in one of quadratic elements + # @param nodeID ID of the node + # @param elementType the type of elements to check a state of the node, either of + # (SMESH.ALL, SMESH.NODE, SMESH.EDGE, SMESH.FACE or SMESH.VOLUME) # @ingroup l1_meshinfo - def IsMediumNodeOfAnyElem(self, nodeID, elementType): + def IsMediumNodeOfAnyElem(self, nodeID, elementType = SMESH.ALL ): return self.mesh.IsMediumNodeOfAnyElem(nodeID, elementType) - ## Returns the number of edges for the given element + ## Return the number of edges for the given element # @ingroup l1_meshinfo def ElemNbEdges(self, id): return self.mesh.ElemNbEdges(id) - ## Returns the number of faces for the given element + ## Return the number of faces for the given element # @ingroup l1_meshinfo def ElemNbFaces(self, id): return self.mesh.ElemNbFaces(id) - ## Returns nodes of given face (counted from zero) for given volumic element. + ## Return nodes of given face (counted from zero) for given volumic element. # @ingroup l1_meshinfo def GetElemFaceNodes(self,elemId, faceIndex): return self.mesh.GetElemFaceNodes(elemId, faceIndex) - ## Returns three components of normal of given mesh face + ## Return three components of normal of given mesh face # (or an empty array in KO case) # @ingroup l1_meshinfo def GetFaceNormal(self, faceId, normalized=False): return self.mesh.GetFaceNormal(faceId,normalized) - ## Returns an element based on all given nodes. + ## Return an element based on all given nodes. # @ingroup l1_meshinfo def FindElementByNodes(self,nodes): return self.mesh.FindElementByNodes(nodes) - ## Returns true if the given element is a polygon + ## Return true if the given element is a polygon # @ingroup l1_meshinfo def IsPoly(self, id): return self.mesh.IsPoly(id) - ## Returns true if the given element is quadratic + ## Return true if the given element is quadratic # @ingroup l1_meshinfo def IsQuadratic(self, id): return self.mesh.IsQuadratic(id) - ## Returns diameter of a ball discrete element or zero in case of an invalid \a id + ## Return diameter of a ball discrete element or zero in case of an invalid \a id # @ingroup l1_meshinfo def GetBallDiameter(self, id): return self.mesh.GetBallDiameter(id) - ## 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 XYZ coordinates of the barycenter of the given element + # \n If there is no element for the given ID - return an empty list # @return a list of three double values # @ingroup l1_meshinfo def BaryCenter(self, id): return self.mesh.BaryCenter(id) - ## Passes mesh elements through the given filter and return IDs of fitting elements + ## Pass mesh elements through the given filter and return IDs of fitting elements # @param theFilter SMESH_Filter # @return a list of ids # @ingroup l1_controls @@ -2525,10 +2715,13 @@ class Mesh: theFilter.SetMesh( self.mesh ) return theFilter.GetIDs() - ## Verifies whether a 2D mesh element has free edges (edges connected to one face only)\n - # Returns a list of special structures (borders). + # Get mesh measurements information: + # ------------------------------------ + + ## Verify whether a 2D mesh element has free edges (edges connected to one face only)\n + # Return 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 + # @ingroup l1_measurements def GetFreeBorders(self): aFilterMgr = self.smeshpyD.CreateFilterManager() aPredicate = aFilterMgr.CreateFreeEdges() @@ -2537,10 +2730,6 @@ class Mesh: aFilterMgr.UnRegister() return aBorders - - # Get mesh measurements information: - # ------------------------------------ - ## Get minimum distance between two nodes, elements or distance to the origin # @param id1 first node/element id # @param id2 second node/element id (if 0, distance from @a id1 to the origin is computed) @@ -2548,6 +2737,7 @@ class Mesh: # @param isElem2 @c True if @a id2 is element id, @c False if it is node id # @return minimum distance value # @sa GetMinDistance() + # @ingroup l1_measurements def MinDistance(self, id1, id2=0, isElem1=False, isElem2=False): aMeasure = self.GetMinDistance(id1, id2, isElem1, isElem2) return aMeasure.value @@ -2559,6 +2749,7 @@ class Mesh: # @param isElem2 @c True if @a id2 is element id, @c False if it is node id # @return Measure structure # @sa MinDistance() + # @ingroup l1_measurements def GetMinDistance(self, id1, id2=0, isElem1=False, isElem2=False): if isElem1: id1 = self.editor.MakeIDSource([id1], SMESH.FACE) @@ -2584,6 +2775,7 @@ class Mesh: # @c False specifies that @a objects are nodes # @return tuple of six values (minX, minY, minZ, maxX, maxY, maxZ) # @sa GetBoundingBox() + # @ingroup l1_measurements def BoundingBox(self, objects=None, isElem=False): result = self.GetBoundingBox(objects, isElem) if result is None: @@ -2598,6 +2790,7 @@ class Mesh: # @c False specifies that @a objects are nodes # @return Measure structure # @sa BoundingBox() + # @ingroup l1_measurements def GetBoundingBox(self, IDs=None, isElem=False): if IDs is None: IDs = [self.mesh] @@ -2632,21 +2825,21 @@ class Mesh: # Mesh edition (SMESH_MeshEditor functionality): # --------------------------------------------- - ## Removes the elements from the mesh by ids + ## Remove 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 + ## Remove nodes from mesh by ids # @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) - ## Removes all orphan (free) nodes from mesh + ## Remove all orphan (free) nodes from mesh # @return number of the removed nodes # @ingroup l2_modif_del def RemoveOrphanNodes(self): @@ -2660,34 +2853,36 @@ class Mesh: if hasVars: self.mesh.SetParameters(Parameters) return self.editor.AddNode( x, y, z) - ## Creates a 0D element on a node with given number. + ## Create a 0D element on a node with given number. # @param IDOfNode the ID of node for creation of the element. + # @param DuplicateElements to add one more 0D element to a node or not # @return the Id of the new 0D element # @ingroup l2_modif_add - def Add0DElement(self, IDOfNode): - return self.editor.Add0DElement(IDOfNode) + def Add0DElement( self, IDOfNode, DuplicateElements=True ): + return self.editor.Add0DElement( IDOfNode, DuplicateElements ) - ## Create 0D elements on all nodes of the given elements except those + ## Create 0D elements on all nodes of the given elements except those # nodes on which a 0D element already exists. # @param theObject an object on whose nodes 0D elements will be created. # It can be mesh, sub-mesh, group, list of element IDs or a holder # of nodes IDs created by calling mesh.GetIDSource( nodes, SMESH.NODE ) # @param theGroupName optional name of a group to add 0D elements created # and/or found on nodes of \a theObject. + # @param DuplicateElements to add one more 0D element to a node or not # @return an object (a new group or a temporary SMESH_IDSource) holding - # IDs of new and/or found 0D elements. IDs of 0D elements + # IDs of new and/or found 0D elements. IDs of 0D elements # can be retrieved from the returned object by calling GetIDs() # @ingroup l2_modif_add - def Add0DElementsToAllNodes(self, theObject, theGroupName=""): + def Add0DElementsToAllNodes(self, theObject, theGroupName="", DuplicateElements=False): unRegister = genObjUnRegister() if isinstance( theObject, Mesh ): theObject = theObject.GetMesh() - if isinstance( theObject, list ): + elif isinstance( theObject, list ): theObject = self.GetIDSource( theObject, SMESH.ALL ) unRegister.set( theObject ) - return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName ) + return self.editor.Create0DElementsOnAllNodes( theObject, theGroupName, DuplicateElements ) - ## Creates a ball element on a node with given ID. + ## Create a ball element on a node with given ID. # @param IDOfNode the ID of node for creation of the element. # @param diameter the bal diameter. # @return the Id of the new ball element @@ -2695,7 +2890,7 @@ class Mesh: def AddBall(self, IDOfNode, diameter): return self.editor.AddBall( IDOfNode, diameter ) - ## Creates a linear or quadratic edge (this is determined + ## Create 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 @@ -2706,7 +2901,7 @@ class Mesh: def AddEdge(self, IDsOfNodes): return self.editor.AddEdge(IDsOfNodes) - ## Creates a linear or quadratic face (this is determined + ## Create 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 @@ -2717,14 +2912,22 @@ class Mesh: def AddFace(self, IDsOfNodes): return self.editor.AddFace(IDsOfNodes) - ## Adds a polygonal face to the mesh by the list of node IDs + ## Add 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) - ## Creates both simple and quadratic volume (this is determined + ## Add a quadratic polygonal face to the mesh by the list of node IDs + # @param IdsOfNodes the list of node IDs for creation of the element; + # corner nodes follow first. + # @return the Id of the new face + # @ingroup l2_modif_add + def AddQuadPolygonalFace(self, IdsOfNodes): + return self.editor.AddQuadPolygonalFace(IdsOfNodes) + + ## Create 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 @@ -2735,7 +2938,7 @@ class Mesh: def AddVolume(self, IDsOfNodes): return self.editor.AddVolume(IDsOfNodes) - ## Creates a volume of many faces, giving nodes for each face. + ## Create 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. @@ -2744,7 +2947,7 @@ class Mesh: def AddPolyhedralVolume (self, IdsOfNodes, Quantities): return self.editor.AddPolyhedralVolume(IdsOfNodes, Quantities) - ## Creates a volume of many faces, giving the IDs of the existing faces. + ## Create 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 the nodes @@ -2762,13 +2965,13 @@ class Mesh: # @ingroup l2_modif_add def SetNodeOnVertex(self, NodeID, Vertex): if ( isinstance( Vertex, geomBuilder.GEOM._objref_GEOM_Object)): - VertexID = Vertex.GetSubShapeIndices()[0] + VertexID = self.geompyD.GetSubShapeID( self.geom, Vertex ) else: VertexID = Vertex try: self.editor.SetNodeOnVertex(NodeID, VertexID) - except SALOME.SALOME_Exception, inst: - raise ValueError, inst.details.text + except SALOME.SALOME_Exception as inst: + raise ValueError(inst.details.text) return True @@ -2780,13 +2983,13 @@ class Mesh: # @ingroup l2_modif_add def SetNodeOnEdge(self, NodeID, Edge, paramOnEdge): if ( isinstance( Edge, geomBuilder.GEOM._objref_GEOM_Object)): - EdgeID = Edge.GetSubShapeIndices()[0] + EdgeID = self.geompyD.GetSubShapeID( self.geom, Edge ) else: EdgeID = Edge try: self.editor.SetNodeOnEdge(NodeID, EdgeID, paramOnEdge) - except SALOME.SALOME_Exception, inst: - raise ValueError, inst.details.text + except SALOME.SALOME_Exception as inst: + raise ValueError(inst.details.text) return True ## @brief Stores node position on a face @@ -2798,13 +3001,13 @@ class Mesh: # @ingroup l2_modif_add def SetNodeOnFace(self, NodeID, Face, u, v): if ( isinstance( Face, geomBuilder.GEOM._objref_GEOM_Object)): - FaceID = Face.GetSubShapeIndices()[0] + FaceID = self.geompyD.GetSubShapeID( self.geom, Face ) else: FaceID = Face try: self.editor.SetNodeOnFace(NodeID, FaceID, u, v) - except SALOME.SALOME_Exception, inst: - raise ValueError, inst.details.text + except SALOME.SALOME_Exception as inst: + raise ValueError(inst.details.text) return True ## @brief Binds a node to a solid @@ -2814,13 +3017,13 @@ class Mesh: # @ingroup l2_modif_add def SetNodeInVolume(self, NodeID, Solid): if ( isinstance( Solid, geomBuilder.GEOM._objref_GEOM_Object)): - SolidID = Solid.GetSubShapeIndices()[0] + SolidID = self.geompyD.GetSubShapeID( self.geom, Solid ) else: SolidID = Solid try: self.editor.SetNodeInVolume(NodeID, SolidID) - except SALOME.SALOME_Exception, inst: - raise ValueError, inst.details.text + except SALOME.SALOME_Exception as inst: + raise ValueError(inst.details.text) return True ## @brief Bind an element to a shape @@ -2830,93 +3033,94 @@ class Mesh: # @ingroup l2_modif_add def SetMeshElementOnShape(self, ElementID, Shape): if ( isinstance( Shape, geomBuilder.GEOM._objref_GEOM_Object)): - ShapeID = Shape.GetSubShapeIndices()[0] + ShapeID = self.geompyD.GetSubShapeID( self.geom, Shape ) else: ShapeID = Shape try: self.editor.SetMeshElementOnShape(ElementID, ShapeID) - except SALOME.SALOME_Exception, inst: - raise ValueError, inst.details.text + except SALOME.SALOME_Exception as inst: + raise ValueError(inst.details.text) return True - ## Moves the node with the given id + ## Move 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 + # @ingroup l2_modif_edit def MoveNode(self, NodeID, x, y, z): x,y,z,Parameters,hasVars = ParseParameters(x,y,z) if hasVars: self.mesh.SetParameters(Parameters) return self.editor.MoveNode(NodeID, x, y, z) - ## Finds the node closest to a point and moves it to a point location + ## Find 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 # @param NodeID if specified (>0), the node with this ID is moved, # otherwise, the node closest to point (@a x,@a y,@a z) is moved # @return the ID of a node - # @ingroup l2_modif_throughp + # @ingroup l2_modif_edit def MoveClosestNodeToPoint(self, x, y, z, NodeID): x,y,z,Parameters,hasVars = ParseParameters(x,y,z) if hasVars: self.mesh.SetParameters(Parameters) return self.editor.MoveClosestNodeToPoint(x, y, z, NodeID) - ## Finds the node closest to a point + ## Find 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 + # @ingroup l1_meshinfo def FindNodeClosestTo(self, x, y, z): #preview = self.mesh.GetMeshEditPreviewer() #return preview.MoveClosestNodeToPoint(x, y, z, -1) return self.editor.FindNodeClosestTo(x, y, z) - ## Finds the elements where a point lays IN or ON + ## Find the elements where a point lays IN or ON # @param x the X coordinate of a point # @param y the Y coordinate of a point # @param z the Z coordinate of a point - # @param elementType type of elements to find (SMESH.ALL type - # means elements of any type excluding nodes, discrete and 0D elements) + # @param elementType type of elements to find; either of + # (SMESH.NODE, SMESH.EDGE, SMESH.FACE, SMESH.VOLUME); SMESH.ALL type + # means elements of any type excluding nodes, discrete and 0D elements. # @param meshPart a part of mesh (group, sub-mesh) to search within # @return list of IDs of found elements - # @ingroup l2_modif_throughp + # @ingroup l1_meshinfo def FindElementsByPoint(self, x, y, z, elementType = SMESH.ALL, meshPart=None): if meshPart: return self.editor.FindAmongElementsByPoint( meshPart, x, y, z, elementType ); else: return self.editor.FindElementsByPoint(x, y, z, elementType) - # Return point state in a closed 2D mesh in terms of TopAbs_State enumeration: - # 0-IN, 1-OUT, 2-ON, 3-UNKNOWN - # TopAbs_UNKNOWN state means that either mesh is wrong or the analysis fails. - + ## Return point state in a closed 2D mesh in terms of TopAbs_State enumeration: + # 0-IN, 1-OUT, 2-ON, 3-UNKNOWN + # UNKNOWN state means that either mesh is wrong or the analysis fails. + # @ingroup l1_meshinfo def GetPointState(self, x, y, z): return self.editor.GetPointState(x, y, z) - ## Finds the node closest to a point and moves it to a point location + ## Find 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 + # @ingroup l2_modif_edit def MeshToPassThroughAPoint(self, x, y, z): return self.editor.MoveClosestNodeToPoint(x, y, z, -1) - ## Replaces two neighbour triangles sharing Node1-Node2 link + ## Replace 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 + # @ingroup l2_modif_cutquadr def InverseDiag(self, NodeID1, NodeID2): return self.editor.InverseDiag(NodeID1, NodeID2) - ## Replaces two neighbour triangles sharing Node1-Node2 link + ## Replace two neighbour triangles sharing Node1-Node2 link # with a quadrangle built on the same 4 nodes. # @param NodeID1 the ID of the first node # @param NodeID2 the ID of the second node @@ -2925,7 +3129,7 @@ class Mesh: def DeleteDiag(self, NodeID1, NodeID2): return self.editor.DeleteDiag(NodeID1, NodeID2) - ## Reorients elements by ids + ## Reorient elements by ids # @param IDsOfElements if undefined reorients all mesh elements # @return True if succeed else False # @ingroup l2_modif_changori @@ -2934,7 +3138,7 @@ class Mesh: IDsOfElements = self.GetElementsId() return self.editor.Reorient(IDsOfElements) - ## Reorients all elements of the object + ## Reorient all elements of the object # @param theObject mesh, submesh or group # @return True if succeed else False # @ingroup l2_modif_changori @@ -3011,13 +3215,15 @@ class Mesh: unRegister.set( the3DObject ) return self.editor.Reorient2DBy3D( the2DObject, the3DObject, theOutsideNormal ) - ## Fuses the neighbouring triangles into quadrangles. - # @param IDsOfElements The triangles to be fused, - # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to - # choose a neighbour to fuse with. + ## Fuse the neighbouring triangles into quadrangles. + # @param IDsOfElements The triangles to be fused. + # @param theCriterion a numerical functor, in terms of enum SMESH.FunctorType, used to + # applied to possible quadrangles to choose a neighbour to fuse with. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @param MaxAngle is the maximum angle between element normals at which the fusion - # is still performed; theMaxAngle is mesured in radians. - # Also it could be a name of variable which defines angle in degrees. + # is still performed; theMaxAngle is mesured in radians. + # Also it could be a name of variable which defines angle in degrees. # @return TRUE in case of success, FALSE otherwise. # @ingroup l2_modif_unitetri def TriToQuad(self, IDsOfElements, theCriterion, MaxAngle): @@ -3028,12 +3234,14 @@ class Mesh: Functor = self.smeshpyD.GetFunctor(theCriterion) return self.editor.TriToQuad(IDsOfElements, Functor, MaxAngle) - ## Fuses the neighbouring triangles of the object into quadrangles + ## Fuse the neighbouring triangles of the object into quadrangles # @param theObject is mesh, submesh or group - # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to - # choose a neighbour to fuse with. + # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, + # applied to possible quadrangles to choose a neighbour to fuse with. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @param MaxAngle a max angle between element normals at which the fusion - # is still performed; theMaxAngle is mesured in radians. + # 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): @@ -3044,11 +3252,13 @@ class Mesh: Functor = self.smeshpyD.GetFunctor(theCriterion) return self.editor.TriToQuadObject(theObject, Functor, MaxAngle) - ## Splits quadrangles into triangles. + ## Split quadrangles into triangles. # @param IDsOfElements the faces to be splitted. - # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to + # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to # choose a diagonal for splitting. If @a theCriterion is None, which is a default # value, then quadrangles will be split by the smallest diagonal. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @return TRUE in case of success, FALSE otherwise. # @ingroup l2_modif_cutquadr def QuadToTri (self, IDsOfElements, theCriterion = None): @@ -3059,12 +3269,14 @@ class Mesh: Functor = self.smeshpyD.GetFunctor(theCriterion) return self.editor.QuadToTri(IDsOfElements, Functor) - ## Splits quadrangles into triangles. + ## Split quadrangles into triangles. # @param theObject the object from which the list of elements is taken, # this is mesh, submesh or group # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to # choose a diagonal for splitting. If @a theCriterion is None, which is a default # value, then quadrangles will be split by the smallest diagonal. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @return TRUE in case of success, FALSE otherwise. # @ingroup l2_modif_cutquadr def QuadToTriObject (self, theObject, theCriterion = None): @@ -3075,7 +3287,7 @@ class Mesh: Functor = self.smeshpyD.GetFunctor(theCriterion) return self.editor.QuadToTriObject(theObject, Functor) - ## Splits each of given quadrangles into 4 triangles. A node is added at the center of + ## Split each of given quadrangles into 4 triangles. A node is added at the center of # a quadrangle. # @param theElements the faces to be splitted. This can be either mesh, sub-mesh, # group or a list of face IDs. By default all quadrangles are split @@ -3091,7 +3303,7 @@ class Mesh: unRegister.set( theElements ) return self.editor.QuadTo4Tri( theElements ) - ## Splits quadrangles into triangles. + ## Split 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. @@ -3101,7 +3313,7 @@ class Mesh: IDsOfElements = self.GetElementsId() return self.editor.SplitQuad(IDsOfElements, Diag13) - ## Splits quadrangles into triangles. + ## Split 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. @@ -3112,17 +3324,19 @@ class Mesh: theObject = theObject.GetMesh() return self.editor.SplitQuadObject(theObject, Diag13) - ## Finds a better splitting of the given quadrangle. + ## Find a better splitting of the given quadrangle. # @param IDOfQuad the ID of the quadrangle to be splitted. # @param theCriterion is a numerical functor, in terms of enum SMESH.FunctorType, used to # choose a diagonal for splitting. + # Type SMESH.FunctorType._items in the Python Console to see all items. + # Note that not all items correspond to numerical functors. # @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)) - ## Splits volumic elements into tetrahedrons + ## Split volumic elements into tetrahedrons # @param elems either a list of elements or a mesh or a group or a submesh or a filter # @param method flags passing splitting method: # smesh.Hex_5Tet, smesh.Hex_6Tet, smesh.Hex_24Tet. @@ -3136,8 +3350,31 @@ class Mesh: elems = self.editor.MakeIDSource(elems, SMESH.VOLUME) unRegister.set( elems ) self.editor.SplitVolumesIntoTetra(elems, method) + return - ## Splits hexahedra into prisms + ## Split bi-quadratic elements into linear ones without creation of additional nodes: + # - bi-quadratic triangle will be split into 3 linear quadrangles; + # - bi-quadratic quadrangle will be split into 4 linear quadrangles; + # - tri-quadratic hexahedron will be split into 8 linear hexahedra. + # Quadratic elements of lower dimension adjacent to the split bi-quadratic element + # will be split in order to keep the mesh conformal. + # @param elems - elements to split: sub-meshes, groups, filters or element IDs; + # if None (default), all bi-quadratic elements will be split + # @ingroup l2_modif_cutquadr + def SplitBiQuadraticIntoLinear(self, elems=None): + unRegister = genObjUnRegister() + if elems and isinstance( elems, list ) and isinstance( elems[0], int ): + elems = self.editor.MakeIDSource(elems, SMESH.ALL) + unRegister.set( elems ) + if elems is None: + elems = [ self.GetMesh() ] + if isinstance( elems, Mesh ): + elems = [ elems.GetMesh() ] + if not isinstance( elems, list ): + elems = [elems] + self.editor.SplitBiQuadraticIntoLinear( elems ) + + ## Split hexahedra into prisms # @param elems either a list of elements or a mesh or a group or a submesh or a filter # @param startHexPoint a point used to find a hexahedron for which @a facetNormal # gives a normal vector defining facets to split into triangles. @@ -3178,9 +3415,9 @@ class Mesh: self.editor.SplitHexahedraIntoPrisms(elems, startHexPoint, facetNormal, method, allDomains) - ## Splits quadrangle faces near triangular facets of volumes + ## Split quadrangle faces near triangular facets of volumes # - # @ingroup l1_auxiliary + # @ingroup l2_modif_cutquadr def SplitQuadsNearTriangularFacets(self): faces_array = self.GetElementsByType(SMESH.FACE) for face_id in faces_array: @@ -3218,7 +3455,7 @@ class Mesh: # 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 + # @ingroup l2_modif_cutquadr def SplitHexaToTetras (self, theObject, theNode000, theNode001): # Pattern: 5.---------.6 # /|#* /| @@ -3254,12 +3491,12 @@ class Mesh: pattern = self.smeshpyD.GetPattern() isDone = pattern.LoadFromFile(pattern_tetra) if not isDone: - print 'Pattern.LoadFromFile :', pattern.GetErrorCode() + print('Pattern.LoadFromFile :', pattern.GetErrorCode()) return isDone pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001) isDone = pattern.MakeMesh(self.mesh, False, False) - if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode() + if not isDone: print('Pattern.MakeMesh :', pattern.GetErrorCode()) # split quafrangle faces near triangular facets of volumes self.SplitQuadsNearTriangularFacets() @@ -3276,7 +3513,7 @@ class Mesh: # 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 + # @ingroup l2_modif_cutquadr def SplitHexaToPrisms (self, theObject, theNode000, theNode001): # Pattern: 5.---------.6 # /|# /| @@ -3308,19 +3545,19 @@ class Mesh: pattern = self.smeshpyD.GetPattern() isDone = pattern.LoadFromFile(pattern_prism) if not isDone: - print 'Pattern.LoadFromFile :', pattern.GetErrorCode() + print('Pattern.LoadFromFile :', pattern.GetErrorCode()) return isDone pattern.ApplyToHexahedrons(self.mesh, theObject.GetIDs(), theNode000, theNode001) isDone = pattern.MakeMesh(self.mesh, False, False) - if not isDone: print 'Pattern.MakeMesh :', pattern.GetErrorCode() + if not isDone: print('Pattern.MakeMesh :', pattern.GetErrorCode()) - # Splits quafrangle faces near triangular facets of volumes + # Split quafrangle faces near triangular facets of volumes self.SplitQuadsNearTriangularFacets() return isDone - ## Smoothes elements + ## Smooth 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. @@ -3339,7 +3576,7 @@ class Mesh: return self.editor.Smooth(IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Smoothes elements which belong to the given object + ## Smooth 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. @@ -3356,7 +3593,7 @@ class Mesh: return self.editor.SmoothObject(theObject, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Parametrically smoothes the given elements + ## Parametrically smooth 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. @@ -3375,7 +3612,7 @@ class Mesh: return self.editor.SmoothParametric(IDsOfElements, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Parametrically smoothes the elements which belong to the given object + ## Parametrically smooth 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. @@ -3392,13 +3629,14 @@ class Mesh: return self.editor.SmoothParametricObject(theObject, IDsOfFixedNodes, MaxNbOfIterations, MaxAspectRatio, Method) - ## Converts the mesh to quadratic or bi-quadratic, deletes old elements, replacing + ## Convert the mesh to quadratic or bi-quadratic, deletes old elements, replacing # them with quadratic with the same id. # @param theForce3d new node creation method: # 0 - the medium node lies at the geometrical entity from which the mesh element is built # 1 - the medium node lies at the middle of the line segments connecting two nodes of a mesh element # @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal # @param theToBiQuad If True, converts the mesh to bi-quadratic + # @return SMESH.ComputeError which can hold a warning # @ingroup l2_modif_tofromqu def ConvertToQuadratic(self, theForce3d=False, theSubMesh=None, theToBiQuad=False): if isinstance( theSubMesh, Mesh ): @@ -3412,9 +3650,10 @@ class Mesh: self.editor.ConvertToQuadratic(theForce3d) error = self.editor.GetLastError() if error and error.comment: - print error.comment - - ## Converts the mesh from quadratic to ordinary, + print(error.comment) + return error + + ## Convert the mesh from quadratic to ordinary, # deletes old quadratic elements, \n replacing # them with ordinary mesh elements with the same id. # @param theSubMesh a group or a sub-mesh to convert; WARNING: in this case the mesh can become not conformal @@ -3425,19 +3664,19 @@ class Mesh: else: return self.editor.ConvertFromQuadratic() - ## Creates 2D mesh as skin on boundary faces of a 3D mesh + ## Create 2D mesh as skin on boundary faces of a 3D mesh # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit - def Make2DMeshFrom3D(self): - return self.editor. Make2DMeshFrom3D() + # @ingroup l2_modif_add + def Make2DMeshFrom3D(self): + return self.editor.Make2DMeshFrom3D() - ## Creates missing boundary elements + ## Create missing boundary elements # @param elements - elements whose boundary is to be checked: # mesh, group, sub-mesh or list of elements # if elements is mesh, it must be the mesh whose MakeBoundaryMesh() is called - # @param dimension - defines type of boundary elements to create: - # SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D - # SMESH.BND_1DFROM3D creates mesh edges on all borders of free facets of 3D cells + # @param dimension - defines type of boundary elements to create, either of + # { SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D } + # SMESH.BND_1DFROM3D create mesh edges on all borders of free facets of 3D cells # @param groupName - a name of group to store created boundary elements in, # "" means not to create the group # @param meshName - a name of new mesh to store created boundary elements in, @@ -3447,7 +3686,7 @@ class Mesh: # @param toCopyExistingBondary - if true, not only new but also pre-existing # boundary elements will be copied into the new mesh # @return tuple (mesh, group) where boundary elements were added to - # @ingroup l2_modif_edit + # @ingroup l2_modif_add def MakeBoundaryMesh(self, elements, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="", toCopyElements=False, toCopyExistingBondary=False): unRegister = genObjUnRegister() @@ -3464,12 +3703,13 @@ class Mesh: return mesh, group ## - # @brief Creates missing boundary elements around either the whole mesh or + # @brief Create missing boundary elements around either the whole mesh or # groups of elements - # @param dimension - defines type of boundary elements to create + # @param dimension - defines type of boundary elements to create, either of + # { SMESH.BND_2DFROM3D, SMESH.BND_1DFROM3D, SMESH.BND_1DFROM2D } # @param groupName - a name of group to store all boundary elements in, # "" means not to create the group - # @param meshName - a name of a new mesh, which is a copy of the initial + # @param meshName - a name of a new mesh, which is a copy of the initial # mesh + created boundary elements; "" means not to create the new mesh # @param toCopyAll - if true, the whole initial mesh will be copied into # the new mesh else only boundary elements will be copied into the new mesh @@ -3479,6 +3719,7 @@ class Mesh: # mesh - the mesh where elements were added to # group - the group of boundary elements or None # + # @ingroup l2_modif_add def MakeBoundaryElements(self, dimension=SMESH.BND_2DFROM3D, groupName="", meshName="", toCopyAll=False, groups=[]): nb, mesh, group = self.editor.MakeBoundaryElements(dimension,groupName,meshName, @@ -3496,10 +3737,27 @@ class Mesh: def RenumberElements(self): self.editor.RenumberElements() - ## 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 (in radians) or a name of variable which defines angle in degrees + ## Private method converting \a arg into a list of SMESH_IdSource's + def _getIdSourceList(self, arg, idType, unRegister): + if arg and isinstance( arg, list ): + if isinstance( arg[0], int ): + arg = self.GetIDSource( arg, idType ) + unRegister.set( arg ) + elif isinstance( arg[0], Mesh ): + arg[0] = arg[0].GetMesh() + elif isinstance( arg, Mesh ): + arg = arg.GetMesh() + if arg and isinstance( arg, SMESH._objref_SMESH_IDSource ): + arg = [arg] + return arg + + ## Generate new elements by rotation of the given elements and nodes around the axis + # @param nodes - nodes to revolve: a list including ids, groups, sub-meshes or a mesh + # @param edges - edges to revolve: a list including ids, groups, sub-meshes or a mesh + # @param faces - faces to revolve: a list including ids, groups, sub-meshes or a mesh + # @param Axis the axis of rotation: AxisStruct, line (geom object) or [x,y,z,dx,dy,dz] + # @param AngleInRadians the angle of Rotation (in radians) or a name of variable + # which defines angle in degrees # @param NbOfSteps the number of steps # @param Tolerance tolerance # @param MakeGroups forces the generation of new groups from existing ones @@ -3507,25 +3765,46 @@ class Mesh: # 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( Axis, geomBuilder.GEOM._objref_GEOM_Object)): - Axis = self.smeshpyD.GetAxisStruct(Axis) + def RotationSweepObjects(self, nodes, edges, faces, Axis, AngleInRadians, NbOfSteps, Tolerance, + MakeGroups=False, TotalAngle=False): + unRegister = genObjUnRegister() + nodes = self._getIdSourceList( nodes, SMESH.NODE, unRegister ) + edges = self._getIdSourceList( edges, SMESH.EDGE, unRegister ) + faces = self._getIdSourceList( faces, SMESH.FACE, unRegister ) + + if isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object): + Axis = self.smeshpyD.GetAxisStruct( Axis ) + if isinstance( Axis, list ): + Axis = SMESH.AxisStruct( *Axis ) + AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians) NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance) Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters self.mesh.SetParameters(Parameters) if TotalAngle and NbOfSteps: AngleInRadians /= NbOfSteps - if MakeGroups: - return self.editor.RotationSweepMakeGroups(IDsOfElements, Axis, - AngleInRadians, NbOfSteps, Tolerance) - self.editor.RotationSweep(IDsOfElements, Axis, AngleInRadians, NbOfSteps, Tolerance) - return [] + return self.editor.RotationSweepObjects( nodes, edges, faces, + Axis, AngleInRadians, + NbOfSteps, Tolerance, MakeGroups) - ## Generates new elements by rotation of the elements of object around the axis + ## Generate 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 (in radians) or a name of variable which defines angle in degrees + # @param NbOfSteps the number of steps + # @param Tolerance tolerance + # @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): + return self.RotationSweepObjects([], IDsOfElements, IDsOfElements, Axis, + AngleInRadians, NbOfSteps, Tolerance, + MakeGroups, TotalAngle) + + ## Generate new elements by rotation of the elements of object around the axis # @param theObject object which elements should be sweeped. # It can be a mesh, a sub mesh or a group. # @param Axis the axis of rotation, AxisStruct or line(geom object) @@ -3539,23 +3818,11 @@ class Mesh: # @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( Axis, geomBuilder.GEOM._objref_GEOM_Object)): - Axis = self.smeshpyD.GetAxisStruct(Axis) - AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians) - NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance) - Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if TotalAngle and NbOfSteps: - AngleInRadians /= NbOfSteps - if MakeGroups: - return self.editor.RotationSweepObjectMakeGroups(theObject, Axis, AngleInRadians, - NbOfSteps, Tolerance) - self.editor.RotationSweepObject(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance) - return [] + return self.RotationSweepObjects( [], theObject, theObject, Axis, + AngleInRadians, NbOfSteps, Tolerance, + MakeGroups, TotalAngle ) - ## Generates new elements by rotation of the elements of object around the axis + ## Generate new elements by rotation of the elements of object around the axis # @param theObject object which elements should be sweeped. # It can be a mesh, a sub mesh or a group. # @param Axis the axis of rotation, AxisStruct or line(geom object) @@ -3569,23 +3836,11 @@ class Mesh: # @ingroup l2_modif_extrurev def RotationSweepObject1D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance, MakeGroups=False, TotalAngle=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)): - Axis = self.smeshpyD.GetAxisStruct(Axis) - AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians) - NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance) - Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if TotalAngle and NbOfSteps: - AngleInRadians /= NbOfSteps - if MakeGroups: - return self.editor.RotationSweepObject1DMakeGroups(theObject, Axis, AngleInRadians, - NbOfSteps, Tolerance) - self.editor.RotationSweepObject1D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance) - return [] + return self.RotationSweepObjects([],theObject,[], Axis, + AngleInRadians, NbOfSteps, Tolerance, + MakeGroups, TotalAngle) - ## Generates new elements by rotation of the elements of object around the axis + ## Generate new elements by rotation of the elements of object around the axis # @param theObject object which elements should be sweeped. # It can be a mesh, a sub mesh or a group. # @param Axis the axis of rotation, AxisStruct or line(geom object) @@ -3599,82 +3854,78 @@ class Mesh: # @ingroup l2_modif_extrurev def RotationSweepObject2D(self, theObject, Axis, AngleInRadians, NbOfSteps, Tolerance, MakeGroups=False, TotalAngle=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( Axis, geomBuilder.GEOM._objref_GEOM_Object)): - Axis = self.smeshpyD.GetAxisStruct(Axis) - AngleInRadians,AngleParameters,hasVars = ParseAngles(AngleInRadians) - NbOfSteps,Tolerance,Parameters,hasVars = ParseParameters(NbOfSteps,Tolerance) - Parameters = Axis.parameters + var_separator + AngleParameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if TotalAngle and NbOfSteps: - AngleInRadians /= NbOfSteps - if MakeGroups: - return self.editor.RotationSweepObject2DMakeGroups(theObject, Axis, AngleInRadians, - NbOfSteps, Tolerance) - self.editor.RotationSweepObject2D(theObject, Axis, AngleInRadians, NbOfSteps, Tolerance) - return [] + return self.RotationSweepObjects([],[],theObject, Axis, AngleInRadians, + NbOfSteps, Tolerance, MakeGroups, TotalAngle) - ## Generates new elements by extrusion of the elements with given ids - # @param IDsOfElements the list of elements ids for extrusion + ## Generate new elements by extrusion of the given elements and nodes + # @param nodes nodes to extrude: a list including ids, groups, sub-meshes or a mesh + # @param edges edges to extrude: a list including ids, groups, sub-meshes or a mesh + # @param faces faces to extrude: a list including ids, groups, sub-meshes or a mesh # @param StepVector vector or DirStruct or 3 vector components, defining # the direction and value of extrusion for one step (the total extrusion # length will be NbOfSteps * ||StepVector||) # @param NbOfSteps the number of steps # @param MakeGroups forces the generation of new groups from existing ones - # @param IsNodes is True if elements with given ids are nodes + # @param scaleFactors optional scale factors to apply during extrusion + # @param linearVariation if @c True, scaleFactors are spread over all @a scaleFactors, + # else scaleFactors[i] is applied to nodes at the i-th extrusion step + # @param basePoint optional scaling center; if not provided, a gravity center of + # nodes and elements being extruded is used as the scaling center. + # It can be either + # - a list of tree components of the point or + # - a node ID or + # - a GEOM point # @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, IsNodes = False): - if IDsOfElements == []: - IDsOfElements = self.GetElementsId() + def ExtrusionSweepObjects(self, nodes, edges, faces, StepVector, NbOfSteps, MakeGroups=False, + scaleFactors=[], linearVariation=False, basePoint=[] ): + unRegister = genObjUnRegister() + nodes = self._getIdSourceList( nodes, SMESH.NODE, unRegister ) + edges = self._getIdSourceList( edges, SMESH.EDGE, unRegister ) + faces = self._getIdSourceList( faces, SMESH.FACE, unRegister ) + if isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object): StepVector = self.smeshpyD.GetDirStruct(StepVector) if isinstance( StepVector, list ): StepVector = self.smeshpyD.MakeDirStruct(*StepVector) + + if isinstance( basePoint, int): + xyz = self.GetNodeXYZ( basePoint ) + if not xyz: + raise RuntimeError("Invalid node ID: %s" % basePoint) + basePoint = xyz + if isinstance( basePoint, geomBuilder.GEOM._objref_GEOM_Object ): + basePoint = self.geompyD.PointCoordinates( basePoint ) + NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps) Parameters = StepVector.PS.parameters + var_separator + Parameters self.mesh.SetParameters(Parameters) - if MakeGroups: - if(IsNodes): - return self.editor.ExtrusionSweepMakeGroups0D(IDsOfElements, StepVector, NbOfSteps) - else: - return self.editor.ExtrusionSweepMakeGroups(IDsOfElements, StepVector, NbOfSteps) - if(IsNodes): - self.editor.ExtrusionSweep0D(IDsOfElements, StepVector, NbOfSteps) - else: - self.editor.ExtrusionSweep(IDsOfElements, StepVector, NbOfSteps) - return [] - ## Generates new elements by extrusion of the elements with given ids - # @param IDsOfElements is ids of elements + return self.editor.ExtrusionSweepObjects( nodes, edges, faces, + StepVector, NbOfSteps, + scaleFactors, linearVariation, basePoint, + MakeGroups) + + + ## Generate new elements by extrusion of the elements with given ids + # @param IDsOfElements the list of ids of elements or nodes for extrusion # @param StepVector vector or DirStruct or 3 vector components, defining # the direction and value of extrusion for one step (the total extrusion # length will be NbOfSteps * ||StepVector||) # @param NbOfSteps the number of steps - # @param ExtrFlags sets flags for extrusion - # @param SewTolerance uses for comparing locations of nodes if flag - # EXTRUSION_FLAG_SEW is set # @param MakeGroups forces the generation of new groups from existing ones - # @return list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise + # @param IsNodes is True if elements with given ids are nodes + # @return the list of created groups (SMESH_GroupBase) if MakeGroups=True, empty list otherwise # @ingroup l2_modif_extrurev - def AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps, - ExtrFlags, SewTolerance, MakeGroups=False): - if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)): - StepVector = self.smeshpyD.GetDirStruct(StepVector) - if isinstance( StepVector, list ): - StepVector = self.smeshpyD.MakeDirStruct(*StepVector) - if MakeGroups: - return self.editor.AdvancedExtrusionMakeGroups(IDsOfElements, StepVector, NbOfSteps, - ExtrFlags, SewTolerance) - self.editor.AdvancedExtrusion(IDsOfElements, StepVector, NbOfSteps, - ExtrFlags, SewTolerance) - return [] - - ## Generates new elements by extrusion along the normal to a discretized surface or wire - # @param Elements container of elements to extrude; - # it can be Mesh, Group, Sub-mesh, Filter or list of IDs; - # Only faces can be extruded so far. Sub-mesh sould be a sub-mesh on geom faces. + def ExtrusionSweep(self, IDsOfElements, StepVector, NbOfSteps, MakeGroups=False, IsNodes = False): + n,e,f = [],[],[] + if IsNodes: n = IDsOfElements + else : e,f, = IDsOfElements,IDsOfElements + return self.ExtrusionSweepObjects(n,e,f, StepVector, NbOfSteps, MakeGroups) + + ## Generate new elements by extrusion along the normal to a discretized surface or wire + # @param Elements elements to extrude - a list including ids, groups, sub-meshes or a mesh. + # Only faces can be extruded so far. A sub-mesh should be a sub-mesh on geom faces. # @param StepSize length of one extrusion step (the total extrusion # length will be \a NbOfSteps * \a StepSize ). # @param NbOfSteps number of extrusion steps. @@ -3696,54 +3947,40 @@ class Mesh: ByAverageNormal=False, UseInputElemsOnly=True, MakeGroups=False, Dim = 2): unRegister = genObjUnRegister() if isinstance( Elements, Mesh ): - Elements = Elements.GetMesh() + Elements = [ Elements.GetMesh() ] if isinstance( Elements, list ): if not Elements: - raise RuntimeError, "List of element IDs is empty!" - if not isinstance( Elements[0], int ): - raise RuntimeError, "List must contain element IDs and not %s"% Elements[0] - Elements = self.GetIDSource( Elements, SMESH.ALL ) - unRegister.set( Elements ) + raise RuntimeError("Elements empty!") + if isinstance( Elements[0], int ): + Elements = self.GetIDSource( Elements, SMESH.ALL ) + unRegister.set( Elements ) + if not isinstance( Elements, list ): + Elements = [ Elements ] StepSize,NbOfSteps,Parameters,hasVars = ParseParameters(StepSize,NbOfSteps) self.mesh.SetParameters(Parameters) return self.editor.ExtrusionByNormal(Elements, StepSize, NbOfSteps, - UseInputElemsOnly, ByAverageNormal, MakeGroups, Dim) + ByAverageNormal, UseInputElemsOnly, MakeGroups, Dim) - ## Generates new elements by extrusion of the elements which belong to the object - # @param theObject the object which elements should be processed. - # It can be a mesh, a sub mesh or a group. + ## Generate new elements by extrusion of the elements or nodes which belong to the object + # @param theObject the object whose elements or nodes should be processed. + # It can be a mesh, a sub-mesh or a group. # @param StepVector vector or DirStruct or 3 vector components, defining # the direction and value of extrusion for one step (the total extrusion # length will be NbOfSteps * ||StepVector||) # @param NbOfSteps the number of steps # @param MakeGroups forces the generation of new groups from existing ones - # @param IsNodes is True if elements which belong to the object are nodes + # @param IsNodes is True if elements to extrude are nodes # @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, IsNodes=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)): - StepVector = self.smeshpyD.GetDirStruct(StepVector) - if isinstance( StepVector, list ): - StepVector = self.smeshpyD.MakeDirStruct(*StepVector) - NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps) - Parameters = StepVector.PS.parameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if MakeGroups: - if(IsNodes): - return self.editor.ExtrusionSweepObject0DMakeGroups(theObject, StepVector, NbOfSteps) - else: - return self.editor.ExtrusionSweepObjectMakeGroups(theObject, StepVector, NbOfSteps) - if(IsNodes): - self.editor.ExtrusionSweepObject0D(theObject, StepVector, NbOfSteps) - else: - self.editor.ExtrusionSweepObject(theObject, StepVector, NbOfSteps) - return [] - - ## Generates new elements by extrusion of the elements which belong to the object - # @param theObject object which elements should be processed. - # It can be a mesh, a sub mesh or a group. + n,e,f = [],[],[] + if IsNodes: n = theObject + else : e,f, = theObject,theObject + return self.ExtrusionSweepObjects(n,e,f, StepVector, NbOfSteps, MakeGroups) + + ## Generate new elements by extrusion of edges which belong to the object + # @param theObject object whose 1D elements should be processed. + # It can be a mesh, a sub-mesh or a group. # @param StepVector vector or DirStruct or 3 vector components, defining # the direction and value of extrusion for one step (the total extrusion # length will be NbOfSteps * ||StepVector||) @@ -3752,23 +3989,11 @@ class Mesh: # @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() - if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)): - StepVector = self.smeshpyD.GetDirStruct(StepVector) - if isinstance( StepVector, list ): - StepVector = self.smeshpyD.MakeDirStruct(*StepVector) - NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps) - Parameters = StepVector.PS.parameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if MakeGroups: - return self.editor.ExtrusionSweepObject1DMakeGroups(theObject, StepVector, NbOfSteps) - self.editor.ExtrusionSweepObject1D(theObject, StepVector, NbOfSteps) - return [] + return self.ExtrusionSweepObjects([],theObject,[], StepVector, NbOfSteps, MakeGroups) - ## Generates new elements by extrusion of the elements which belong to the object - # @param theObject object which elements should be processed. - # It can be a mesh, a sub mesh or a group. + ## Generate new elements by extrusion of faces which belong to the object + # @param theObject object whose 2D elements should be processed. + # It can be a mesh, a sub-mesh or a group. # @param StepVector vector or DirStruct or 3 vector components, defining # the direction and value of extrusion for one step (the total extrusion # length will be NbOfSteps * ||StepVector||) @@ -3777,25 +4002,75 @@ class Mesh: # @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() - if ( isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object)): + return self.ExtrusionSweepObjects([],[],theObject, StepVector, NbOfSteps, MakeGroups) + + ## Generate new elements by extrusion of the elements with given ids + # @param IDsOfElements is ids of elements + # @param StepVector vector or DirStruct or 3 vector components, defining + # the direction and value of extrusion for one step (the total extrusion + # length will be NbOfSteps * ||StepVector||) + # @param NbOfSteps the number of steps + # @param ExtrFlags sets flags for extrusion + # @param SewTolerance uses for comparing locations of nodes if flag + # EXTRUSION_FLAG_SEW is set + # @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 AdvancedExtrusion(self, IDsOfElements, StepVector, NbOfSteps, + ExtrFlags, SewTolerance, MakeGroups=False): + if isinstance( StepVector, geomBuilder.GEOM._objref_GEOM_Object): StepVector = self.smeshpyD.GetDirStruct(StepVector) if isinstance( StepVector, list ): StepVector = self.smeshpyD.MakeDirStruct(*StepVector) - NbOfSteps,Parameters,hasVars = ParseParameters(NbOfSteps) - Parameters = StepVector.PS.parameters + var_separator + Parameters - self.mesh.SetParameters(Parameters) - if MakeGroups: - return self.editor.ExtrusionSweepObject2DMakeGroups(theObject, StepVector, NbOfSteps) - self.editor.ExtrusionSweepObject2D(theObject, StepVector, NbOfSteps) - return [] + return self.editor.AdvancedExtrusion(IDsOfElements, StepVector, NbOfSteps, + ExtrFlags, SewTolerance, MakeGroups) + ## Generate new elements by extrusion of the given elements and nodes along the path. + # The path of extrusion must be a meshed edge. + # @param Nodes nodes to extrude: a list including ids, groups, sub-meshes or a mesh + # @param Edges edges to extrude: a list including ids, groups, sub-meshes or a mesh + # @param Faces faces to extrude: a list including ids, groups, sub-meshes or a mesh + # @param PathMesh 1D mesh or 1D sub-mesh, along which proceeds the extrusion + # @param PathShape shape (edge) defines the sub-mesh of PathMesh if PathMesh + # contains not only path segments, else it can be None + # @param NodeStart the first or the last node on the path. 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 LinearVariation forces the computation of rotation angles as linear + # variation of the 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 + # @return list of created groups (SMESH_GroupBase) and SMESH::Extrusion_Error + # @ingroup l2_modif_extrurev + def ExtrusionAlongPathObjects(self, Nodes, Edges, Faces, PathMesh, PathShape=None, + NodeStart=1, HasAngles=False, Angles=[], LinearVariation=False, + HasRefPoint=False, RefPoint=[0,0,0], MakeGroups=False): + unRegister = genObjUnRegister() + Nodes = self._getIdSourceList( Nodes, SMESH.NODE, unRegister ) + Edges = self._getIdSourceList( Edges, SMESH.EDGE, unRegister ) + Faces = self._getIdSourceList( Faces, SMESH.FACE, unRegister ) + if isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object): + RefPoint = self.smeshpyD.GetPointStruct(RefPoint) + if isinstance( RefPoint, list ): + if not RefPoint: RefPoint = [0,0,0] + RefPoint = SMESH.PointStruct( *RefPoint ) + if isinstance( PathMesh, Mesh ): + PathMesh = PathMesh.GetMesh() + Angles,AnglesParameters,hasVars = ParseAngles(Angles) + Parameters = AnglesParameters + var_separator + RefPoint.parameters + self.mesh.SetParameters(Parameters) + return self.editor.ExtrusionAlongPathObjects(Nodes, Edges, Faces, + PathMesh, PathShape, NodeStart, + HasAngles, Angles, LinearVariation, + HasRefPoint, RefPoint, MakeGroups) - ## Generates new elements by extrusion of the given elements + ## Generate new elements by extrusion of the given elements # The path of extrusion must be a meshed edge. - # @param Base mesh or group, or submesh, or list of ids of elements for extrusion + # @param Base mesh or group, or sub-mesh, or list of ids of elements for extrusion # @param Path - 1D mesh or 1D sub-mesh, along which proceeds the extrusion # @param NodeStart the start node from Path. Defines the direction of extrusion # @param HasAngles allows the shape to be rotated around the path @@ -3814,38 +4089,20 @@ class Mesh: # only SMESH::Extrusion_Error otherwise # @ingroup l2_modif_extrurev def ExtrusionAlongPathX(self, Base, Path, NodeStart, - HasAngles, Angles, LinearVariation, - HasRefPoint, RefPoint, MakeGroups, ElemType): - if isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object): - RefPoint = self.smeshpyD.GetPointStruct(RefPoint) - pass - elif isinstance( RefPoint, list ): - RefPoint = PointStruct(*RefPoint) - pass - Angles,AnglesParameters,hasVars = ParseAngles(Angles) - Parameters = AnglesParameters + var_separator + RefPoint.parameters - self.mesh.SetParameters(Parameters) - - if (isinstance(Path, Mesh)): Path = Path.GetMesh() - - if isinstance(Base, list): - IDsOfElements = [] - if Base == []: IDsOfElements = self.GetElementsId() - else: IDsOfElements = Base - return self.editor.ExtrusionAlongPathX(IDsOfElements, Path, NodeStart, - HasAngles, Angles, LinearVariation, - HasRefPoint, RefPoint, MakeGroups, ElemType) - else: - if isinstance(Base, Mesh): Base = Base.GetMesh() - if isinstance(Base, SMESH._objref_SMESH_Mesh) or isinstance(Base, SMESH._objref_SMESH_Group) or isinstance(Base, SMESH._objref_SMESH_subMesh): - return self.editor.ExtrusionAlongPathObjX(Base, Path, NodeStart, - HasAngles, Angles, LinearVariation, - HasRefPoint, RefPoint, MakeGroups, ElemType) - else: - raise RuntimeError, "Invalid Base for ExtrusionAlongPathX" - - - ## Generates new elements by extrusion of the given elements + HasAngles=False, Angles=[], LinearVariation=False, + HasRefPoint=False, RefPoint=[0,0,0], MakeGroups=False, + ElemType=SMESH.FACE): + n,e,f = [],[],[] + if ElemType == SMESH.NODE: n = Base + if ElemType == SMESH.EDGE: e = Base + if ElemType == SMESH.FACE: f = Base + gr,er = self.ExtrusionAlongPathObjects(n,e,f, Path, None, NodeStart, + HasAngles, Angles, LinearVariation, + HasRefPoint, RefPoint, MakeGroups) + if MakeGroups: return gr,er + return er + + ## Generate 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 @@ -3864,32 +4121,20 @@ class Mesh: # only SMESH::Extrusion_Error otherwise # @ingroup l2_modif_extrurev def ExtrusionAlongPath(self, IDsOfElements, PathMesh, PathShape, NodeStart, - HasAngles, Angles, HasRefPoint, RefPoint, + HasAngles=False, Angles=[], HasRefPoint=False, RefPoint=[], MakeGroups=False, LinearVariation=False): - if IDsOfElements == []: - IDsOfElements = self.GetElementsId() - if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)): - RefPoint = self.smeshpyD.GetPointStruct(RefPoint) - pass - if ( isinstance( PathMesh, Mesh )): - PathMesh = PathMesh.GetMesh() - Angles,AnglesParameters,hasVars = ParseAngles(Angles) - Parameters = AnglesParameters + var_separator + RefPoint.parameters - self.mesh.SetParameters(Parameters) - if HasAngles and Angles and LinearVariation: - Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) - pass - if MakeGroups: - return self.editor.ExtrusionAlongPathMakeGroups(IDsOfElements, PathMesh, - PathShape, NodeStart, HasAngles, - Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPath(IDsOfElements, PathMesh, PathShape, - NodeStart, HasAngles, Angles, HasRefPoint, RefPoint) - - ## Generates new elements by extrusion of the elements which belong to the object + n,e,f = [],IDsOfElements,IDsOfElements + gr,er = self.ExtrusionAlongPathObjects(n,e,f, PathMesh, PathShape, + NodeStart, HasAngles, Angles, + LinearVariation, + HasRefPoint, RefPoint, MakeGroups) + if MakeGroups: return gr,er + return er + + ## Generate 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. - # It can be a mesh, a sub mesh or a group. + # @param theObject the object whose elements should be processed. + # It can be a mesh, a sub-mesh or a group. # @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 @@ -3906,32 +4151,19 @@ class Mesh: # only SMESH::Extrusion_Error otherwise # @ingroup l2_modif_extrurev def ExtrusionAlongPathObject(self, theObject, PathMesh, PathShape, NodeStart, - HasAngles, Angles, HasRefPoint, RefPoint, + HasAngles=False, Angles=[], HasRefPoint=False, RefPoint=[], MakeGroups=False, LinearVariation=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)): - RefPoint = self.smeshpyD.GetPointStruct(RefPoint) - if ( isinstance( PathMesh, Mesh )): - PathMesh = PathMesh.GetMesh() - Angles,AnglesParameters,hasVars = ParseAngles(Angles) - Parameters = AnglesParameters + var_separator + RefPoint.parameters - self.mesh.SetParameters(Parameters) - if HasAngles and Angles and LinearVariation: - Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) - pass - if MakeGroups: - return self.editor.ExtrusionAlongPathObjectMakeGroups(theObject, PathMesh, - PathShape, NodeStart, HasAngles, - Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPathObject(theObject, PathMesh, PathShape, - NodeStart, HasAngles, Angles, HasRefPoint, - RefPoint) - - ## Generates new elements by extrusion of the elements which belong to the object + n,e,f = [],theObject,theObject + gr,er = self.ExtrusionAlongPathObjects(n,e,f, PathMesh, PathShape, NodeStart, + HasAngles, Angles, LinearVariation, + HasRefPoint, RefPoint, MakeGroups) + if MakeGroups: return gr,er + return er + + ## Generate new elements by extrusion of mesh segments which belong to the object # The path of extrusion must be a meshed edge. - # @param theObject the object which elements should be processed. - # It can be a mesh, a sub mesh or a group. + # @param theObject the object whose 1D elements should be processed. + # It can be a mesh, a sub-mesh or a group. # @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 @@ -3948,32 +4180,19 @@ class Mesh: # only SMESH::Extrusion_Error otherwise # @ingroup l2_modif_extrurev def ExtrusionAlongPathObject1D(self, theObject, PathMesh, PathShape, NodeStart, - HasAngles, Angles, HasRefPoint, RefPoint, + HasAngles=False, Angles=[], HasRefPoint=False, RefPoint=[], MakeGroups=False, LinearVariation=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)): - RefPoint = self.smeshpyD.GetPointStruct(RefPoint) - if ( isinstance( PathMesh, Mesh )): - PathMesh = PathMesh.GetMesh() - Angles,AnglesParameters,hasVars = ParseAngles(Angles) - Parameters = AnglesParameters + var_separator + RefPoint.parameters - self.mesh.SetParameters(Parameters) - if HasAngles and Angles and LinearVariation: - Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) - pass - if MakeGroups: - return self.editor.ExtrusionAlongPathObject1DMakeGroups(theObject, PathMesh, - PathShape, NodeStart, HasAngles, - Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPathObject1D(theObject, PathMesh, PathShape, - NodeStart, HasAngles, Angles, HasRefPoint, - RefPoint) - - ## Generates new elements by extrusion of the elements which belong to the object + n,e,f = [],theObject,[] + gr,er = self.ExtrusionAlongPathObjects(n,e,f, PathMesh, PathShape, NodeStart, + HasAngles, Angles, LinearVariation, + HasRefPoint, RefPoint, MakeGroups) + if MakeGroups: return gr,er + return er + + ## Generate new elements by extrusion of faces which belong to the object # The path of extrusion must be a meshed edge. - # @param theObject the object which elements should be processed. - # It can be a mesh, a sub mesh or a group. + # @param theObject the object whose 2D elements should be processed. + # It can be a mesh, a sub-mesh or a group. # @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 @@ -3990,33 +4209,20 @@ class Mesh: # only SMESH::Extrusion_Error otherwise # @ingroup l2_modif_extrurev def ExtrusionAlongPathObject2D(self, theObject, PathMesh, PathShape, NodeStart, - HasAngles, Angles, HasRefPoint, RefPoint, + HasAngles=False, Angles=[], HasRefPoint=False, RefPoint=[], MakeGroups=False, LinearVariation=False): - if ( isinstance( theObject, Mesh )): - theObject = theObject.GetMesh() - if ( isinstance( RefPoint, geomBuilder.GEOM._objref_GEOM_Object)): - RefPoint = self.smeshpyD.GetPointStruct(RefPoint) - if ( isinstance( PathMesh, Mesh )): - PathMesh = PathMesh.GetMesh() - Angles,AnglesParameters,hasVars = ParseAngles(Angles) - Parameters = AnglesParameters + var_separator + RefPoint.parameters - self.mesh.SetParameters(Parameters) - if HasAngles and Angles and LinearVariation: - Angles = self.editor.LinearAnglesVariation( PathMesh, PathShape, Angles ) - pass - if MakeGroups: - return self.editor.ExtrusionAlongPathObject2DMakeGroups(theObject, PathMesh, - PathShape, NodeStart, HasAngles, - Angles, HasRefPoint, RefPoint) - return self.editor.ExtrusionAlongPathObject2D(theObject, PathMesh, PathShape, - NodeStart, HasAngles, Angles, HasRefPoint, - RefPoint) - - ## Creates a symmetrical copy of mesh elements + n,e,f = [],[],theObject + gr,er = self.ExtrusionAlongPathObjects(n,e,f, PathMesh, PathShape, NodeStart, + HasAngles, Angles, LinearVariation, + HasRefPoint, RefPoint, MakeGroups) + if MakeGroups: return gr,er + return er + + ## Create 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 a geom object this parameter is unnecessary + # @param theMirrorType smeshBuilder.POINT, smeshBuilder.AXIS or smeshBuilder.PLANE + # 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 @@ -4034,11 +4240,11 @@ class Mesh: self.editor.Mirror(IDsOfElements, Mirror, theMirrorType, Copy) return [] - ## Creates a new mesh by a symmetrical copy of mesh elements + ## Create 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 a geom object this parameter is unnecessary + # @param theMirrorType smeshBuilder.POINT, smeshBuilder.AXIS or smeshBuilder.PLANE + # If the Mirror is a geom object this parameter is unnecessary # @param MakeGroups to generate new groups from existing ones # @param NewMeshName a name of the new mesh to create # @return instance of Mesh class @@ -4055,11 +4261,11 @@ class Mesh: MakeGroups, NewMeshName) return Mesh(self.smeshpyD,self.geompyD,mesh) - ## Creates a symmetrical copy of the object + ## Create a symmetrical copy of the object # @param theObject mesh, submesh or group # @param Mirror AxisStruct or geom object (point, line, plane) - # @param theMirrorType is POINT, AXIS or PLANE - # If the Mirror is a geom object this parameter is unnecessary + # @param theMirrorType smeshBuilder.POINT, smeshBuilder.AXIS or smeshBuilder.PLANE + # 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 @@ -4077,11 +4283,11 @@ class Mesh: self.editor.MirrorObject(theObject, Mirror, theMirrorType, Copy) return [] - ## Creates a new mesh by a symmetrical copy of the object + ## Create a new mesh by a symmetrical copy of the object # @param theObject mesh, submesh or group # @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 theMirrorType smeshBuilder.POINT, smeshBuilder.AXIS or smeshBuilder.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 @@ -4098,7 +4304,7 @@ class Mesh: MakeGroups, NewMeshName) return Mesh( self.smeshpyD,self.geompyD,mesh ) - ## Translates the elements + ## Translate the elements # @param IDsOfElements list of elements ids # @param Vector the direction of translation (DirStruct or vector or 3 vector components) # @param Copy allows copying the translated elements @@ -4118,7 +4324,7 @@ class Mesh: self.editor.Translate(IDsOfElements, Vector, Copy) return [] - ## Creates a new mesh of translated elements + ## Create a new mesh of translated elements # @param IDsOfElements list of elements ids # @param Vector the direction of translation (DirStruct or vector or 3 vector components) # @param MakeGroups forces the generation of new groups from existing ones @@ -4136,7 +4342,7 @@ class Mesh: mesh = self.editor.TranslateMakeMesh(IDsOfElements, Vector, MakeGroups, NewMeshName) return Mesh ( self.smeshpyD, self.geompyD, mesh ) - ## Translates the object + ## Translate the object # @param theObject the object to translate (mesh, submesh, or group) # @param Vector direction of translation (DirStruct or geom vector or 3 vector components) # @param Copy allows copying the translated elements @@ -4156,7 +4362,7 @@ class Mesh: self.editor.TranslateObject(theObject, Vector, Copy) return [] - ## Creates a new mesh from the translated object + ## Create 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 or 3 vector components) # @param MakeGroups forces the generation of new groups from existing ones @@ -4176,7 +4382,7 @@ class Mesh: - ## Scales the object + ## Scale the object # @param theObject - the object to translate (mesh, submesh, or group) # @param thePoint - base point for scale (SMESH.PointStruct or list of 3 coordinates) # @param theScaleFact - list of 1-3 scale factors for axises @@ -4195,9 +4401,9 @@ class Mesh: if ( isinstance( thePoint, list )): thePoint = PointStruct( thePoint[0], thePoint[1], thePoint[2] ) if ( isinstance( theScaleFact, float )): - theScaleFact = [theScaleFact] + theScaleFact = [theScaleFact] if ( isinstance( theScaleFact, int )): - theScaleFact = [ float(theScaleFact)] + theScaleFact = [ float(theScaleFact)] self.mesh.SetParameters(thePoint.parameters) @@ -4206,7 +4412,7 @@ class Mesh: self.editor.Scale(theObject, thePoint, theScaleFact, Copy) return [] - ## Creates a new mesh from the translated object + ## Create a new mesh from the translated object # @param theObject - the object to translate (mesh, submesh, or group) # @param thePoint - base point for scale (SMESH.PointStruct or list of 3 coordinates) # @param theScaleFact - list of 1-3 scale factors for axises @@ -4223,9 +4429,9 @@ class Mesh: if ( isinstance( thePoint, list )): thePoint = PointStruct( thePoint[0], thePoint[1], thePoint[2] ) if ( isinstance( theScaleFact, float )): - theScaleFact = [theScaleFact] + theScaleFact = [theScaleFact] if ( isinstance( theScaleFact, int )): - theScaleFact = [ float(theScaleFact)] + theScaleFact = [ float(theScaleFact)] self.mesh.SetParameters(thePoint.parameters) mesh = self.editor.ScaleMakeMesh(theObject, thePoint, theScaleFact, @@ -4234,7 +4440,7 @@ class Mesh: - ## Rotates the elements + ## Rotate the elements # @param IDsOfElements list of elements ids # @param Axis the axis of rotation (AxisStruct or geom line) # @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees @@ -4255,7 +4461,7 @@ class Mesh: self.editor.Rotate(IDsOfElements, Axis, AngleInRadians, Copy) return [] - ## Creates a new mesh of rotated elements + ## Create a new mesh of rotated elements # @param IDsOfElements list of element ids # @param Axis the axis of rotation (AxisStruct or geom line) # @param AngleInRadians the angle of rotation (in radians) or a name of variable which defines angle in degrees @@ -4275,7 +4481,7 @@ class Mesh: MakeGroups, NewMeshName) return Mesh( self.smeshpyD, self.geompyD, mesh ) - ## Rotates the object + ## Rotate the 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) or a name of variable which defines angle in degrees @@ -4296,7 +4502,7 @@ class Mesh: self.editor.RotateObject(theObject, Axis, AngleInRadians, Copy) return [] - ## Creates a new mesh from the rotated object + ## Create 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) or a name of variable which defines angle in degrees @@ -4316,57 +4522,123 @@ class Mesh: self.mesh.SetParameters(Parameters) return Mesh( self.smeshpyD, self.geompyD, mesh ) - ## Finds groups of adjacent nodes within Tolerance. + ## Find groups of adjacent nodes within Tolerance. # @param Tolerance the value of tolerance - # @return the list of pairs of nodes IDs (e.g. [[1,12],[25,4]]) + # @param SeparateCornerAndMediumNodes if @c True, in quadratic mesh puts + # corner and medium nodes in separate groups thus preventing + # their further merge. + # @return the list of groups of nodes IDs (e.g. [[1,12,13],[4,25]]) # @ingroup l2_modif_trsf - def FindCoincidentNodes (self, Tolerance): - return self.editor.FindCoincidentNodes(Tolerance) + def FindCoincidentNodes (self, Tolerance, SeparateCornerAndMediumNodes=False): + return self.editor.FindCoincidentNodes( Tolerance, SeparateCornerAndMediumNodes ) - ## Finds groups of ajacent nodes within Tolerance. + ## Find groups of ajacent nodes within Tolerance. # @param Tolerance the value of tolerance - # @param SubMeshOrGroup SubMesh or Group + # @param SubMeshOrGroup SubMesh, Group or Filter # @param exceptNodes list of either SubMeshes, Groups or node IDs to exclude from search - # @return the list of pairs of nodes IDs (e.g. [[1,12],[25,4]]) + # @param SeparateCornerAndMediumNodes if @c True, in quadratic mesh puts + # corner and medium nodes in separate groups thus preventing + # their further merge. + # @return the list of groups of nodes IDs (e.g. [[1,12,13],[4,25]]) # @ingroup l2_modif_trsf - def FindCoincidentNodesOnPart (self, SubMeshOrGroup, Tolerance, exceptNodes=[]): + def FindCoincidentNodesOnPart (self, SubMeshOrGroup, Tolerance, + exceptNodes=[], SeparateCornerAndMediumNodes=False): unRegister = genObjUnRegister() if (isinstance( SubMeshOrGroup, Mesh )): SubMeshOrGroup = SubMeshOrGroup.GetMesh() - if not isinstance( exceptNodes, list): + if not isinstance( exceptNodes, list ): exceptNodes = [ exceptNodes ] - if exceptNodes and isinstance( exceptNodes[0], int): - exceptNodes = [ self.GetIDSource( exceptNodes, SMESH.NODE)] + if exceptNodes and isinstance( exceptNodes[0], int ): + exceptNodes = [ self.GetIDSource( exceptNodes, SMESH.NODE )] unRegister.set( exceptNodes ) - return self.editor.FindCoincidentNodesOnPartBut(SubMeshOrGroup, Tolerance,exceptNodes) - - ## Merges nodes - # @param GroupsOfNodes a list of pairs of nodes IDs for merging (e.g. [[1,12],[25,4]]) + return self.editor.FindCoincidentNodesOnPartBut(SubMeshOrGroup, Tolerance, + exceptNodes, SeparateCornerAndMediumNodes) + + ## Merge nodes + # @param GroupsOfNodes a list of groups of nodes IDs for merging + # (e.g. [[1,12,13],[25,4]], then nodes 12, 13 and 4 will be removed and replaced + # by nodes 1 and 25 correspondingly in all elements and groups + # @param NodesToKeep nodes to keep in the mesh: a list of groups, sub-meshes or node IDs. + # If @a NodesToKeep does not include a node to keep for some group to merge, + # then the first node in the group is kept. + # @param AvoidMakingHoles prevent merging nodes which cause removal of elements becoming + # invalid # @ingroup l2_modif_trsf - def MergeNodes (self, GroupsOfNodes): - self.editor.MergeNodes(GroupsOfNodes) + def MergeNodes (self, GroupsOfNodes, NodesToKeep=[], AvoidMakingHoles=False): + # NodesToKeep are converted to SMESH_IDSource in meshEditor.MergeNodes() + self.editor.MergeNodes( GroupsOfNodes, NodesToKeep, AvoidMakingHoles ) - ## Finds the elements built on the same nodes. + ## Find the elements built on the same nodes. # @param MeshOrSubMeshOrGroup Mesh or SubMesh, or Group of elements for searching - # @return the list of pairs of equal elements IDs (e.g. [[1,12],[25,4]]) + # @return the list of groups of equal elements IDs (e.g. [[1,12,13],[4,25]]) # @ingroup l2_modif_trsf - def FindEqualElements (self, MeshOrSubMeshOrGroup): - if ( isinstance( MeshOrSubMeshOrGroup, Mesh )): + def FindEqualElements (self, MeshOrSubMeshOrGroup=None): + if not MeshOrSubMeshOrGroup: + MeshOrSubMeshOrGroup=self.mesh + elif isinstance( MeshOrSubMeshOrGroup, Mesh ): MeshOrSubMeshOrGroup = MeshOrSubMeshOrGroup.GetMesh() - return self.editor.FindEqualElements(MeshOrSubMeshOrGroup) + return self.editor.FindEqualElements( MeshOrSubMeshOrGroup ) - ## Merges elements in each given group. - # @param GroupsOfElementsID a list of pairs of elements IDs for merging (e.g. [[1,12],[25,4]]) + ## Merge elements in each given group. + # @param GroupsOfElementsID a list of groups of elements IDs for merging + # (e.g. [[1,12,13],[25,4]], then elements 12, 13 and 4 will be removed and + # replaced by elements 1 and 25 in all groups) # @ingroup l2_modif_trsf def MergeElements(self, GroupsOfElementsID): self.editor.MergeElements(GroupsOfElementsID) - ## Leaves one element and removes all other elements built on the same nodes. + ## Leave one element and remove all other elements built on the same nodes. # @ingroup l2_modif_trsf def MergeEqualElements(self): self.editor.MergeEqualElements() - ## Sews free borders + ## Return groups of FreeBorder's coincident within the given tolerance. + # @param tolerance the tolerance. If the tolerance <= 0.0 then one tenth of an average + # size of elements adjacent to free borders being compared is used. + # @return SMESH.CoincidentFreeBorders structure + # @ingroup l2_modif_trsf + def FindCoincidentFreeBorders (self, tolerance=0.): + return self.editor.FindCoincidentFreeBorders( tolerance ) + + ## Sew FreeBorder's of each group + # @param freeBorders either a SMESH.CoincidentFreeBorders structure or a list of lists + # where each enclosed list contains node IDs of a group of coincident free + # borders such that each consequent triple of IDs within a group describes + # a free border in a usual way: n1, n2, nLast - i.e. 1st node, 2nd node and + # last node of a border. + # For example [[1, 2, 10, 20, 21, 40], [11, 12, 15, 55, 54, 41]] describes two + # groups of coincident free borders, each group including two borders. + # @param createPolygons if @c True faces adjacent to free borders are converted to + # polygons if a node of opposite border falls on a face edge, else such + # faces are split into several ones. + # @param createPolyhedra if @c True volumes adjacent to free borders are converted to + # polyhedra if a node of opposite border falls on a volume edge, else such + # volumes, if any, remain intact and the mesh becomes non-conformal. + # @return a number of successfully sewed groups + # @ingroup l2_modif_trsf + def SewCoincidentFreeBorders (self, freeBorders, createPolygons=False, createPolyhedra=False): + if freeBorders and isinstance( freeBorders, list ): + # construct SMESH.CoincidentFreeBorders + if isinstance( freeBorders[0], int ): + freeBorders = [freeBorders] + borders = [] + coincidentGroups = [] + for nodeList in freeBorders: + if not nodeList or len( nodeList ) % 3: + raise ValueError("Wrong number of nodes in this group: %s" % nodeList) + group = [] + while nodeList: + group.append ( SMESH.FreeBorderPart( len(borders), 0, 1, 2 )) + borders.append( SMESH.FreeBorder( nodeList[:3] )) + nodeList = nodeList[3:] + pass + coincidentGroups.append( group ) + pass + freeBorders = SMESH.CoincidentFreeBorders( borders, coincidentGroups ) + + return self.editor.SewCoincidentFreeBorders( freeBorders, createPolygons, createPolyhedra ) + + ## Sew free borders # @return SMESH::Sew_Error # @ingroup l2_modif_trsf def SewFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1, @@ -4376,7 +4648,7 @@ class Mesh: FirstNodeID2, SecondNodeID2, LastNodeID2, CreatePolygons, CreatePolyedrs) - ## Sews conform free borders + ## Sew conform free borders # @return SMESH::Sew_Error # @ingroup l2_modif_trsf def SewConformFreeBorders (self, FirstNodeID1, SecondNodeID1, LastNodeID1, @@ -4384,7 +4656,7 @@ class Mesh: return self.editor.SewConformFreeBorders(FirstNodeID1, SecondNodeID1, LastNodeID1, FirstNodeID2, SecondNodeID2) - ## Sews border to side + ## Sew border to side # @return SMESH::Sew_Error # @ingroup l2_modif_trsf def SewBorderToSide (self, FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder, @@ -4392,7 +4664,7 @@ class Mesh: return self.editor.SewBorderToSide(FirstNodeIDOnFreeBorder, SecondNodeIDOnFreeBorder, LastNodeIDOnFreeBorder, FirstNodeIDOnSide, LastNodeIDOnSide, CreatePolygons, CreatePolyedrs) - ## Sews two sides of a mesh. The nodes belonging to Side1 are + ## Sew 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. @@ -4407,46 +4679,47 @@ class Mesh: NodeID1OfSide1ToMerge, NodeID1OfSide2ToMerge, NodeID2OfSide1ToMerge, NodeID2OfSide2ToMerge) - ## Sets new nodes for the given element. + ## Set new nodes for the given element. # @param ide the element id # @param newIDs nodes ids - # @return If the number of nodes does not correspond to the type of element - returns false + # @return If the number of nodes does not correspond to the type of element - return false # @ingroup l2_modif_edit def ChangeElemNodes(self, ide, newIDs): return self.editor.ChangeElemNodes(ide, newIDs) ## 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 + # created, this method return the list of their IDs, \n + # if new nodes were not created - return empty list # @return the list of integer values (can be empty) - # @ingroup l1_auxiliary + # @ingroup l2_modif_add def GetLastCreatedNodes(self): return self.editor.GetLastCreatedNodes() ## 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 + # created this method return the list of their IDs, \n + # if new elements were not created - return empty list # @return the list of integer values (can be empty) - # @ingroup l1_auxiliary + # @ingroup l2_modif_add def GetLastCreatedElems(self): return self.editor.GetLastCreatedElems() - ## Clears sequences of nodes and elements created by mesh edition oparations - # @ingroup l1_auxiliary + ## Forget what nodes and elements were created by the last mesh edition operation + # @ingroup l2_modif_add def ClearLastCreated(self): self.editor.ClearLastCreated() - ## Creates Duplicates given elements, i.e. creates new elements based on the + ## Create duplicates of given elements, i.e. create new elements based on the # same nodes as the given ones. # @param theElements - container of elements to duplicate. It can be a Mesh, - # sub-mesh, group, filter or a list of element IDs. - # @param theGroupName - a name of group to contain the generated elements. + # sub-mesh, group, filter or a list of element IDs. If \a theElements is + # a Mesh, elements of highest dimension are duplicated + # @param theGroupName - a name of group to contain the generated elements. # If a group with such a name already exists, the new elements # are added to the existng group, else a new group is created. - # If \a theGroupName is empty, new elements are not added + # If \a theGroupName is empty, new elements are not added # in any group. # @return a group where the new elements are added. None if theGroupName == "". - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleElements(self, theElements, theGroupName=""): unRegister = genObjUnRegister() if isinstance( theElements, Mesh ): @@ -4456,62 +4729,62 @@ class Mesh: unRegister.set( theElements ) return self.editor.DoubleElements(theElements, theGroupName) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # @param theNodes identifiers of nodes to be doubled # @param theModifiedElems identifiers of elements to be updated by the new (doubled) # nodes. If list of element identifiers is empty then nodes are doubled but # they not assigned to elements # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodes(self, theNodes, theModifiedElems): return self.editor.DoubleNodes(theNodes, theModifiedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theNodeId identifiers of node to be doubled # @param theModifiedElems identifiers of elements to be updated # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNode(self, theNodeId, theModifiedElems): return self.editor.DoubleNode(theNodeId, theModifiedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theNodes group of nodes to be doubled # @param theModifiedElems group of elements to be updated. # @param theMakeGroup forces the generation of a group containing new nodes. # @return TRUE or a created group if operation has been completed successfully, # FALSE or None otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeGroup(self, theNodes, theModifiedElems, theMakeGroup=False): if theMakeGroup: return self.editor.DoubleNodeGroupNew(theNodes, theModifiedElems) return self.editor.DoubleNodeGroup(theNodes, theModifiedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theNodes list of groups of nodes to be doubled # @param theModifiedElems list of groups of elements to be updated. # @param theMakeGroup forces the generation of a group containing new nodes. # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeGroups(self, theNodes, theModifiedElems, theMakeGroup=False): if theMakeGroup: return self.editor.DoubleNodeGroupsNew(theNodes, theModifiedElems) return self.editor.DoubleNodeGroups(theNodes, theModifiedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # @param theElems - the list of elements (edges or faces) to be replicated # The nodes for duplication could be found from these elements # @param theNodesNot - list of nodes to NOT replicate # @param theAffectedElems - the list of elements (cells and edges) to which the # replicated nodes should be associated to. # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElem(self, theElems, theNodesNot, theAffectedElems): return self.editor.DoubleNodeElem(theElems, theNodesNot, theAffectedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # @param theElems - the list of elements (edges or faces) to be replicated # The nodes for duplication could be found from these elements # @param theNodesNot - list of nodes to NOT replicate @@ -4519,11 +4792,11 @@ class Mesh: # located on or inside shape). # The replicated nodes should be associated to affected elements. # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElemInRegion(self, theElems, theNodesNot, theShape): return self.editor.DoubleNodeElemInRegion(theElems, theNodesNot, theShape) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theElems - group of of elements (edges or faces) to be replicated # @param theNodesNot - group of nodes not to replicated @@ -4533,7 +4806,7 @@ class Mesh: # @param theMakeNodeGroup forces the generation of a group containing new nodes. # @return TRUE or created groups (one or two) if operation has been completed successfully, # FALSE or None otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElemGroup(self, theElems, theNodesNot, theAffectedElems, theMakeGroup=False, theMakeNodeGroup=False): if theMakeGroup or theMakeNodeGroup: @@ -4546,18 +4819,18 @@ class Mesh: return twoGroups[ int(theMakeNodeGroup) ] return self.editor.DoubleNodeElemGroup(theElems, theNodesNot, theAffectedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theElems - group of of elements (edges or faces) to be replicated # @param theNodesNot - group of nodes not to replicated # @param theShape - shape to detect affected elements (element which geometric center # located on or inside shape). # The replicated nodes should be associated to affected elements. - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElemGroupInRegion(self, theElems, theNodesNot, theShape): return self.editor.DoubleNodeElemGroupInRegion(theElems, theNodesNot, theShape) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theElems - list of groups of elements (edges or faces) to be replicated # @param theNodesNot - list of groups of nodes not to replicated @@ -4567,7 +4840,7 @@ class Mesh: # @param theMakeNodeGroup forces the generation of a group containing new nodes. # @return TRUE or created groups (one or two) if operation has been completed successfully, # FALSE or None otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElemGroups(self, theElems, theNodesNot, theAffectedElems, theMakeGroup=False, theMakeNodeGroup=False): if theMakeGroup or theMakeNodeGroup: @@ -4580,7 +4853,7 @@ class Mesh: return twoGroups[ int(theMakeNodeGroup) ] return self.editor.DoubleNodeElemGroups(theElems, theNodesNot, theAffectedElems) - ## Creates a hole in a mesh by doubling the nodes of some particular elements + ## Create a hole in a mesh by doubling the nodes of some particular elements # This method provided for convenience works as DoubleNodes() described above. # @param theElems - list of groups of elements (edges or faces) to be replicated # @param theNodesNot - list of groups of nodes not to replicated @@ -4588,7 +4861,7 @@ class Mesh: # located on or inside shape). # The replicated nodes should be associated to affected elements. # @return TRUE if operation has been completed successfully, FALSE otherwise - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def DoubleNodeElemGroupsInRegion(self, theElems, theNodesNot, theShape): return self.editor.DoubleNodeElemGroupsInRegion(theElems, theNodesNot, theShape) @@ -4600,33 +4873,35 @@ class Mesh: # located on or inside shape). # The replicated nodes should be associated to affected elements. # @return groups of affected elements - # @ingroup l2_modif_edit + # @ingroup l2_modif_duplicat def AffectedElemGroupsInRegion(self, theElems, theNodesNot, theShape): return self.editor.AffectedElemGroupsInRegion(theElems, theNodesNot, theShape) ## Double nodes on shared faces between groups of volumes and create flat elements on demand. - # The list of groups must describe a partition of the mesh volumes. - # The nodes of the internal faces at the boundaries of the groups are doubled. - # In option, the internal faces are replaced by flat elements. - # Triangles are transformed in prisms, and quadrangles in hexahedrons. - # @param theDomains - list of groups of volumes - # @param createJointElems - if TRUE, create the elements - # @param onAllBoundaries - if TRUE, the nodes and elements are also created on - # the boundary between \a theDomains and the rest mesh - # @return TRUE if operation has been completed successfully, FALSE otherwise + # The list of groups must describe a partition of the mesh volumes. + # The nodes of the internal faces at the boundaries of the groups are doubled. + # In option, the internal faces are replaced by flat elements. + # Triangles are transformed in prisms, and quadrangles in hexahedrons. + # @param theDomains - list of groups of volumes + # @param createJointElems - if TRUE, create the elements + # @param onAllBoundaries - if TRUE, the nodes and elements are also created on + # the boundary between \a theDomains and the rest mesh + # @return TRUE if operation has been completed successfully, FALSE otherwise + # @ingroup l2_modif_duplicat def DoubleNodesOnGroupBoundaries(self, theDomains, createJointElems, onAllBoundaries=False ): - return self.editor.DoubleNodesOnGroupBoundaries( theDomains, createJointElems, onAllBoundaries ) + return self.editor.DoubleNodesOnGroupBoundaries( theDomains, createJointElems, onAllBoundaries ) ## Double nodes on some external faces and create flat elements. - # Flat elements are mainly used by some types of mechanic calculations. + # Flat elements are mainly used by some types of mechanic calculations. # - # Each group of the list must be constituted of faces. - # Triangles are transformed in prisms, and quadrangles in hexahedrons. - # @param theGroupsOfFaces - list of groups of faces - # @return TRUE if operation has been completed successfully, FALSE otherwise + # Each group of the list must be constituted of faces. + # Triangles are transformed in prisms, and quadrangles in hexahedrons. + # @param theGroupsOfFaces - list of groups of faces + # @return TRUE if operation has been completed successfully, FALSE otherwise + # @ingroup l2_modif_duplicat def CreateFlatElementsOnFacesGroups(self, theGroupsOfFaces ): return self.editor.CreateFlatElementsOnFacesGroups( theGroupsOfFaces ) - + ## identify all the elements around a geom shape, get the faces delimiting the hole # def CreateHoleSkin(self, radius, theShape, groupName, theNodesCoords): @@ -4640,9 +4915,16 @@ class Mesh: self.functors[ funcType._v ] = fn return fn - def _valueFromFunctor(self, funcType, elemId): + ## Return value of a functor for a given element + # @param funcType an item of SMESH.FunctorType enum + # Type "SMESH.FunctorType._items" in the Python Console to see all items. + # @param elemId element or node ID + # @param isElem @a elemId is ID of element or node + # @return the functor value or zero in case of invalid arguments + # @ingroup l1_measurements + def FunctorValue(self, funcType, elemId, isElem=True): fn = self._getFunctor( funcType ) - if fn.GetElementType() == self.GetElementType(elemId, True): + if fn.GetElementType() == self.GetElementType(elemId, isElem): val = fn.GetValue(elemId) else: val = 0 @@ -4657,7 +4939,7 @@ class Mesh: if elemId == None: length = self.smeshpyD.GetLength(self) else: - length = self._valueFromFunctor(SMESH.FT_Length, elemId) + length = self.FunctorValue(SMESH.FT_Length, elemId) return length ## Get area of 2D element or sum of areas of all 2D mesh elements @@ -4669,7 +4951,7 @@ class Mesh: if elemId == None: area = self.smeshpyD.GetArea(self) else: - area = self._valueFromFunctor(SMESH.FT_Area, elemId) + area = self.FunctorValue(SMESH.FT_Area, elemId) return area ## Get volume of 3D element or sum of volumes of all 3D mesh elements @@ -4681,7 +4963,7 @@ class Mesh: if elemId == None: volume = self.smeshpyD.GetVolume(self) else: - volume = self._valueFromFunctor(SMESH.FT_Volume3D, elemId) + volume = self.FunctorValue(SMESH.FT_Volume3D, elemId) return volume ## Get maximum element length. @@ -4693,7 +4975,7 @@ class Mesh: ftype = SMESH.FT_MaxElementLength3D else: ftype = SMESH.FT_MaxElementLength2D - return self._valueFromFunctor(ftype, elemId) + return self.FunctorValue(ftype, elemId) ## Get aspect ratio of 2D or 3D element. # @param elemId mesh element ID @@ -4704,35 +4986,35 @@ class Mesh: ftype = SMESH.FT_AspectRatio3D else: ftype = SMESH.FT_AspectRatio - return self._valueFromFunctor(ftype, elemId) + return self.FunctorValue(ftype, elemId) ## Get warping angle of 2D element. # @param elemId mesh element ID # @return element's warping angle value # @ingroup l1_measurements def GetWarping(self, elemId): - return self._valueFromFunctor(SMESH.FT_Warping, elemId) + return self.FunctorValue(SMESH.FT_Warping, elemId) ## Get minimum angle of 2D element. # @param elemId mesh element ID # @return element's minimum angle value # @ingroup l1_measurements def GetMinimumAngle(self, elemId): - return self._valueFromFunctor(SMESH.FT_MinimumAngle, elemId) + return self.FunctorValue(SMESH.FT_MinimumAngle, elemId) ## Get taper of 2D element. # @param elemId mesh element ID # @return element's taper value # @ingroup l1_measurements def GetTaper(self, elemId): - return self._valueFromFunctor(SMESH.FT_Taper, elemId) + return self.FunctorValue(SMESH.FT_Taper, elemId) ## Get skew of 2D element. # @param elemId mesh element ID # @return element's skew value # @ingroup l1_measurements def GetSkew(self, elemId): - return self._valueFromFunctor(SMESH.FT_Skew, elemId) + return self.FunctorValue(SMESH.FT_Skew, elemId) ## Return minimal and maximal value of a given functor. # @param funType a functor type, an item of SMESH.FunctorType enum @@ -4750,6 +5032,8 @@ class Mesh: fun = self._getFunctor( funType ) if fun: if meshPart: + if hasattr( meshPart, "SetMesh" ): + meshPart.SetMesh( self.mesh ) # set mesh to filter hist = fun.GetLocalHistogram( 1, False, meshPart ) else: hist = fun.GetHistogram( 1, False ) @@ -4759,10 +5043,112 @@ class Mesh: pass # end of Mesh class -## Helper class for wrapping of SMESH.SMESH_Pattern CORBA class + +## Private class used to compensate change of CORBA API of SMESH_Mesh for backward compatibility +# with old dump scripts which call SMESH_Mesh directly and not via smeshBuilder.Mesh +# +class meshProxy(SMESH._objref_SMESH_Mesh): + def __init__(self): + SMESH._objref_SMESH_Mesh.__init__(self) + def __deepcopy__(self, memo=None): + new = self.__class__() + return new + def CreateDimGroup(self,*args): # 2 args added: nbCommonNodes, underlyingOnly + if len( args ) == 3: + args += SMESH.ALL_NODES, True + return SMESH._objref_SMESH_Mesh.CreateDimGroup( self, *args ) + pass +omniORB.registerObjref(SMESH._objref_SMESH_Mesh._NP_RepositoryId, meshProxy) + + +## Private class wrapping SMESH.SMESH_SubMesh in order to add Compute() +# +class submeshProxy(SMESH._objref_SMESH_subMesh): + def __init__(self): + SMESH._objref_SMESH_subMesh.__init__(self) + self.mesh = None + def __deepcopy__(self, memo=None): + new = self.__class__() + return new + + ## Compute the sub-mesh and return the status of the computation + # @param refresh if @c True, Object browser is automatically updated (when running in GUI) + # @return True or False + # + # This is a method of SMESH.SMESH_submesh that can be obtained via Mesh.GetSubMesh() or + # @ref smesh_algorithm.Mesh_Algorithm.GetSubMesh() "Mesh_Algorithm.GetSubMesh()". + # @ingroup l2_submeshes + def Compute(self,refresh=False): + if not self.mesh: + self.mesh = Mesh( smeshBuilder(), None, self.GetMesh()) + + ok = self.mesh.Compute( self.GetSubShape(),refresh=[] ) + + if salome.sg.hasDesktop() and self.mesh.GetStudyId() >= 0: + smeshgui = salome.ImportComponentGUI("SMESH") + smeshgui.Init(self.mesh.GetStudyId()) + smeshgui.SetMeshIcon( salome.ObjectToID( self ), ok, (self.GetNumberOfElements()==0) ) + if refresh: salome.sg.updateObjBrowser(True) + pass + + return ok + pass +omniORB.registerObjref(SMESH._objref_SMESH_subMesh._NP_RepositoryId, submeshProxy) + + +## Private class used to compensate change of CORBA API of SMESH_MeshEditor for backward +# compatibility with old dump scripts which call SMESH_MeshEditor directly and not via +# smeshBuilder.Mesh +# +class meshEditor(SMESH._objref_SMESH_MeshEditor): + def __init__(self): + SMESH._objref_SMESH_MeshEditor.__init__(self) + self.mesh = None + def __getattr__(self, name ): # method called if an attribute not found + if not self.mesh: # look for name() method in Mesh class + self.mesh = Mesh( None, None, SMESH._objref_SMESH_MeshEditor.GetMesh(self)) + if hasattr( self.mesh, name ): + return getattr( self.mesh, name ) + if name == "ExtrusionAlongPathObjX": + return getattr( self.mesh, "ExtrusionAlongPathX" ) # other method name + print("meshEditor: attribute '%s' NOT FOUND" % name) + return None + def __deepcopy__(self, memo=None): + new = self.__class__() + return new + def FindCoincidentNodes(self,*args): # a 2nd arg added (SeparateCornerAndMediumNodes) + if len( args ) == 1: args += False, + return SMESH._objref_SMESH_MeshEditor.FindCoincidentNodes( self, *args ) + def FindCoincidentNodesOnPart(self,*args): # a 3d arg added (SeparateCornerAndMediumNodes) + if len( args ) == 2: args += False, + return SMESH._objref_SMESH_MeshEditor.FindCoincidentNodesOnPart( self, *args ) + def MergeNodes(self,*args): # 2 args added (NodesToKeep,AvoidMakingHoles) + if len( args ) == 1: + return SMESH._objref_SMESH_MeshEditor.MergeNodes( self, args[0], [], False ) + NodesToKeep = args[1] + AvoidMakingHoles = args[2] if len( args ) == 3 else False + unRegister = genObjUnRegister() + if NodesToKeep: + if isinstance( NodesToKeep, list ) and isinstance( NodesToKeep[0], int ): + NodesToKeep = self.MakeIDSource( NodesToKeep, SMESH.NODE ) + if not isinstance( NodesToKeep, list ): + NodesToKeep = [ NodesToKeep ] + return SMESH._objref_SMESH_MeshEditor.MergeNodes( self, args[0], NodesToKeep, AvoidMakingHoles ) + pass +omniORB.registerObjref(SMESH._objref_SMESH_MeshEditor._NP_RepositoryId, meshEditor) + +## Private class wrapping SMESH.SMESH_Pattern CORBA class in order to treat Notebook +# variables in some methods # class Pattern(SMESH._objref_SMESH_Pattern): + def LoadFromFile(self, patternTextOrFile ): + text = patternTextOrFile + if os.path.exists( text ): + text = open( patternTextOrFile ).read() + pass + return SMESH._objref_SMESH_Pattern.LoadFromFile( self, text ) + def ApplyToMeshFaces(self, theMesh, theFacesIDs, theNodeIndexOnKeyPoint1, theReverse): decrFun = lambda i: i-1 theNodeIndexOnKeyPoint1,Parameters,hasVars = ParseParameters(theNodeIndexOnKeyPoint1, decrFun) @@ -4775,6 +5161,11 @@ class Pattern(SMESH._objref_SMESH_Pattern): theMesh.SetParameters(Parameters) return SMESH._objref_SMESH_Pattern.ApplyToHexahedrons( self, theMesh, theVolumesIDs, theNode000Index, theNode001Index ) + def MakeMesh(self, mesh, CreatePolygons=False, CreatePolyhedra=False): + if isinstance( mesh, Mesh ): + mesh = mesh.GetMesh() + return SMESH._objref_SMESH_Pattern.MakeMesh( self, mesh, CreatePolygons, CreatePolyhedra ) + # Registering the new proxy for Pattern omniORB.registerObjref(SMESH._objref_SMESH_Pattern._NP_RepositoryId, Pattern) @@ -4786,7 +5177,7 @@ class algoCreator: self.defaultAlgoType = "" self.algoTypeToClass = {} - # Stores a python class of algorithm + # Store a python class of algorithm def add(self, algoClass): if type( algoClass ).__name__ == 'classobj' and \ hasattr( algoClass, "algoType"): @@ -4796,7 +5187,7 @@ class algoCreator: self.defaultAlgoType = algoClass.algoType #print "Add",algoClass.algoType, "dflt",self.defaultAlgoType - # creates a copy of self and assign mesh to the copy + # Create a copy of self and assign mesh to the copy def copy(self, mesh): other = algoCreator() other.defaultAlgoType = self.defaultAlgoType @@ -4804,7 +5195,7 @@ class algoCreator: other.mesh = mesh return other - # creates an instance of algorithm + # Create an instance of algorithm def __call__(self,algo="",geom=0,*args): algoType = self.defaultAlgoType for arg in args + (algo,geom): @@ -4813,14 +5204,14 @@ class algoCreator: if isinstance( arg, str ) and arg: algoType = arg if not algoType and self.algoTypeToClass: - algoType = self.algoTypeToClass.keys()[0] - if self.algoTypeToClass.has_key( algoType ): + algoType = list(self.algoTypeToClass.keys())[0] + if algoType in self.algoTypeToClass: #print "Create algo",algoType return self.algoTypeToClass[ algoType ]( self.mesh, geom ) - raise RuntimeError, "No class found for algo type %s" % algoType + raise RuntimeError("No class found for algo type %s" % algoType) return None -# Private class used to substitute and store variable parameters of hypotheses. +## Private class used to substitute and store variable parameters of hypotheses. # class hypMethodWrapper: def __init__(self, hyp, method): @@ -4842,16 +5233,17 @@ class hypMethodWrapper: except omniORB.CORBA.BAD_PARAM: # raised by hypothesis method call # maybe there is a replaced string arg which is not variable result = self.method( self.hyp, *args ) - except ValueError, detail: # raised by ParseParameters() + except ValueError as detail: # raised by ParseParameters() try: result = self.method( self.hyp, *args ) except omniORB.CORBA.BAD_PARAM: - raise ValueError, detail # wrong variable name + raise ValueError(detail) # wrong variable name return result pass -# A helper class that call UnRegister() of SALOME.GenericObj'es stored in it +## A helper class that calls UnRegister() of SALOME.GenericObj'es stored in it +# class genObjUnRegister: def __init__(self, genObj=None): @@ -4872,15 +5264,18 @@ class genObjUnRegister: if genObj and hasattr( genObj, "UnRegister" ): genObj.UnRegister() + +## Bind methods creating mesher plug-ins to the Mesh class +# for pluginName in os.environ[ "SMESH_MeshersList" ].split( ":" ): # #print "pluginName: ", pluginName pluginBuilderName = pluginName + "Builder" try: exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName)) - except Exception, e: - from salome_utils import verbose - if verbose(): print "Exception while loading %s: %s" % ( pluginBuilderName, e ) + except Exception as e: + from salome_utils import verbose + if verbose(): print("Exception while loading %s: %s" % ( pluginBuilderName, e )) continue exec( "from salome.%s import %s" % (pluginName, pluginBuilderName)) plugin = eval( pluginBuilderName )