src/HYBRIDPlugin/HYBRIDPluginBuilder.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (C) 2007-2016  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 "holes" in a solid or not. Default is to mesh.
 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, \
 116                     "Face should be either ID or GEOM_Object, not %s" % type(fid)
 117             pass
 118         self.Parameters().SetFacesWithLayers(ids)
 119         if ids:
 120             self.SetLayersOnAllWrap( False )
 121         pass
 122
 123     """
 124     obsolete
 125     ## To mesh "holes" in a solid or not. Default is to mesh.
 126     #  @param toMesh "mesh holes" flag value
 127     def SetToMeshHoles(self, toMesh):
 128         self.Parameters().SetToMeshHoles(toMesh)
 129         pass
 130
 131     ## To make groups of volumes of different domains when mesh is generated from skin.
 132     #  Default is to make groups.
 133     # This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
 134     #  @param toMesh "mesh holes" flag value
 135     def SetToMakeGroupsOfDomains(self, toMakeGroups):
 136         self.Parameters().SetToMakeGroupsOfDomains(toMakeGroups)
 137         pass
 138
 139     ## Set Optimization level:
 140     #  @param level optimization level, one of the following values
 141     #  - None_Optimization
 142     #  - Light_Optimization
 143     #  - Standard_Optimization
 144     #  - StandardPlus_Optimization
 145     #  - Strong_Optimization.
 146     #  .
 147     #  Default is Standard_Optimization
 148     def SetOptimizationLevel(self, level):
 149         self.Parameters().SetOptimizationLevel(level)
 150         pass
 151
 152     ## Set maximal size of memory to be used by the algorithm (in Megabytes).
 153     #  @param MB maximal size of memory
 154     def SetMaximumMemory(self, MB):
 155         self.Parameters().SetMaximumMemory(MB)
 156         pass
 157
 158     ## Set initial size of memory to be used by the algorithm (in Megabytes) in
 159     #  automatic memory adjustment mode.
 160     #  @param MB initial size of memory
 161     def SetInitialMemory(self, MB):
 162         self.Parameters().SetInitialMemory(MB)
 163         pass
 164     """
 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     ## To set boundary layers coefficient of geometric progression.
 219     # Default is 1.0
 220     # @param boundaryLayersProgression double value
 221     def SetBoundaryLayersProgression(self, boundaryLayersProgression):
 222         self.Parameters().SetBoundaryLayersProgression(boundaryLayersProgression)
 223         pass
 224
 225     ## Set core elements size.
 226     # Default is 0.0
 227     # @param CoreSize double value
 228     def SetCoreSize(self, CoreSize):
 229         self.Parameters().SetCoreSize(CoreSize)
 230         pass
 231
 232     ## To set multinormals angle threshold at opening ridges.
 233     # Default is 30.0
 234     # @param multinormalsAngle double value
 235     def SetMultinormalsAngle(self, multinormalsAngle):
 236         self.Parameters().SetMultinormalsAngle(multinormalsAngle)
 237         pass
 238
 239     ## To set number of boundary layers.
 240     # Default is 1
 241     # @param nbOfBoundaryLayers int value
 242     def SetNbOfBoundaryLayers(self, nbOfBoundaryLayers):
 243         self.Parameters().SetNbOfBoundaryLayers(nbOfBoundaryLayers)
 244         pass
 245
 246     ## Set path to working directory.
 247     #  @param path working directory
 248     def SetWorkingDirectory(self, path):
 249         self.Parameters().SetWorkingDirectory(path)
 250         pass
 251
 252     ## To keep working files or remove them.
 253     #  @param toKeep "keep working files" flag value
 254     def SetKeepFiles(self, toKeep):
 255         self.Parameters().SetKeepFiles(toKeep)
 256         pass
 257
 258     ## Remove or not the log file (if any) in case of successful computation.
 259     #  The log file remains in case of errors anyway. If
 260     #  the "keep working files" flag is set to true, this option
 261     #  has no effect.
 262     #  @param toRemove "remove log on success" flag value
 263     def SetRemoveLogOnSuccess(self, toRemove):
 264         self.Parameters().SetRemoveLogOnSuccess(toRemove)
 265         pass
 266
 267     ## Print the the log in a file. If set to false, the
 268     # log is printed on the standard output
 269     #  @param toPrintLogInFile "print log in a file" flag value
 270     def SetPrintLogInFile(self, toPrintLogInFile):
 271         self.Parameters().SetStandardOutputLog(not toPrintLogInFile)
 272         pass
 273
 274     ## Set verbosity level [0-10].
 275     #  @param level verbosity level
 276     #  - 0 - no standard output,
 277     #  - 2 - prints the data, quality statistics of the skin and final meshes and
 278     #    indicates when the final mesh is being saved. In addition the software
 279     #    gives indication regarding the CPU time.
 280     #  - 10 - same as 2 plus the main steps in the computation, quality statistics
 281     #    histogram of the skin mesh, quality statistics histogram together with
 282     #    the characteristics of the final mesh.
 283     def SetVerboseLevel(self, level):
 284         self.Parameters().SetVerboseLevel(level)
 285         pass
 286
 287     ## To create new nodes.
 288     #  @param toCreate "create new nodes" flag value
 289     def SetToCreateNewNodes(self, toCreate):
 290         self.Parameters().SetToCreateNewNodes(toCreate)
 291         pass
 292
 293     ## To use boundary recovery version which tries to create mesh on a very poor
 294     #  quality surface mesh.
 295     #  @param toUse "use boundary recovery version" flag value
 296     def SetToUseBoundaryRecoveryVersion(self, toUse):
 297         self.Parameters().SetToUseBoundaryRecoveryVersion(toUse)
 298         pass
 299
 300     ## Applies finite-element correction by replacing overconstrained elements where
 301     #  it is possible. The process is cutting first the overconstrained edges and
 302     #  second the overconstrained facets. This insure that no edges have two boundary
 303     #  vertices and that no facets have three boundary vertices.
 304     #  @param toUseFem "apply finite-element correction" flag value
 305     def SetFEMCorrection(self, toUseFem):
 306         self.Parameters().SetFEMCorrection(toUseFem)
 307         pass
 308
 309     ## To remove initial central point.
 310     #  @param toRemove "remove initial central point" flag value
 311     def SetToRemoveCentralPoint(self, toRemove):
 312         self.Parameters().SetToRemoveCentralPoint(toRemove)
 313         pass
 314
 315     ## To set an enforced vertex.
 316     #  @param x            : x coordinate
 317     #  @param y            : y coordinate
 318     #  @param z            : z coordinate
 319     #  @param size         : size of 1D element around enforced vertex
 320     #  @param vertexName   : name of the enforced vertex
 321     #  @param groupName    : name of the group
 322     def SetEnforcedVertex(self, x, y, z, size, vertexName = "", groupName = ""):
 323         if vertexName == "":
 324             if groupName == "":
 325                 return self.Parameters().SetEnforcedVertex(x, y, z, size)
 326             else:
 327                 return self.Parameters().SetEnforcedVertexWithGroup(x, y, z, size, groupName)
 328             pass
 329         else:
 330             if groupName == "":
 331                 return self.Parameters().SetEnforcedVertexNamed(x, y, z, size, vertexName)
 332             else:
 333                 return self.Parameters().SetEnforcedVertexNamedWithGroup(x, y, z, size, vertexName, groupName)
 334             pass
 335         pass
 336
 337     ## To set an enforced vertex given a GEOM vertex, group or compound.
 338     #  @param theVertex    : GEOM vertex (or group, compound) to be projected on theFace.
 339     #  @param size         : size of 1D element around enforced vertex
 340     #  @param groupName    : name of the group
 341     def SetEnforcedVertexGeom(self, theVertex, size, groupName = ""):
 342         AssureGeomPublished( self.mesh, theVertex )
 343         if groupName == "":
 344             return self.Parameters().SetEnforcedVertexGeom(theVertex, size)
 345         else:
 346             return self.Parameters().SetEnforcedVertexGeomWithGroup(theVertex, size, groupName)
 347         pass
 348
 349     ## To remove an enforced vertex.
 350     #  @param x            : x coordinate
 351     #  @param y            : y coordinate
 352     #  @param z            : z coordinate
 353     def RemoveEnforcedVertex(self, x, y, z):
 354         return self.Parameters().RemoveEnforcedVertex(x, y, z)
 355
 356     ## To remove an enforced vertex given a GEOM vertex, group or compound.
 357     #  @param theVertex    : GEOM vertex (or group, compound) to be projected on theFace.
 358     def RemoveEnforcedVertexGeom(self, theVertex):
 359         AssureGeomPublished( self.mesh, theVertex )
 360         return self.Parameters().RemoveEnforcedVertexGeom(theVertex)
 361
 362     ## To set an enforced mesh with given size and add the enforced elements in the group "groupName".
 363     #  @param theSource    : source mesh which provides constraint elements/nodes
 364     #  @param elementType  : SMESH.ElementType (NODE, EDGE or FACE)
 365     #  @param size         : size of elements around enforced elements. Unused if -1.
 366     #  @param groupName    : group in which enforced elements will be added. Unused if "".
 367     def SetEnforcedMesh(self, theSource, elementType, size = -1, groupName = ""):
 368         if size < 0:
 369             if groupName == "":
 370                 return self.Parameters().SetEnforcedMesh(theSource, elementType)
 371             else:
 372                 return self.Parameters().SetEnforcedMeshWithGroup(theSource, elementType, groupName)
 373             pass
 374         else:
 375             if groupName == "":
 376                 return self.Parameters().SetEnforcedMeshSize(theSource, elementType, size)
 377             else:
 378                 return self.Parameters().SetEnforcedMeshSizeWithGroup(theSource, elementType, size, groupName)
 379             pass
 380         pass
 381
 382     ## Sets command line option as text.
 383     #
 384     # OBSOLETE. Use SetAdvancedOption()
 385     #  @param option command line option
 386     def SetTextOption(self, option):
 387         self.Parameters().SetAdvancedOption(option)
 388         pass
 389
 390     ## Sets command line option as text.
 391     #  @param option command line option
 392     def SetAdvancedOption(self, option):
 393         self.Parameters().SetAdvancedOption(option)
 394         pass
 395
 396     pass # end of HYBRID_Algorithm class