src/HYBRIDPlugin/HYBRIDPluginBuilder.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (C) 2007-2019  CEA/DEN, EDF R&D
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 #
  20
  21 ##
  22 # @package HYBRIDPluginBuilder
  23 # Python API for the HYBRID meshing plug-in module.
  24
  25 from salome.smesh.smesh_algorithm import Mesh_Algorithm
  26 from salome.smesh.smeshBuilder import AssureGeomPublished
  27
  28 # import HYBRIDPlugin module if possible
  29 noHYBRIDPlugin = 0
  30 try:
  31     import HYBRIDPlugin
  32 except ImportError:
  33     noHYBRIDPlugin = 1
  34     pass
  35
  36 # Optimization level of HYBRID
  37 # V3.1
  38 None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization = 0,1,2,3
  39 # V4.1 (partialy redefines V3.1). Issue 0020574
  40 None_Optimization, Light_Optimization, Standard_Optimization, StandardPlus_Optimization, Strong_Optimization = 0,1,2,3,4
  41
  42 # Collision Mode
  43 Decrease_Collision_Mode, Stop_Collision_Mode = 0,1
  44
  45 # Boundary Layers growing inward or outward.
  46 Layer_Growth_Inward, Layer_Growth_Outward = 0,1
  47
  48 # Mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers).
  49 Generation_Tetra_Dominant, Generation_Hexa_Dominant, Generation_Cartesian_Core = 0,1,2
  50
  51 #----------------------------
  52 # Mesh algo type identifiers
  53 #----------------------------
  54
  55 ## Algorithm type: HYBRID tetra-hexahedron 3D algorithm, see HYBRID_Algorithm
  56 MG_Hybrid = "HYBRID_3D"
  57 HYBRID = MG_Hybrid
  58
  59 ## MG-Hybrid 3D algorithm
  60 #
  61 #  It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.HYBRID, geom=0 )
  62 class HYBRID_Algorithm(Mesh_Algorithm):
  63
  64     ## name of the dynamic method in smeshBuilder.Mesh class
  65     #  @internal
  66     meshMethod = "Tetrahedron"
  67     ## type of algorithm used with helper function in smeshBuilder.Mesh class
  68     #  @internal
  69     algoType   = MG_Hybrid
  70     ## doc string of the method in smeshBuilder.Mesh class
  71     #  @internal
  72     docHelper  = "Creates tetrahedron 3D algorithm for volumes"
  73
  74     ## Private constructor.
  75     #  @param mesh parent mesh object algorithm is assigned to
  76     #  @param geom geometry (shape/sub-shape) algorithm is assigned to;
  77     #              if it is @c 0 (default), the algorithm is assigned to the main shape
  78     def __init__(self, mesh, geom=0):
  79         Mesh_Algorithm.__init__(self)
  80         if noHYBRIDPlugin: print("Warning: HYBRIDPlugin module unavailable")
  81         self.Create(mesh, geom, self.algoType, "libHYBRIDEngine.so")
  82         self.params = None
  83         pass
  84
  85     ## Defines hypothesis having several parameters
  86     #  @return hypothesis object
  87     def Parameters(self):
  88         if not self.params:
  89             self.params = self.Hypothesis("HYBRID_Parameters", [],
  90                                           "libHYBRIDEngine.so", UseExisting=0)
  91             pass
  92         return self.params
  93
  94     ## To mesh layers on all wrap. Default is to mesh.
  95     #  @param toMesh "mesh layers on all wrap" flag value
  96     def SetLayersOnAllWrap(self, toMesh):
  97         self.Parameters().SetLayersOnAllWrap(toMesh)
  98         pass
  99
 100     ## To mesh layers on given faces.
 101     #  @param faceIDs faces or face IDs to construct boundary layers on
 102     def SetFacesWithLayers(self, faceIDs):
 103         import GEOM
 104         ids = []
 105         if not isinstance( faceIDs, list ) and not isinstance( faceIDs, tuple ):
 106             faceIDs = [ faceIDs ]
 107         for fid in faceIDs:
 108             if isinstance( fid, int ):
 109                 ids.append( fid )
 110             elif isinstance( fid, GEOM._objref_GEOM_Object):
 111                 faces = self.mesh.geompyD.SubShapeAll( fid, self.mesh.geompyD.ShapeType["FACE"])
 112                 for f in faces:
 113                     ids.append( self.mesh.geompyD.GetSubShapeID( self.mesh.geom, f ))
 114             else:
 115                 raise TypeError("Face should be either ID or GEOM_Object, not %s" % type(fid))
 116             pass
 117         self.Parameters().SetFacesWithLayers(ids)
 118         if ids:
 119             self.SetLayersOnAllWrap( False )
 120         pass
 121
 122     ## To imprint the layers on given faces.
 123     #  @param faceIDs faces or face IDs to imprint the boundary layers on
 124     def SetFacesWithImprinting(self, faceIDs):
 125         import GEOM
 126         ids = []
 127         if not isinstance( faceIDs, list ) and not isinstance( faceIDs, tuple ):
 128             faceIDs = [ faceIDs ]
 129         for fid in faceIDs:
 130             if isinstance( fid, int ):
 131                 ids.append( fid )
 132             elif isinstance( fid, GEOM._objref_GEOM_Object):
 133                 faces = self.mesh.geompyD.SubShapeAll( fid, self.mesh.geompyD.ShapeType["FACE"])
 134                 for f in faces:
 135                     ids.append( self.mesh.geompyD.GetSubShapeID( self.mesh.geom, f ))
 136             else:
 137                 raise TypeError("Face should be either ID or GEOM_Object, not %s" % type(fid))
 138             pass
 139         self.Parameters().SetFacesWithImprinting(ids)
 140         if ids:
 141             self.SetLayersOnAllWrap( False )
 142         pass
 143
 144     ## To snap the layers on given surface (use existing surface layers as base for volume layers).
 145     #  @param faceIDs faces or face IDs that already have surface layers
 146     def SetFacesWithSnapping(self, faceIDs):
 147         import GEOM
 148         ids = []
 149         if not isinstance( faceIDs, list ) and not isinstance( faceIDs, tuple ):
 150             faceIDs = [ faceIDs ]
 151         for fid in faceIDs:
 152             if isinstance( fid, int ):
 153                 ids.append( fid )
 154             elif isinstance( fid, GEOM._objref_GEOM_Object):
 155                 faces = self.mesh.geompyD.SubShapeAll( fid, self.mesh.geompyD.ShapeType["FACE"])
 156                 for f in faces:
 157                     ids.append( self.mesh.geompyD.GetSubShapeID( self.mesh.geom, f ))
 158             else:
 159                 raise TypeError("Face should be either ID or GEOM_Object, not %s" % type(fid))
 160             pass
 161         self.Parameters().SetFacesWithSnapping(ids)
 162         if ids:
 163             self.SetLayersOnAllWrap( False )
 164         pass
 165
 166     ## Set Collision Mode:
 167     #  @param mode Collision Mode, one of the following values
 168     #  - Decrease_Collision_Mode
 169     #  - Stop_Collision_Mode
 170     #  .
 171     #  Default is Decrease_Collision_Mode
 172     def SetCollisionMode(self, mode):
 173         self.Parameters().SetCollisionMode(mode)
 174         pass
 175
 176     ## To mesh Boundary Layers growing inward or outward.
 177     #  @param mode, one of the following values
 178     #  - Layer_Growth_Inward
 179     #  - Layer_Growth_Outward
 180     #  .
 181     #  Default is Layer_Growth_Inward
 182     def SetBoundaryLayersGrowth(self, mode):
 183         self.Parameters().SetBoundaryLayersGrowth(mode)
 184         pass
 185
 186     ## To mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers).
 187     #  @param mode, one of the following values
 188     #  - Generation_Tetra_Dominant
 189     #  - Generation_Hexa_Dominant
 190     #  - Generation_Cartesian_Core
 191     #  .
 192     # Default is Generation_Tetra_Dominant
 193     def SetElementGeneration(self, mode):
 194         self.Parameters().SetElementGeneration(mode)
 195         pass
 196
 197     ## To mesh adding extra normals at opening ridges and corners.
 198     # Default is no.
 199     # @param addMultinormals boolean value
 200     def SetAddMultinormals(self, addMultinormals):
 201         self.Parameters().SetAddMultinormals(addMultinormals)
 202         pass
 203
 204     ## To mesh smoothing normals at closed ridges and corners.
 205     # Default is no.
 206     # @param smoothNormals boolean value
 207     def SetSmoothNormals(self, smoothNormals):
 208         self.Parameters().SetSmoothNormals(smoothNormals)
 209         pass
 210
 211     ## To set height of the first layer.
 212     # Default is 0.0
 213     # @param heightFirstLayer double value
 214     def SetHeightFirstLayer(self, heightFirstLayer):
 215         self.Parameters().SetHeightFirstLayer(heightFirstLayer)
 216         pass
 217
 218     ## Sizes of boundary layers are relative to the surface size. Default no
 219     #  @param isRelative boolean flag
 220     def SetHeightIsRelative(self, isRelative):
 221         self.Parameters().SetHeightIsRelative( isRelative )
 222         pass
 223
 224     ## To set boundary layers coefficient of geometric progression.
 225     # Default is 1.0
 226     # @param boundaryLayersProgression double value
 227     def SetBoundaryLayersProgression(self, boundaryLayersProgression):
 228         self.Parameters().SetBoundaryLayersProgression(boundaryLayersProgression)
 229         pass
 230
 231     ## Set core elements size.
 232     # Default is 0.0
 233     # @param CoreSize double value
 234     def SetCoreSize(self, CoreSize):
 235         self.Parameters().SetCoreSize(CoreSize)
 236         pass
 237
 238     ## To set multinormals angle threshold at opening ridges.
 239     # Default is 30.0
 240     # @param multinormalsAngle double value
 241     def SetMultinormalsAngle(self, multinormalsAngle):
 242         self.Parameters().SetMultinormalsAngle(multinormalsAngle)
 243         pass
 244
 245     ## To set number of boundary layers.
 246     # Default is 1
 247     # @param nbOfBoundaryLayers int value
 248     def SetNbOfBoundaryLayers(self, nbOfBoundaryLayers):
 249         self.Parameters().SetNbOfBoundaryLayers(nbOfBoundaryLayers)
 250         pass
 251
 252     ## Set maximum internal angles of boundary elements (in degree)
 253     #  @param angle angle in degree
 254     def SetBoundaryLayersMaxElemAngle(self, angle):
 255         self.Parameters().SetBoundaryLayersMaxElemAngle( angle )
 256         pass
 257
 258     ## Set path to working directory.
 259     #  @param path working directory
 260     def SetWorkingDirectory(self, path):
 261         self.Parameters().SetWorkingDirectory(path)
 262         pass
 263
 264     ## To keep working files or remove them.
 265     #  @param toKeep "keep working files" flag value
 266     def SetKeepFiles(self, toKeep):
 267         self.Parameters().SetKeepFiles(toKeep)
 268         pass
 269
 270     ## Remove or not the log file (if any) in case of successful computation.
 271     #  The log file remains in case of errors anyway. If
 272     #  the "keep working files" flag is set to true, this option
 273     #  has no effect.
 274     #  @param toRemove "remove log on success" flag value
 275     def SetRemoveLogOnSuccess(self, toRemove):
 276         self.Parameters().SetRemoveLogOnSuccess(toRemove)
 277         pass
 278
 279     ## Print the the log in a file. If set to false, the
 280     # log is printed on the standard output
 281     #  @param toPrintLogInFile "print log in a file" flag value
 282     def SetPrintLogInFile(self, toPrintLogInFile):
 283         self.Parameters().SetStandardOutputLog(not toPrintLogInFile)
 284         pass
 285
 286     ## Set verbosity level [0-10].
 287     #  @param level verbosity level
 288     #  - 0 - no standard output,
 289     #  - 2 - prints the data, quality statistics of the skin and final meshes and
 290     #    indicates when the final mesh is being saved. In addition the software
 291     #    gives indication regarding the CPU time.
 292     #  - 10 - same as 2 plus the main steps in the computation, quality statistics
 293     #    histogram of the skin mesh, quality statistics histogram together with
 294     #    the characteristics of the final mesh.
 295     def SetVerboseLevel(self, level):
 296         self.Parameters().SetVerboseLevel(level)
 297         pass
 298
 299     ## To create new nodes.
 300     #  @param toCreate "create new nodes" flag value
 301     def SetToCreateNewNodes(self, toCreate):
 302         self.Parameters().SetToCreateNewNodes(toCreate)
 303         pass
 304
 305     ## To use boundary recovery version which tries to create mesh on a very poor
 306     #  quality surface mesh.
 307     #  @param toUse "use boundary recovery version" flag value
 308     def SetToUseBoundaryRecoveryVersion(self, toUse):
 309         self.Parameters().SetToUseBoundaryRecoveryVersion(toUse)
 310         pass
 311
 312     ## Applies finite-element correction by replacing overconstrained elements where
 313     #  it is possible. The process is cutting first the overconstrained edges and
 314     #  second the overconstrained facets. This insure that no edges have two boundary
 315     #  vertices and that no facets have three boundary vertices.
 316     #  @param toUseFem "apply finite-element correction" flag value
 317     def SetFEMCorrection(self, toUseFem):
 318         self.Parameters().SetFEMCorrection(toUseFem)
 319         pass
 320
 321     ## To remove initial central point.
 322     #  @param toRemove "remove initial central point" flag value
 323     def SetToRemoveCentralPoint(self, toRemove):
 324         self.Parameters().SetToRemoveCentralPoint(toRemove)
 325         pass
 326
 327     ## To set an enforced vertex.
 328     #  @param x            : x coordinate
 329     #  @param y            : y coordinate
 330     #  @param z            : z coordinate
 331     #  @param size         : size of 1D element around enforced vertex
 332     #  @param vertexName   : name of the enforced vertex
 333     #  @param groupName    : name of the group
 334     def SetEnforcedVertex(self, x, y, z, size, vertexName = "", groupName = ""):
 335         if vertexName == "":
 336             if groupName == "":
 337                 return self.Parameters().SetEnforcedVertex(x, y, z, size)
 338             else:
 339                 return self.Parameters().SetEnforcedVertexWithGroup(x, y, z, size, groupName)
 340             pass
 341         else:
 342             if groupName == "":
 343                 return self.Parameters().SetEnforcedVertexNamed(x, y, z, size, vertexName)
 344             else:
 345                 return self.Parameters().SetEnforcedVertexNamedWithGroup(x, y, z, size, vertexName, groupName)
 346             pass
 347         pass
 348
 349     ## To set an enforced vertex given a GEOM vertex, group or compound.
 350     #  @param theVertex    : GEOM vertex (or group, compound) to be projected on theFace.
 351     #  @param size         : size of 1D element around enforced vertex
 352     #  @param groupName    : name of the group
 353     def SetEnforcedVertexGeom(self, theVertex, size, groupName = ""):
 354         AssureGeomPublished( self.mesh, theVertex )
 355         if groupName == "":
 356             return self.Parameters().SetEnforcedVertexGeom(theVertex, size)
 357         else:
 358             return self.Parameters().SetEnforcedVertexGeomWithGroup(theVertex, size, groupName)
 359         pass
 360
 361     ## To remove an enforced vertex.
 362     #  @param x            : x coordinate
 363     #  @param y            : y coordinate
 364     #  @param z            : z coordinate
 365     def RemoveEnforcedVertex(self, x, y, z):
 366         return self.Parameters().RemoveEnforcedVertex(x, y, z)
 367
 368     ## To remove an enforced vertex given a GEOM vertex, group or compound.
 369     #  @param theVertex    : GEOM vertex (or group, compound) to be projected on theFace.
 370     def RemoveEnforcedVertexGeom(self, theVertex):
 371         AssureGeomPublished( self.mesh, theVertex )
 372         return self.Parameters().RemoveEnforcedVertexGeom(theVertex)
 373
 374     ## To set an enforced mesh with given size and add the enforced elements in the group "groupName".
 375     #  @param theSource    : source mesh which provides constraint elements/nodes
 376     #  @param elementType  : SMESH.ElementType (NODE, EDGE or FACE)
 377     #  @param size         : size of elements around enforced elements. Unused if -1.
 378     #  @param groupName    : group in which enforced elements will be added. Unused if "".
 379     def SetEnforcedMesh(self, theSource, elementType, size = -1, groupName = ""):
 380         if size < 0:
 381             if groupName == "":
 382                 return self.Parameters().SetEnforcedMesh(theSource, elementType)
 383             else:
 384                 return self.Parameters().SetEnforcedMeshWithGroup(theSource, elementType, groupName)
 385             pass
 386         else:
 387             if groupName == "":
 388                 return self.Parameters().SetEnforcedMeshSize(theSource, elementType, size)
 389             else:
 390                 return self.Parameters().SetEnforcedMeshSizeWithGroup(theSource, elementType, size, groupName)
 391             pass
 392         pass
 393
 394     ## Set advanced option value
 395     #  @param optionName option name
 396     #  @param optionValue option value
 397     def SetOptionValue(self, optionName, optionValue):
 398         self.Parameters().SetOptionValue( optionName, optionValue )
 399         pass
 400
 401     ## Sets command line option as text.
 402     #  @param optionAndValue command line option in a form "option value"
 403     def SetAdvancedOption(self, optionAndValue):
 404         self.Parameters().SetAdvancedOption(optionAndValue)
 405         pass
 406
 407     ## Sets command line option as text.
 408     #
 409     # OBSOLETE. Use SetAdvancedOption()
 410     #  @param option command line option
 411     def SetTextOption(self, option):
 412         self.Parameters().SetAdvancedOption(option)
 413         pass
 414
 415     pass # end of HYBRID_Algorithm class