src/BLSURFPlugin/BLSURFPluginBuilder.py

   1 # Copyright (C) 2007-2019  CEA/DEN, EDF R&D
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 ##
  21 # @package BLSURFPluginBuilder
  22 # Python API for the MG-CADSurf meshing plug-in module.
  23
  24 from salome.smesh.smesh_algorithm import Mesh_Algorithm
  25 import GEOM
  26
  27 LIBRARY = "libBLSURFEngine.so"
  28
  29 # ElementType enum
  30 Triangles, QuadrangleDominant, Quadrangles = 0, 1, 2
  31
  32 # Topology treatment way of MG-CADSurf
  33 FromCAD, PreProcess, PreProcessPlus, PreCAD = 0,1,2,3
  34
  35 # Element size flag of MG-CADSurf
  36 DefaultSize, DefaultGeom, MG_CADSURF_GlobalSize, MG_CADSURF_LocalSize = 0,0,1,2
  37 # Retrocompatibility
  38 MG_CADSURF_Custom, SizeMap = MG_CADSURF_GlobalSize, MG_CADSURF_LocalSize
  39 BLSURF_Custom, BLSURF_GlobalSize, BLSURF_LocalSize = MG_CADSURF_Custom, MG_CADSURF_GlobalSize, MG_CADSURF_LocalSize
  40
  41 # import BLSURFPlugin module if possible
  42 noBLSURFPlugin = 0
  43 try:
  44   import BLSURFPlugin
  45 except ImportError:
  46   noBLSURFPlugin = 1
  47   pass
  48
  49 #----------------------------
  50 # Mesh algo type identifiers
  51 #----------------------------
  52
  53 ## Algorithm type: MG-CADSurf triangle algorithm, see BLSURF_Algorithm
  54 MG_CADSurf = "MG-CADSurf"
  55 BLSURF = MG_CADSurf
  56
  57 #----------------------
  58 # Algorithms
  59 #----------------------
  60
  61 ## MG-CADSurf 2D algorithm.
  62 #
  63 #  It can be created by calling smeshBuilder.Mesh.Triangle(smeshBuilder.MG-CADSurf,geom=0)
  64 #
  65 class BLSURF_Algorithm(Mesh_Algorithm):
  66
  67   ## name of the dynamic method in smeshBuilder.Mesh class
  68   #  @internal
  69   meshMethod = "Triangle"
  70   ## type of algorithm used with helper function in smeshBuilder.Mesh class
  71   #  @internal
  72   algoType   = MG_CADSurf
  73   ## doc string of the method
  74   #  @internal
  75   docHelper  = "Creates triangle algorithm for faces"
  76
  77   _anisotropic_ratio = 0
  78   _bad_surface_element_aspect_ratio = 1000
  79   _geometric_approximation = 22
  80   _gradation  = 1.3
  81   _volume_gradation  = 2
  82   _metric = "isotropic"
  83   _remove_tiny_edges = 0
  84
  85   ## Private constructor.
  86   #  @param mesh parent mesh object algorithm is assigned to
  87   #  @param geom geometry (shape/sub-shape) algorithm is assigned to;
  88   #              if it is @c 0 (default), the algorithm is assigned to the main shape
  89   def __init__(self, mesh, geom=0):
  90     Mesh_Algorithm.__init__(self)
  91     if noBLSURFPlugin:
  92       print("Warning: BLSURFPlugin module unavailable")
  93     if mesh.GetMesh().HasShapeToMesh():
  94       self.Create(mesh, geom, self.algoType, LIBRARY)
  95     else:
  96       self.Create(mesh, geom, self.algoType+"_NOGEOM", LIBRARY)
  97       mesh.smeshpyD.SetName( self.algo, self.algoType )
  98     self.params=None
  99     self.geompyD = mesh.geompyD
 100     #self.SetPhysicalMesh() - PAL19680
 101     pass
 102
 103   ## Sets a way to define size of mesh elements to generate.
 104   #  @param thePhysicalMesh is: DefaultSize, MG_CADSURF_Custom or SizeMap.
 105   def SetPhysicalMesh(self, thePhysicalMesh=DefaultSize):
 106     physical_size_mode = thePhysicalMesh
 107     if self.Parameters().GetGeometricMesh() == DefaultGeom:
 108       if physical_size_mode == DefaultSize:
 109         physical_size_mode = MG_CADSURF_GlobalSize
 110     self.Parameters().SetPhysicalMesh(physical_size_mode)
 111     pass
 112
 113   ## Sets a way to define maximum angular deflection of mesh from CAD model.
 114   #  @param theGeometricMesh is: DefaultGeom (0)) or MG_CADSURF_GlobalSize (1))
 115   def SetGeometricMesh(self, theGeometricMesh=DefaultGeom):
 116     geometric_size_mode = theGeometricMesh
 117     if self.Parameters().GetPhysicalMesh() == DefaultSize:
 118       if geometric_size_mode == DefaultGeom:
 119         geometric_size_mode = MG_CADSURF_GlobalSize
 120     self.Parameters().SetGeometricMesh(geometric_size_mode)
 121     pass
 122
 123   ## Sets size of mesh elements to generate.
 124   #  @param theVal : constant global size when using a global physical size.
 125   #  @param isRelative : if True, the value is relative to the length of the diagonal of the bounding box
 126   def SetPhySize(self, theVal, isRelative = False):
 127     if self.Parameters().GetPhysicalMesh() == DefaultSize:
 128       self.SetPhysicalMesh(MG_CADSURF_GlobalSize)
 129     if isRelative:
 130       self.Parameters().SetPhySizeRel(theVal)
 131     else:
 132       self.Parameters().SetPhySize(theVal)
 133     pass
 134
 135   ## Sets lower boundary of mesh element size.
 136   #  @param theVal : global minimal cell size desired.
 137   #  @param isRelative : if True, the value is relative to the length of the diagonal of the bounding box
 138   def SetMinSize(self, theVal=-1, isRelative = False):
 139     if isRelative:
 140       self.Parameters().SetMinSizeRel(theVal)
 141     else:
 142       self.Parameters().SetMinSize(theVal)
 143     pass
 144
 145   ## Sets upper boundary of mesh element size.
 146   #  @param theVal : global maximal cell size desired.
 147   #  @param isRelative : if True, the value is relative to the length of the diagonal of the bounding box
 148   def SetMaxSize(self, theVal=-1, isRelative = False):
 149     if isRelative:
 150       self.Parameters().SetMaxSizeRel(theVal)
 151     else:
 152       self.Parameters().SetMaxSize(theVal)
 153     pass
 154
 155   ## Sets angular deflection (in degrees) from CAD surface.
 156   #  @param theVal value of angular deflection
 157   def SetAngleMesh(self, theVal=_geometric_approximation):
 158     if self.Parameters().GetGeometricMesh() == DefaultGeom:
 159       self.SetGeometricMesh(MG_CADSURF_GlobalSize)
 160     self.Parameters().SetAngleMesh(theVal)
 161     pass
 162
 163   ## Sets the maximum desired distance between a triangle and its supporting CAD surface
 164   #  @param distance the distance between a triangle and a surface
 165   def SetChordalError(self, distance):
 166     self.Parameters().SetChordalError(distance)
 167     pass
 168
 169   ## Sets maximal allowed ratio between the lengths of two adjacent edges.
 170   #  @param toUseGradation to use gradation
 171   #  @param theVal value of maximal length ratio
 172   def SetGradation(self, toUseGradation=True, theVal=_gradation):
 173     if isinstance( toUseGradation, float ): ## backward compatibility
 174       toUseGradation, theVal = True, toUseGradation
 175     if self.Parameters().GetGeometricMesh() == 0: theVal = self._gradation
 176     self.Parameters().SetUseGradation(toUseGradation)
 177     self.Parameters().SetGradation(theVal)
 178     pass
 179
 180   ## Sets maximal allowed ratio between the lengths of two adjacent edges in 3D mesh.
 181   #  @param toUseGradation to use gradation
 182   #  @param theVal value of maximal length ratio
 183   def SetVolumeGradation(self, toUseGradation=True, theVal=_gradation):
 184     if self.Parameters().GetGeometricMesh() == 0: theVal = self._volume_gradation
 185     self.Parameters().SetUseVolumeGradation(toUseGradation)
 186     self.Parameters().SetVolumeGradation(theVal)
 187     pass
 188
 189   ## Sets topology usage way.
 190   # @param way defines how mesh conformity is assured <ul>
 191   # <li>FromCAD - mesh conformity is assured by conformity of a shape</li>
 192   # <li>PreProcess or PreProcessPlus - by pre-processing a CAD model (OBSOLETE: FromCAD will be used)</li>
 193   # <li>PreCAD - by pre-processing with PreCAD a CAD model</li></ul>
 194   def SetTopology(self, way):
 195     if way != PreCAD and way != FromCAD:
 196       print("Warning: topology mode %d is no longer supported. Mode FromCAD is used."%way)
 197       way = FromCAD
 198     self.Parameters().SetTopology(way)
 199     pass
 200
 201   ## Activate/deactivate surface proximity computation
 202   # @param toUse boolean flag
 203   #
 204   def SetSurfaceProximity(self, toUse ):
 205     self.Parameters().SetSurfaceProximity(toUse)
 206     return
 207
 208   ## Set number of surface element layers to be generated due to surface proximity
 209   # @param nbLayers number of layers
 210   #
 211   def SetNbSurfaceProximityLayers(self, nbLayers ):
 212     self.Parameters().SetNbSurfaceProximityLayers( nbLayers )
 213     return
 214
 215   ## Set coefficient by which size of element refined due to surface proximity is increased
 216   # @param ratio proximity coefficient
 217   #
 218   def SetSurfaceProximityRatio(self, ratio ):
 219     self.Parameters().SetSurfaceProximityRatio(ratio)
 220     return
 221
 222   ## Activate/deactivate volume proximity computation
 223   # @param toUse boolean flag
 224   #
 225   def SetVolumeProximity(self, toUse ):
 226     self.Parameters().SetVolumeProximity(toUse)
 227     return
 228
 229   ## Set number of surface element layers to be generated due to volume proximity
 230   # @param nbLayers number of layers
 231   #
 232   def SetNbVolumeProximityLayers(self, nbLayers ):
 233     self.Parameters().SetNbVolumeProximityLayers(nbLayers)
 234     return
 235
 236   ## Set coefficient by which size of element refined due to volume proximity is increased
 237   # @param ratio proximity coefficient
 238   #
 239   def SetVolumeProximityRatio(self, ratio ):
 240     self.Parameters().SetVolumeProximityRatio(ratio)
 241     return
 242
 243
 244   ## Sets verbosity level in the range 0 to 100.
 245   #  @param level verbosity level
 246   def SetVerbosity(self, level):
 247     self.Parameters().SetVerbosity(level)
 248     pass
 249
 250   ## Set enforce_cad_edge_sizes parameter
 251   #
 252   #  Relaxes the given sizemap constraint around CAD edges to allow a better
 253   #  element quality and a better geometric approximation. It is only useful in
 254   #  combination with the gradation option.
 255   #
 256   def SetEnforceCadEdgesSize( self, toEnforce ):
 257     self.Parameters().SetEnforceCadEdgesSize( toEnforce )
 258
 259   ## Set jacobian_rectification_respect_geometry parameter
 260   #
 261   #  While making the mesh quadratic, allows to lose the CAD-mesh associativity in order
 262   #  to correct elements with nagative Jacobian
 263   #
 264   def SetJacobianRectificationRespectGeometry( self, allowRectification ):
 265     self.Parameters().SetJacobianRectificationRespectGeometry( allowRectification )
 266
 267   ## Set rectify_jacobian parameter
 268   #
 269   #  While making the mesh quadratic, allow to fix nagative Jacobian surface elements
 270   #
 271   def SetJacobianRectification( self, allowRectification ):
 272     self.Parameters().SetJacobianRectification( allowRectification )
 273
 274   ## Set use_deprecated_patch_mesher parameter (compatibility with older versions of Meshgems)
 275   #
 276   # the use_deprecated_patch_mesher parameter allows to keep the same behaviour than
 277   # in salome < 8.3 (meshgems 2.1.11 instead of meshgems >= 2.4.5)
 278   #
 279   def SetUseDeprecatedPatchMesher( self, useDeprecatedPatchMesher ):
 280     self.Parameters().SetUseDeprecatedPatchMesher( useDeprecatedPatchMesher )
 281
 282   ## Set respect_geometry parameter
 283   #
 284   #  This patch independent option can be deactivated to allow MeshGems-CADSurf
 285   #  to lower the geometry accuracy in its patch independent process.
 286   #
 287   def SetRespectGeometry( self, toRespect ):
 288     self.Parameters().SetRespectGeometry( toRespect )
 289
 290   ## Set max_number_of_points_per_patch parameter
 291   #
 292   #  This parameter controls the maximum amount of points MeshGems-CADSurf is allowed
 293   #  to generate on a single CAD patch. For an automatic gestion of the memory, one
 294   #  can set this parameter to 0
 295   #
 296   def SetMaxNumberOfPointsPerPatch( self, nb ):
 297     print("Warning: method SetMaxNumberOfPointsPerPatch() is deprecated")
 298     self.Parameters().SetMaxNumberOfPointsPerPatch( nb )
 299
 300   ## Set max_number_of_threads parameter
 301   #
 302   #  Set the maximum of threads to use for multithreading mesh computation
 303   #
 304   def SetMaxNumberOfThreads( self, nb ):
 305     self.Parameters().SetMaxNumberOfThreads( nb )
 306
 307   ## Set respect_geometry parameter
 308   #
 309   #  This patch independent option can be deactivated to allow MeshGems-CADSurf
 310   #  to lower the geometry accuracy in its patch independent process.
 311   #
 312   def SetRespectGeometry( self, toRespect ):
 313     self.Parameters().SetRespectGeometry( toRespect )
 314
 315   ## Set tiny_edges_avoid_surface_intersections parameter
 316   #
 317   #  This option defines the priority between the tiny feature
 318   #  suppression and the surface intersection prevention.
 319   #
 320   def SetTinyEdgesAvoidSurfaceIntersections( self, toAvoidIntersection ):
 321     self.Parameters().SetTinyEdgesAvoidSurfaceIntersections( toAvoidIntersection )
 322
 323   ## Set closed_geometry parameter parameter
 324   #
 325   #  Describes whether the geometry is expected to be closed or not.
 326   #  When activated, this option helps MeshGems-PreCAD to treat the dirtiest geometries.
 327   #
 328   def SetClosedGeometry( self, isClosed ):
 329     self.Parameters().SetClosedGeometry( isClosed )
 330
 331   ## Set debug parameter
 332   #
 333   #  Make MeshGems-CADSurf will be very verbose and will output some intermediate
 334   #  files in the working directory. This option is mainly meant for Distene support issues.
 335   #
 336   def SetDebug( self, isDebug ):
 337     self.Parameters().SetDebug( isDebug )
 338
 339   ## Set periodic_tolerance parameter
 340   #
 341   #  This parameter defines the maximum size difference between two periodic edges
 342   #  and also the maximum distance error between two periodic entities.
 343   #
 344   def SetPeriodicTolerance( self, tol ):
 345     self.Parameters().SetPeriodicTolerance( tol )
 346
 347   ## Set required_entities parameter
 348   #
 349   #  The required entities control the correction operations.
 350   #  Accepted values for this parameter are :
 351   #  - "respect" : MeshGems-CADSurf is not allowed to alter any required entity,
 352   #                even for correction purposes,
 353   #  - "ignore" : MeshGems-CADSurf will ignore the required entities in its processing,
 354   #  - "clear" : MeshGems-CADSurf will clear any required status for the entities.
 355   #              There will not be any entity marked as required in the generated mesh.
 356   #
 357   def SetRequiredEntities( self, howToTreat ):
 358     self.Parameters().SetRequiredEntities( howToTreat )
 359
 360   ## Set sewing_tolerance parameter
 361   #
 362   #  This parameter is the tolerance of the assembly.
 363   #
 364   def SetSewingTolerance( self, tol ):
 365     self.Parameters().SetSewingTolerance( tol )
 366
 367   ## Set tags parameter
 368   #
 369   #  The tag (attribute) system controls the optimisation process.
 370   #  Accepted values for this parameter are :
 371   #  - "respect"  : the CAD tags will be preserved and unaltered by the optimisation operations,
 372   #  - "ignore" : the CAD tags will be ignored by the optimisation operations
 373   #               but they will still be present in the output mesh,
 374   #  - "clear" : MeshGems-CADSurf will clear any tag on any entity and optimise accordingly.
 375   #              There will not be any tag in the generated mesh.
 376   #
 377   def SetTags( self, howToTreat ):
 378     self.Parameters().SetTags( howToTreat )
 379
 380   ## Activate/deactivate fully patch independent meshing
 381   #   @param isIndependent boolean flag
 382   #
 383   # This feature can only be used if the @a tags parameter is set to "respect".
 384   # By default this option deactivated.
 385   #
 386   def SetPatchIndependent( self, isIndependent ):
 387     self.SetOptionValue( "allow_patch_independent", "yes" if isIndependent else "no" )
 388
 389   ## Set to preserve lines defined by a sharp angle in the input discrete geometry
 390   #   @param toCompute boolean flag
 391   #
 392   # If this option is deactivated, MeshGems-CADSurf will not try to preserve lines
 393   # defined by a sharp angle in the input discrete geometry. Only input ridges, free
 394   # edges, non manifold edges and separation betwen zones with different attributes
 395   # will be respected (if tags is set to respect).
 396   # By default this option activated.
 397   #
 398   def SetComputeRidges( self, toCompute ):
 399     self.SetOptionValue( "compute_ridges", "yes" if toCompute else "no" )
 400
 401
 402   ## Activate removal of the tiny edges from the generated
 403   # mesh when it improves the local mesh quality, without taking into account the
 404   # tags (attributes) specifications.
 405   #  @param toOptimise "to optimize" flag value
 406   #  @param length minimal length under which an edge is considered to be a tiny
 407   def SetOptimiseTinyEdges(self, toOptimise, length=-1):
 408     self.Parameters().SetOptimiseTinyEdges( toOptimise )
 409     if toOptimise:
 410       self.Parameters().SetTinyEdgeOptimisationLength( length )
 411
 412   ## Activate correction of all surface intersections
 413   #  @param toCorrect "to correct" flag value
 414   #  @param maxCost  the time the user is ready to spend in the intersection prevention process
 415   #         For example, maxCost = 3 means that MeshGems-CADSurf will not spend more time
 416   #         in the intersection removal process than 3 times the time required to mesh
 417   #         without processing the intersections.
 418   def SetCorrectSurfaceIntersection(self, toCorrect, maxCost ):
 419     self.Parameters().SetCorrectSurfaceIntersection( toCorrect )
 420     if toCorrect:
 421       self.Parameters().SetCorrectSurfaceIntersectionMaxCost( maxCost )
 422
 423   ## To optimize merges edges.
 424   #  @param toMergeEdges "merge edges" flag value
 425   def SetPreCADMergeEdges(self, toMergeEdges=False):
 426     self.Parameters().SetPreCADMergeEdges(toMergeEdges)
 427     pass
 428
 429   ## To remove duplicate CAD Faces
 430   #  @param toRemoveDuplicateCADFaces "remove_duplicate_cad_faces" flag value
 431   def SetPreCADRemoveDuplicateCADFaces(self, toRemoveDuplicateCADFaces=False):
 432     self.Parameters().SetPreCADRemoveDuplicateCADFaces(toRemoveDuplicateCADFaces)
 433     pass
 434
 435   ## To process 3D topology.
 436   #  @param toProcess "PreCAD process 3D" flag value
 437   def SetPreCADProcess3DTopology(self, toProcess=False):
 438     self.Parameters().SetPreCADProcess3DTopology(toProcess)
 439     pass
 440
 441   ## To remove nano edges.
 442   #  @param toRemoveNanoEdges "remove nano edges" flag value
 443   def SetPreCADRemoveNanoEdges(self, toRemoveNanoEdges=False):
 444     if toRemoveNanoEdges:
 445       self.SetPreCADOptionValue("remove_tiny_edges","1")
 446     else:
 447       self.SetPreCADOptionValue("remove_tiny_edges","0")
 448     pass
 449
 450   ## To compute topology from scratch
 451   #  @param toDiscardInput "discard input" flag value
 452   def SetPreCADDiscardInput(self, toDiscardInput=False):
 453     self.Parameters().SetPreCADDiscardInput(toDiscardInput)
 454     pass
 455
 456   ## Sets the length below which an edge is considered as nano
 457   #  for the topology processing.
 458   #  @param epsNano nano edge length threshold value
 459   def SetPreCADEpsNano(self, epsNano):
 460     self.SetPreCADOptionValue("tiny_edge_length","%f"%epsNano)
 461     pass
 462
 463   ## Sets advanced option value.
 464   #  @param optionName advanced option name
 465   #  @param level advanced option value
 466   def SetOptionValue(self, optionName, level):
 467     self.Parameters().SetOptionValue(optionName,level)
 468     pass
 469
 470   ## Sets advanced PreCAD option value.
 471   #  @param optionName name of the option
 472   #  @param optionValue value of the option
 473   def SetPreCADOptionValue(self, optionName, optionValue):
 474     self.Parameters().SetPreCADOptionValue(optionName,optionValue)
 475     pass
 476
 477   ## Adds custom advanced option values
 478   #  @param optionsAndValues options and values in a form "option_1 v1 option_2 v2'"
 479   def SetAdvancedOption(self, optionsAndValues):
 480     self.Parameters().SetAdvancedOption(optionsAndValues)
 481     pass
 482
 483   ## Adds custom advanced option value.
 484   #  @param optionName custom advanced option name
 485   #  @param level custom advanced option value
 486   def AddOption(self, optionName, level):
 487     self.Parameters().AddOption(optionName,level)
 488     pass
 489
 490   ## Adds custom advanced PreCAD option value.
 491   #  @param optionName custom name of the option
 492   #  @param optionValue value of the option
 493   def AddPreCADOption(self, optionName, optionValue):
 494     self.Parameters().AddPreCADOption(optionName,optionValue)
 495     pass
 496
 497   ## Sets GMF file for export at computation
 498   #  @param fileName GMF file name
 499   def SetGMFFile(self, fileName):
 500     self.Parameters().SetGMFFile(fileName)
 501     pass
 502
 503   #-----------------------------------------
 504   # Enforced vertices (BLSURF)
 505   #-----------------------------------------
 506
 507   ## To get all the enforced vertices
 508   def GetAllEnforcedVertices(self):
 509     return self.Parameters().GetAllEnforcedVertices()
 510
 511   ## To get all the enforced vertices sorted by face (or group, compound)
 512   def GetAllEnforcedVerticesByFace(self):
 513     return self.Parameters().GetAllEnforcedVerticesByFace()
 514
 515   ## To get all the enforced vertices sorted by coords of input vertices
 516   def GetAllEnforcedVerticesByCoords(self):
 517     return self.Parameters().GetAllEnforcedVerticesByCoords()
 518
 519   ## To get all the coords of input vertices sorted by face (or group, compound)
 520   def GetAllCoordsByFace(self):
 521     return self.Parameters().GetAllCoordsByFace()
 522
 523   ## To get all the enforced vertices on a face (or group, compound)
 524   #  @param theFace : GEOM face (or group, compound) on which to define an enforced vertex
 525   def GetEnforcedVertices(self, theFace):
 526     from salome.smesh.smeshBuilder import AssureGeomPublished
 527     AssureGeomPublished( self.mesh, theFace )
 528     return self.Parameters().GetEnforcedVertices(theFace)
 529
 530   ## To clear all the enforced vertices
 531   def ClearAllEnforcedVertices(self):
 532     return self.Parameters().ClearAllEnforcedVertices()
 533
 534   ## To set an enforced vertex on a face (or group, compound) given the coordinates of a point. If the point is not on the face, it will projected on it. If there is no projection, no enforced vertex is created.
 535   #  @param theFace      : GEOM face (or group, compound) on which to define an enforced vertex
 536   #  @param x            : x coordinate
 537   #  @param y            : y coordinate
 538   #  @param z            : z coordinate
 539   #  @param vertexName   : name of the enforced vertex
 540   #  @param groupName    : name of the group
 541   def SetEnforcedVertex(self, theFace, x, y, z, vertexName = "", groupName = ""):
 542     from salome.smesh.smeshBuilder import AssureGeomPublished
 543     AssureGeomPublished( self.mesh, theFace )
 544     if vertexName == "":
 545       if groupName == "":
 546         return self.Parameters().SetEnforcedVertex(theFace, x, y, z)
 547       else:
 548         return self.Parameters().SetEnforcedVertexWithGroup(theFace, x, y, z, groupName)
 549       pass
 550     else:
 551       if groupName == "":
 552         return self.Parameters().SetEnforcedVertexNamed(theFace, x, y, z, vertexName)
 553       else:
 554         return self.Parameters().SetEnforcedVertexNamedWithGroup(theFace, x, y, z, vertexName, groupName)
 555       pass
 556     pass
 557
 558   ## To set an enforced vertex on a face (or group, compound) given a GEOM vertex, group or compound.
 559   #  @param theFace      : GEOM face (or group, compound) on which to define an enforced vertex
 560   #  @param theVertex    : GEOM vertex (or group, compound) to be projected on theFace.
 561   #  @param groupName    : name of the group
 562   def SetEnforcedVertexGeom(self, theFace, theVertex, groupName = ""):
 563     from salome.smesh.smeshBuilder import AssureGeomPublished
 564     AssureGeomPublished( self.mesh, theFace )
 565     AssureGeomPublished( self.mesh, theVertex )
 566     if groupName == "":
 567       return self.Parameters().SetEnforcedVertexGeom(theFace, theVertex)
 568     else:
 569       return self.Parameters().SetEnforcedVertexGeomWithGroup(theFace, theVertex,groupName)
 570     pass
 571
 572   ## Set an enforced vertex on a face given the coordinates of a point.
 573   #  The face if found by the application.
 574   #  @param x            : x coordinate
 575   #  @param y            : y coordinate
 576   #  @param z            : z coordinate
 577   #  @param vertexName   : name of the enforced vertex
 578   #  @param groupName    : name of the group
 579   def AddEnforcedVertex(self, x, y, z, vertexName = "", groupName = ""):
 580     from salome.smesh.smeshBuilder import AssureGeomPublished
 581     if vertexName == "":
 582       if groupName == "":
 583         return self.Parameters().AddEnforcedVertex(x, y, z)
 584       else:
 585         return self.Parameters().AddEnforcedVertexWithGroup(x, y, z, groupName)
 586       pass
 587     else:
 588       if groupName == "":
 589         return self.Parameters().AddEnforcedVertexNamed(x, y, z, vertexName)
 590       else:
 591         return self.Parameters().AddEnforcedVertexNamedWithGroup( x, y, z, vertexName, groupName)
 592       pass
 593     pass
 594
 595   ## To set an enforced vertex on a face given a GEOM vertex, group or compound.
 596   #  The face if found by the application.
 597   #  @param theVertex    : GEOM vertex (or group, compound).
 598   #  @param groupName    : name of the group
 599   def AddEnforcedVertexGeom(self, theVertex, groupName = ""):
 600     from salome.smesh.smeshBuilder import AssureGeomPublished
 601     AssureGeomPublished( self.mesh, theVertex )
 602     if groupName == "":
 603       return self.Parameters().AddEnforcedVertexGeom(theVertex)
 604     else:
 605       return self.Parameters().AddEnforcedVertexGeomWithGroup(theVertex,groupName)
 606     pass
 607
 608   ## To remove an enforced vertex on a given GEOM face (or group, compound) given the coordinates.
 609   #  @param theFace      : GEOM face (or group, compound) on which to remove the enforced vertex
 610   #  @param x            : x coordinate
 611   #  @param y            : y coordinate
 612   #  @param z            : z coordinate
 613   def UnsetEnforcedVertex(self, theFace, x, y, z):
 614     from salome.smesh.smeshBuilder import AssureGeomPublished
 615     AssureGeomPublished( self.mesh, theFace )
 616     return self.Parameters().UnsetEnforcedVertex(theFace, x, y, z)
 617
 618   ## To remove an enforced vertex on a given GEOM face (or group, compound) given a GEOM vertex, group or compound.
 619   #  @param theFace      : GEOM face (or group, compound) on which to remove the enforced vertex
 620   #  @param theVertex    : GEOM vertex (or group, compound) to remove.
 621   def UnsetEnforcedVertexGeom(self, theFace, theVertex):
 622     from salome.smesh.smeshBuilder import AssureGeomPublished
 623     AssureGeomPublished( self.mesh, theFace )
 624     AssureGeomPublished( self.mesh, theVertex )
 625     return self.Parameters().UnsetEnforcedVertexGeom(theFace, theVertex)
 626
 627   ## To remove all enforced vertices on a given face.
 628   #  @param theFace      : face (or group/compound of faces) on which to remove all enforced vertices
 629   def UnsetEnforcedVertices(self, theFace):
 630     from salome.smesh.smeshBuilder import AssureGeomPublished
 631     AssureGeomPublished( self.mesh, theFace )
 632     return self.Parameters().UnsetEnforcedVertices(theFace)
 633
 634   ## To tell BLSURF to add a node on internal vertices
 635   #  @param toEnforceInternalVertices : boolean; if True the internal vertices are added as enforced vertices
 636   def SetInternalEnforcedVertexAllFaces(self, toEnforceInternalVertices):
 637     return self.Parameters().SetInternalEnforcedVertexAllFaces(toEnforceInternalVertices)
 638
 639   ## To know if BLSURF will add a node on internal vertices
 640   def GetInternalEnforcedVertexAllFaces(self):
 641     return self.Parameters().GetInternalEnforcedVertexAllFaces()
 642
 643   ## To define a group for the nodes of internal vertices
 644   #  @param groupName : string; name of the group
 645   def SetInternalEnforcedVertexAllFacesGroup(self, groupName):
 646     return self.Parameters().SetInternalEnforcedVertexAllFacesGroup(groupName)
 647
 648   ## To get the group name of the nodes of internal vertices
 649   def GetInternalEnforcedVertexAllFacesGroup(self):
 650     return self.Parameters().GetInternalEnforcedVertexAllFacesGroup()
 651
 652   #-----------------------------------------
 653   #  Attractors
 654   #-----------------------------------------
 655
 656   ## Sets an attractor on the chosen face. The mesh size will decrease exponentially with the distance from theAttractor, following the rule h(d) = theEndSize - (theEndSize - theStartSize) * exp [ - ( d / theInfluenceDistance ) ^ 2 ]
 657   #  @param theFace      : face on which the attractor will be defined
 658   #  @param theAttractor : geometrical object from which the mesh size "h" decreases exponentially
 659   #  @param theStartSize : mesh size on theAttractor
 660   #  @param theEndSize   : maximum size that will be reached on theFace
 661   #  @param theInfluenceDistance : influence of the attractor ( the size grow slower on theFace if it's high)
 662   #  @param theConstantSizeDistance : distance until which the mesh size will be kept constant on theFace
 663   def SetAttractorGeom(self, theFace, theAttractor, theStartSize, theEndSize, theInfluenceDistance, theConstantSizeDistance):
 664     from salome.smesh.smeshBuilder import AssureGeomPublished
 665     AssureGeomPublished( self.mesh, theFace )
 666     AssureGeomPublished( self.mesh, theAttractor )
 667     self.Parameters().SetAttractorGeom(theFace, theAttractor, theStartSize, theEndSize, theInfluenceDistance, theConstantSizeDistance)
 668     pass
 669
 670   ## Unsets an attractor on the chosen face.
 671   #  @param theFace      : face on which the attractor has to be removed
 672   def UnsetAttractorGeom(self, theFace):
 673     from salome.smesh.smeshBuilder import AssureGeomPublished
 674     AssureGeomPublished( self.mesh, theFace )
 675     self.Parameters().SetAttractorGeom(theFace)
 676     pass
 677
 678   #-----------------------------------------
 679   # Size maps (BLSURF)
 680   #-----------------------------------------
 681
 682   ## To set a size map on a face, edge or vertex (or group, compound) given Python function.
 683   #  If theObject is a face, the function can be: def f(u,v): return u+v
 684   #  If theObject is an edge, the function can be: def f(t): return t/2
 685   #  If theObject is a vertex, the function can be: def f(): return 10
 686   #  @param theObject   : GEOM face, edge or vertex (or group, compound) on which to define a size map
 687   #  @param theSizeMap  : Size map defined as a string
 688   def SetSizeMap(self, theObject, theSizeMap):
 689     from salome.smesh.smeshBuilder import AssureGeomPublished
 690     AssureGeomPublished( self.mesh, theObject )
 691     self.Parameters().SetSizeMap(theObject, theSizeMap)
 692     pass
 693
 694   ## To set a constant size map on a face, edge or vertex (or group, compound).
 695   #  @param theObject   : GEOM face, edge or vertex (or group, compound) on which to define a size map
 696   #  @param theSizeMap  : Size map defined as a double
 697   def SetConstantSizeMap(self, theObject, theSizeMap):
 698     from salome.smesh.smeshBuilder import AssureGeomPublished
 699     AssureGeomPublished( self.mesh, theObject )
 700     self.Parameters().SetConstantSizeMap(theObject, theSizeMap)
 701
 702   ## To remove a size map defined on a face, edge or vertex (or group, compound)
 703   #  @param theObject   : GEOM face, edge or vertex (or group, compound) on which to define a size map
 704   def UnsetSizeMap(self, theObject):
 705     from salome.smesh.smeshBuilder import AssureGeomPublished
 706     AssureGeomPublished( self.mesh, theObject )
 707     self.Parameters().UnsetSizeMap(theObject)
 708     pass
 709
 710   ## To remove all the size maps
 711   def ClearSizeMaps(self):
 712     self.Parameters().ClearSizeMaps()
 713     pass
 714
 715   ## Sets QuadAllowed flag (DEPRECATED: use SetElementType)
 716   #  @param toAllow "allow quadrangles" flag value
 717   # TODO: to remove in Salome 9
 718   def SetQuadAllowed(self, toAllow=True):
 719     self.Parameters().SetQuadAllowed(toAllow)
 720     pass
 721
 722   ## Sets elements type
 723   #  @param theElementType: 0 (Triangles), 1 (QuadrangleDominant), 2 (Quadrangles)
 724   def SetElementType(self, theElementType=Triangles):
 725     self.Parameters().SetElementType(theElementType)
 726     pass
 727
 728   ## Defines hypothesis having several parameters
 729   #  @return hypothesis object
 730   def Parameters(self):
 731     if not self.params:
 732       hypType = "MG-CADSurf Parameters"
 733       hasGeom = self.mesh.GetMesh().HasShapeToMesh()
 734       if hasGeom:
 735         self.params = self.Hypothesis(hypType, [], LIBRARY, UseExisting=0)
 736       else:
 737         self.params = self.Hypothesis(hypType + "_NOGEOM", [], LIBRARY, UseExisting=0)
 738         self.mesh.smeshpyD.SetName( self.params, hypType )
 739       pass
 740     return self.params
 741
 742   #-----------------------------------------
 743   # Periodicity (BLSURF with PreCAD)
 744   #-----------------------------------------
 745
 746   ## Defines periodicity between two groups of faces, using PreCAD
 747   #  @param theFace1 : GEOM face (or group, compound) to associate with theFace2
 748   #  @param theFace2 : GEOM face (or group, compound) associated with theFace1
 749   #  @param theSourceVertices (optionnal): list of GEOM vertices on theFace1 defining the transformation from theFace1 to theFace2.
 750   #    If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
 751   #  @param theTargetVertices (optionnal): list of GEOM vertices on theFace2 defining the transformation from theFace1 to theFace2.
 752   #    If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
 753   def AddPreCadFacesPeriodicity(self, theFace1, theFace2, theSourceVertices=[], theTargetVertices=[]):
 754     """calls preCad function:
 755     status_t cad_add_face_multiple_periodicity_with_transformation_function(cad t *cad,
 756           integer *fid1, integer size1, integer *fid2, integer size2,
 757           periodicity_transformation_t transf, void *user data);
 758     """
 759     if theSourceVertices and theTargetVertices:
 760       self.Parameters().AddPreCadFacesPeriodicityWithVertices(theFace1, theFace2, theSourceVertices, theTargetVertices)
 761     else:
 762       self.Parameters().AddPreCadFacesPeriodicity(theFace1, theFace2)
 763     pass
 764
 765   ## Defines periodicity between two groups of edges, using PreCAD
 766   #  @param theEdge1 : GEOM edge (or group, compound) to associate with theEdge2
 767   #  @param theEdge2 : GEOM edge (or group, compound) associated with theEdge1
 768   #  @param theSourceVertices (optionnal): list of GEOM vertices on theEdge1 defining the transformation from theEdge1 to theEdge2.
 769   #    If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
 770   #  @param  theTargetVertices (optionnal): list of GEOM vertices on theEdge2 defining the transformation from theEdge1 to theEdge2.
 771   #    If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
 772   def AddPreCadEdgesPeriodicity(self, theEdge1, theEdge2, theSourceVertices=[], theTargetVertices=[]):
 773     """calls preCad function:
 774     status_t cad_add_edge_multiple_periodicity_with_transformation_function(cad t *cad,
 775           integer *eid1, integer size1, integer *eid2, integer size2,
 776           periodicity_transformation_t transf, void *user data);
 777     """
 778     if theSourceVertices and theTargetVertices:
 779         self.Parameters().AddPreCadEdgesPeriodicityWithVertices(theEdge1, theEdge2, theSourceVertices, theTargetVertices)
 780     else:
 781         self.Parameters().AddPreCadEdgesPeriodicity(theEdge1, theEdge2)
 782     pass
 783
 784   #-----------------------------------------
 785   # Hyper-Patches
 786   #-----------------------------------------
 787
 788   ## Defines hyper-patches. A hyper-patch is a set of adjacent faces meshed as a whole,
 789   #  ignoring edges between them
 790   #  @param hyperPatchList : list of hyper-patches. A hyper-patch is defined as a list of
 791   #         faces or groups of faces. A face can be identified either as a GEOM object or
 792   #         a face ID (returned e.g. by geompy.GetSubShapeID( mainShape, subShape )).
 793   #
 794   #  Example: cadsurf.SetHyperPatches([[ Face_1, Group_2 ],[ 13, 23 ]])
 795   def SetHyperPatches(self, hyperPatchList):
 796     hpl = []
 797     for patch in hyperPatchList:
 798       ids = []
 799       for face in patch:
 800         if isinstance( face, int ):
 801           ids.append( face )
 802         elif isinstance( face, GEOM._objref_GEOM_Object):
 803           faces = self.mesh.geompyD.SubShapeAll( face, self.mesh.geompyD.ShapeType["FACE"] )
 804           for f in faces:
 805             ids.append( self.mesh.geompyD.GetSubShapeID( self.mesh.geom, f ))
 806         else:
 807           raise TypeError("Face of hyper-patch should be either ID or GEOM_Object, not %s" % type(face))
 808         pass
 809       hpl.append( ids )
 810       pass
 811     self.Parameters().SetHyperPatches( hpl )
 812     return
 813
 814   pass # end of BLSURF_Algorithm class