1 # Copyright (C) 2007-2019 CEA/DEN, EDF R&D
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.
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.
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
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # @package BLSURFPluginBuilder
22 # Python API for the MG-CADSurf meshing plug-in module.
24 from salome.smesh.smesh_algorithm import Mesh_Algorithm
27 LIBRARY = "libBLSURFEngine.so"
30 Triangles, QuadrangleDominant, Quadrangles = 0, 1, 2
32 # Topology treatment way of MG-CADSurf
33 FromCAD, PreProcess, PreProcessPlus, PreCAD = 0,1,2,3
35 # Element size flag of MG-CADSurf
36 DefaultSize, DefaultGeom, MG_CADSURF_GlobalSize, MG_CADSURF_LocalSize = 0,0,1,2
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
41 # import BLSURFPlugin module if possible
49 #----------------------------
50 # Mesh algo type identifiers
51 #----------------------------
53 ## Algorithm type: MG-CADSurf triangle algorithm, see BLSURF_Algorithm
54 MG_CADSurf = "MG-CADSurf"
57 #----------------------
59 #----------------------
61 ## MG-CADSurf 2D algorithm.
63 # It can be created by calling smeshBuilder.Mesh.Triangle(smeshBuilder.MG-CADSurf,geom=0)
65 class BLSURF_Algorithm(Mesh_Algorithm):
67 ## name of the dynamic method in smeshBuilder.Mesh class
69 meshMethod = "Triangle"
70 ## type of algorithm used with helper function in smeshBuilder.Mesh class
73 ## doc string of the method
75 docHelper = "Creates triangle algorithm for faces"
77 _anisotropic_ratio = 0
78 _bad_surface_element_aspect_ratio = 1000
79 _geometric_approximation = 22
83 _remove_tiny_edges = 0
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)
92 print("Warning: BLSURFPlugin module unavailable")
93 if mesh.GetMesh().HasShapeToMesh():
94 self.Create(mesh, geom, self.algoType, LIBRARY)
96 self.Create(mesh, geom, self.algoType+"_NOGEOM", LIBRARY)
97 mesh.smeshpyD.SetName( self.algo, self.algoType )
99 self.geompyD = mesh.geompyD
100 #self.SetPhysicalMesh() - PAL19680
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)
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)
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)
130 self.Parameters().SetPhySizeRel(theVal)
132 self.Parameters().SetPhySize(theVal)
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):
140 self.Parameters().SetMinSizeRel(theVal)
142 self.Parameters().SetMinSize(theVal)
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):
150 self.Parameters().SetMaxSizeRel(theVal)
152 self.Parameters().SetMaxSize(theVal)
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)
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)
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)
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)
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)
198 self.Parameters().SetTopology(way)
201 ## Activate/deactivate surface proximity computation
202 # @param toUse boolean flag
204 def SetSurfaceProximity(self, toUse ):
205 self.Parameters().SetSurfaceProximity(toUse)
208 ## Set number of surface element layers to be generated due to surface proximity
209 # @param nbLayers number of layers
211 def SetNbSurfaceProximityLayers(self, nbLayers ):
212 self.Parameters().SetNbSurfaceProximityLayers( nbLayers )
215 ## Set coefficient by which size of element refined due to surface proximity is increased
216 # @param ratio proximity coefficient
218 def SetSurfaceProximityRatio(self, ratio ):
219 self.Parameters().SetSurfaceProximityRatio(ratio)
222 ## Activate/deactivate volume proximity computation
223 # @param toUse boolean flag
225 def SetVolumeProximity(self, toUse ):
226 self.Parameters().SetVolumeProximity(toUse)
229 ## Set number of surface element layers to be generated due to volume proximity
230 # @param nbLayers number of layers
232 def SetNbVolumeProximityLayers(self, nbLayers ):
233 self.Parameters().SetNbVolumeProximityLayers(nbLayers)
236 ## Set coefficient by which size of element refined due to volume proximity is increased
237 # @param ratio proximity coefficient
239 def SetVolumeProximityRatio(self, ratio ):
240 self.Parameters().SetVolumeProximityRatio(ratio)
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)
250 ## Set enforce_cad_edge_sizes parameter
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.
256 def SetEnforceCadEdgesSize( self, toEnforce ):
257 self.Parameters().SetEnforceCadEdgesSize( toEnforce )
259 ## Set jacobian_rectification_respect_geometry parameter
261 # While making the mesh quadratic, allows to lose the CAD-mesh associativity in order
262 # to correct elements with nagative Jacobian
264 def SetJacobianRectificationRespectGeometry( self, allowRectification ):
265 self.Parameters().SetJacobianRectificationRespectGeometry( allowRectification )
267 ## Set rectify_jacobian parameter
269 # While making the mesh quadratic, allow to fix nagative Jacobian surface elements
271 def SetJacobianRectification( self, allowRectification ):
272 self.Parameters().SetJacobianRectification( allowRectification )
274 ## Set use_deprecated_patch_mesher parameter (compatibility with older versions of Meshgems)
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)
279 def SetUseDeprecatedPatchMesher( self, useDeprecatedPatchMesher ):
280 self.Parameters().SetUseDeprecatedPatchMesher( useDeprecatedPatchMesher )
282 ## Set respect_geometry parameter
284 # This patch independent option can be deactivated to allow MeshGems-CADSurf
285 # to lower the geometry accuracy in its patch independent process.
287 def SetRespectGeometry( self, toRespect ):
288 self.Parameters().SetRespectGeometry( toRespect )
290 ## Set max_number_of_points_per_patch parameter
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
296 def SetMaxNumberOfPointsPerPatch( self, nb ):
297 if not version_less(self.Parameters().GetMeshGemsVersion(), '2.10'):
298 print("Warning: method SetMaxNumberOfPointsPerPatch() is deprecated")
299 self.Parameters().SetMaxNumberOfPointsPerPatch( nb )
301 ## Set max_number_of_threads parameter
303 # Set the maximum of threads to use for multithreading mesh computation
305 def SetMaxNumberOfThreads( self, nb ):
306 self.Parameters().SetMaxNumberOfThreads( nb )
308 ## Set respect_geometry parameter
310 # This patch independent option can be deactivated to allow MeshGems-CADSurf
311 # to lower the geometry accuracy in its patch independent process.
313 def SetRespectGeometry( self, toRespect ):
314 self.Parameters().SetRespectGeometry( toRespect )
316 ## Set tiny_edges_avoid_surface_intersections parameter
318 # This option defines the priority between the tiny feature
319 # suppression and the surface intersection prevention.
321 def SetTinyEdgesAvoidSurfaceIntersections( self, toAvoidIntersection ):
322 self.Parameters().SetTinyEdgesAvoidSurfaceIntersections( toAvoidIntersection )
324 ## Set closed_geometry parameter parameter
326 # Describes whether the geometry is expected to be closed or not.
327 # When activated, this option helps MeshGems-PreCAD to treat the dirtiest geometries.
329 def SetClosedGeometry( self, isClosed ):
330 self.Parameters().SetClosedGeometry( isClosed )
332 ## Set debug parameter
334 # Make MeshGems-CADSurf will be very verbose and will output some intermediate
335 # files in the working directory. This option is mainly meant for Distene support issues.
337 def SetDebug( self, isDebug ):
338 self.Parameters().SetDebug( isDebug )
340 ## Set periodic_tolerance parameter
342 # This parameter defines the maximum size difference between two periodic edges
343 # and also the maximum distance error between two periodic entities.
345 def SetPeriodicTolerance( self, tol ):
346 self.Parameters().SetPeriodicTolerance( tol )
348 ## Set required_entities parameter
350 # The required entities control the correction operations.
351 # Accepted values for this parameter are :
352 # - "respect" : MeshGems-CADSurf is not allowed to alter any required entity,
353 # even for correction purposes,
354 # - "ignore" : MeshGems-CADSurf will ignore the required entities in its processing,
355 # - "clear" : MeshGems-CADSurf will clear any required status for the entities.
356 # There will not be any entity marked as required in the generated mesh.
358 def SetRequiredEntities( self, howToTreat ):
359 self.Parameters().SetRequiredEntities( howToTreat )
361 ## Set sewing_tolerance parameter
363 # This parameter is the tolerance of the assembly.
365 def SetSewingTolerance( self, tol ):
366 self.Parameters().SetSewingTolerance( tol )
368 ## Set tags parameter
370 # The tag (attribute) system controls the optimisation process.
371 # Accepted values for this parameter are :
372 # - "respect" : the CAD tags will be preserved and unaltered by the optimisation operations,
373 # - "ignore" : the CAD tags will be ignored by the optimisation operations
374 # but they will still be present in the output mesh,
375 # - "clear" : MeshGems-CADSurf will clear any tag on any entity and optimise accordingly.
376 # There will not be any tag in the generated mesh.
378 def SetTags( self, howToTreat ):
379 self.Parameters().SetTags( howToTreat )
381 ## Activate/deactivate fully patch independent meshing
382 # @param isIndependent boolean flag
384 # This feature can only be used if the @a tags parameter is set to "respect".
385 # By default this option deactivated.
387 def SetPatchIndependent( self, isIndependent ):
388 self.SetOptionValue( "allow_patch_independent", "yes" if isIndependent else "no" )
390 ## Set to preserve lines defined by a sharp angle in the input discrete geometry
391 # @param toCompute boolean flag
393 # If this option is deactivated, MeshGems-CADSurf will not try to preserve lines
394 # defined by a sharp angle in the input discrete geometry. Only input ridges, free
395 # edges, non manifold edges and separation betwen zones with different attributes
396 # will be respected (if tags is set to respect).
397 # By default this option activated.
399 def SetComputeRidges( self, toCompute ):
400 self.SetOptionValue( "compute_ridges", "yes" if toCompute else "no" )
403 ## Activate removal of the tiny edges from the generated
404 # mesh when it improves the local mesh quality, without taking into account the
405 # tags (attributes) specifications.
406 # @param toOptimise "to optimize" flag value
407 # @param length minimal length under which an edge is considered to be a tiny
408 def SetOptimiseTinyEdges(self, toOptimise, length=-1):
409 self.Parameters().SetOptimiseTinyEdges( toOptimise )
411 self.Parameters().SetTinyEdgeOptimisationLength( length )
413 ## Activate correction of all surface intersections
414 # @param toCorrect "to correct" flag value
415 # @param maxCost the time the user is ready to spend in the intersection prevention process
416 # For example, maxCost = 3 means that MeshGems-CADSurf will not spend more time
417 # in the intersection removal process than 3 times the time required to mesh
418 # without processing the intersections.
419 def SetCorrectSurfaceIntersection(self, toCorrect, maxCost ):
420 self.Parameters().SetCorrectSurfaceIntersection( toCorrect )
422 self.Parameters().SetCorrectSurfaceIntersectionMaxCost( maxCost )
424 ## To optimize merges edges.
425 # @param toMergeEdges "merge edges" flag value
426 def SetPreCADMergeEdges(self, toMergeEdges=False):
427 self.Parameters().SetPreCADMergeEdges(toMergeEdges)
430 ## To remove duplicate CAD Faces
431 # @param toRemoveDuplicateCADFaces "remove_duplicate_cad_faces" flag value
432 def SetPreCADRemoveDuplicateCADFaces(self, toRemoveDuplicateCADFaces=False):
433 self.Parameters().SetPreCADRemoveDuplicateCADFaces(toRemoveDuplicateCADFaces)
436 ## To process 3D topology.
437 # @param toProcess "PreCAD process 3D" flag value
438 def SetPreCADProcess3DTopology(self, toProcess=False):
439 self.Parameters().SetPreCADProcess3DTopology(toProcess)
442 ## To remove nano edges.
443 # @param toRemoveNanoEdges "remove nano edges" flag value
444 def SetPreCADRemoveNanoEdges(self, toRemoveNanoEdges=False):
445 if toRemoveNanoEdges:
446 self.SetPreCADOptionValue("remove_tiny_edges","1")
448 self.SetPreCADOptionValue("remove_tiny_edges","0")
451 ## To compute topology from scratch
452 # @param toDiscardInput "discard input" flag value
453 def SetPreCADDiscardInput(self, toDiscardInput=False):
454 self.Parameters().SetPreCADDiscardInput(toDiscardInput)
457 ## Sets the length below which an edge is considered as nano
458 # for the topology processing.
459 # @param epsNano nano edge length threshold value
460 def SetPreCADEpsNano(self, epsNano):
461 self.SetPreCADOptionValue("tiny_edge_length","%f"%epsNano)
464 ## Sets advanced option value.
465 # @param optionName advanced option name
466 # @param level advanced option value
467 def SetOptionValue(self, optionName, level):
468 self.Parameters().SetOptionValue(optionName,level)
471 ## Sets advanced PreCAD option value.
472 # @param optionName name of the option
473 # @param optionValue value of the option
474 def SetPreCADOptionValue(self, optionName, optionValue):
475 self.Parameters().SetPreCADOptionValue(optionName,optionValue)
478 ## Adds custom advanced option values
479 # @param optionsAndValues options and values in a form "option_1 v1 option_2 v2'"
480 def SetAdvancedOption(self, optionsAndValues):
481 self.Parameters().SetAdvancedOption(optionsAndValues)
484 ## Adds custom advanced option value.
485 # @param optionName custom advanced option name
486 # @param level custom advanced option value
487 def AddOption(self, optionName, level):
488 self.Parameters().AddOption(optionName,level)
491 ## Adds custom advanced PreCAD option value.
492 # @param optionName custom name of the option
493 # @param optionValue value of the option
494 def AddPreCADOption(self, optionName, optionValue):
495 self.Parameters().AddPreCADOption(optionName,optionValue)
498 ## Sets GMF file for export at computation
499 # @param fileName GMF file name
500 def SetGMFFile(self, fileName):
501 self.Parameters().SetGMFFile(fileName)
504 #-----------------------------------------
505 # Enforced vertices (BLSURF)
506 #-----------------------------------------
508 ## To get all the enforced vertices
509 def GetAllEnforcedVertices(self):
510 return self.Parameters().GetAllEnforcedVertices()
512 ## To get all the enforced vertices sorted by face (or group, compound)
513 def GetAllEnforcedVerticesByFace(self):
514 return self.Parameters().GetAllEnforcedVerticesByFace()
516 ## To get all the enforced vertices sorted by coords of input vertices
517 def GetAllEnforcedVerticesByCoords(self):
518 return self.Parameters().GetAllEnforcedVerticesByCoords()
520 ## To get all the coords of input vertices sorted by face (or group, compound)
521 def GetAllCoordsByFace(self):
522 return self.Parameters().GetAllCoordsByFace()
524 ## To get all the enforced vertices on a face (or group, compound)
525 # @param theFace : GEOM face (or group, compound) on which to define an enforced vertex
526 def GetEnforcedVertices(self, theFace):
527 from salome.smesh.smeshBuilder import AssureGeomPublished
528 AssureGeomPublished( self.mesh, theFace )
529 return self.Parameters().GetEnforcedVertices(theFace)
531 ## To clear all the enforced vertices
532 def ClearAllEnforcedVertices(self):
533 return self.Parameters().ClearAllEnforcedVertices()
535 ## 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.
536 # @param theFace : GEOM face (or group, compound) on which to define an enforced vertex
537 # @param x : x coordinate
538 # @param y : y coordinate
539 # @param z : z coordinate
540 # @param vertexName : name of the enforced vertex
541 # @param groupName : name of the group
542 def SetEnforcedVertex(self, theFace, x, y, z, vertexName = "", groupName = ""):
543 from salome.smesh.smeshBuilder import AssureGeomPublished
544 AssureGeomPublished( self.mesh, theFace )
547 return self.Parameters().SetEnforcedVertex(theFace, x, y, z)
549 return self.Parameters().SetEnforcedVertexWithGroup(theFace, x, y, z, groupName)
553 return self.Parameters().SetEnforcedVertexNamed(theFace, x, y, z, vertexName)
555 return self.Parameters().SetEnforcedVertexNamedWithGroup(theFace, x, y, z, vertexName, groupName)
559 ## To set an enforced vertex on a face (or group, compound) given a GEOM vertex, group or compound.
560 # @param theFace : GEOM face (or group, compound) on which to define an enforced vertex
561 # @param theVertex : GEOM vertex (or group, compound) to be projected on theFace.
562 # @param groupName : name of the group
563 def SetEnforcedVertexGeom(self, theFace, theVertex, groupName = ""):
564 from salome.smesh.smeshBuilder import AssureGeomPublished
565 AssureGeomPublished( self.mesh, theFace )
566 AssureGeomPublished( self.mesh, theVertex )
568 return self.Parameters().SetEnforcedVertexGeom(theFace, theVertex)
570 return self.Parameters().SetEnforcedVertexGeomWithGroup(theFace, theVertex,groupName)
573 ## Set an enforced vertex on a face given the coordinates of a point.
574 # The face if found by the application.
575 # @param x : x coordinate
576 # @param y : y coordinate
577 # @param z : z coordinate
578 # @param vertexName : name of the enforced vertex
579 # @param groupName : name of the group
580 def AddEnforcedVertex(self, x, y, z, vertexName = "", groupName = ""):
581 from salome.smesh.smeshBuilder import AssureGeomPublished
584 return self.Parameters().AddEnforcedVertex(x, y, z)
586 return self.Parameters().AddEnforcedVertexWithGroup(x, y, z, groupName)
590 return self.Parameters().AddEnforcedVertexNamed(x, y, z, vertexName)
592 return self.Parameters().AddEnforcedVertexNamedWithGroup( x, y, z, vertexName, groupName)
596 ## To set an enforced vertex on a face given a GEOM vertex, group or compound.
597 # The face if found by the application.
598 # @param theVertex : GEOM vertex (or group, compound).
599 # @param groupName : name of the group
600 def AddEnforcedVertexGeom(self, theVertex, groupName = ""):
601 from salome.smesh.smeshBuilder import AssureGeomPublished
602 AssureGeomPublished( self.mesh, theVertex )
604 return self.Parameters().AddEnforcedVertexGeom(theVertex)
606 return self.Parameters().AddEnforcedVertexGeomWithGroup(theVertex,groupName)
609 ## To remove an enforced vertex on a given GEOM face (or group, compound) given the coordinates.
610 # @param theFace : GEOM face (or group, compound) on which to remove the enforced vertex
611 # @param x : x coordinate
612 # @param y : y coordinate
613 # @param z : z coordinate
614 def UnsetEnforcedVertex(self, theFace, x, y, z):
615 from salome.smesh.smeshBuilder import AssureGeomPublished
616 AssureGeomPublished( self.mesh, theFace )
617 return self.Parameters().UnsetEnforcedVertex(theFace, x, y, z)
619 ## To remove an enforced vertex on a given GEOM face (or group, compound) given a GEOM vertex, group or compound.
620 # @param theFace : GEOM face (or group, compound) on which to remove the enforced vertex
621 # @param theVertex : GEOM vertex (or group, compound) to remove.
622 def UnsetEnforcedVertexGeom(self, theFace, theVertex):
623 from salome.smesh.smeshBuilder import AssureGeomPublished
624 AssureGeomPublished( self.mesh, theFace )
625 AssureGeomPublished( self.mesh, theVertex )
626 return self.Parameters().UnsetEnforcedVertexGeom(theFace, theVertex)
628 ## To remove all enforced vertices on a given face.
629 # @param theFace : face (or group/compound of faces) on which to remove all enforced vertices
630 def UnsetEnforcedVertices(self, theFace):
631 from salome.smesh.smeshBuilder import AssureGeomPublished
632 AssureGeomPublished( self.mesh, theFace )
633 return self.Parameters().UnsetEnforcedVertices(theFace)
635 ## To tell BLSURF to add a node on internal vertices
636 # @param toEnforceInternalVertices : boolean; if True the internal vertices are added as enforced vertices
637 def SetInternalEnforcedVertexAllFaces(self, toEnforceInternalVertices):
638 return self.Parameters().SetInternalEnforcedVertexAllFaces(toEnforceInternalVertices)
640 ## To know if BLSURF will add a node on internal vertices
641 def GetInternalEnforcedVertexAllFaces(self):
642 return self.Parameters().GetInternalEnforcedVertexAllFaces()
644 ## To define a group for the nodes of internal vertices
645 # @param groupName : string; name of the group
646 def SetInternalEnforcedVertexAllFacesGroup(self, groupName):
647 return self.Parameters().SetInternalEnforcedVertexAllFacesGroup(groupName)
649 ## To get the group name of the nodes of internal vertices
650 def GetInternalEnforcedVertexAllFacesGroup(self):
651 return self.Parameters().GetInternalEnforcedVertexAllFacesGroup()
653 #-----------------------------------------
655 #-----------------------------------------
657 ## 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 ]
658 # @param theFace : face on which the attractor will be defined
659 # @param theAttractor : geometrical object from which the mesh size "h" decreases exponentially
660 # @param theStartSize : mesh size on theAttractor
661 # @param theEndSize : maximum size that will be reached on theFace
662 # @param theInfluenceDistance : influence of the attractor ( the size grow slower on theFace if it's high)
663 # @param theConstantSizeDistance : distance until which the mesh size will be kept constant on theFace
664 def SetAttractorGeom(self, theFace, theAttractor, theStartSize, theEndSize, theInfluenceDistance, theConstantSizeDistance):
665 from salome.smesh.smeshBuilder import AssureGeomPublished
666 AssureGeomPublished( self.mesh, theFace )
667 AssureGeomPublished( self.mesh, theAttractor )
668 self.Parameters().SetAttractorGeom(theFace, theAttractor, theStartSize, theEndSize, theInfluenceDistance, theConstantSizeDistance)
671 ## Unsets an attractor on the chosen face.
672 # @param theFace : face on which the attractor has to be removed
673 def UnsetAttractorGeom(self, theFace):
674 from salome.smesh.smeshBuilder import AssureGeomPublished
675 AssureGeomPublished( self.mesh, theFace )
676 self.Parameters().SetAttractorGeom(theFace)
679 #-----------------------------------------
681 #-----------------------------------------
683 ## To set a size map on a face, edge or vertex (or group, compound) given Python function.
684 # If theObject is a face, the function can be: def f(u,v): return u+v
685 # If theObject is an edge, the function can be: def f(t): return t/2
686 # If theObject is a vertex, the function can be: def f(): return 10
687 # @param theObject : GEOM face, edge or vertex (or group, compound) on which to define a size map
688 # @param theSizeMap : Size map defined as a string
689 def SetSizeMap(self, theObject, theSizeMap):
690 from salome.smesh.smeshBuilder import AssureGeomPublished
691 AssureGeomPublished( self.mesh, theObject )
692 self.Parameters().SetSizeMap(theObject, theSizeMap)
695 ## To set a constant size map on a face, edge or vertex (or group, compound).
696 # @param theObject : GEOM face, edge or vertex (or group, compound) on which to define a size map
697 # @param theSizeMap : Size map defined as a double
698 def SetConstantSizeMap(self, theObject, theSizeMap):
699 from salome.smesh.smeshBuilder import AssureGeomPublished
700 AssureGeomPublished( self.mesh, theObject )
701 self.Parameters().SetConstantSizeMap(theObject, theSizeMap)
703 ## To remove a size map defined on a face, edge or vertex (or group, compound)
704 # @param theObject : GEOM face, edge or vertex (or group, compound) on which to define a size map
705 def UnsetSizeMap(self, theObject):
706 from salome.smesh.smeshBuilder import AssureGeomPublished
707 AssureGeomPublished( self.mesh, theObject )
708 self.Parameters().UnsetSizeMap(theObject)
711 ## To remove all the size maps
712 def ClearSizeMaps(self):
713 self.Parameters().ClearSizeMaps()
716 ## Sets QuadAllowed flag (DEPRECATED: use SetElementType)
717 # @param toAllow "allow quadrangles" flag value
718 # TODO: to remove in Salome 9
719 def SetQuadAllowed(self, toAllow=True):
720 self.Parameters().SetQuadAllowed(toAllow)
723 ## Sets elements type
724 # @param theElementType: 0 (Triangles), 1 (QuadrangleDominant), 2 (Quadrangles)
725 def SetElementType(self, theElementType=Triangles):
726 self.Parameters().SetElementType(theElementType)
729 ## Defines hypothesis having several parameters
730 # @return hypothesis object
731 def Parameters(self):
733 hypType = "MG-CADSurf Parameters"
734 hasGeom = self.mesh.GetMesh().HasShapeToMesh()
736 self.params = self.Hypothesis(hypType, [], LIBRARY, UseExisting=0)
738 self.params = self.Hypothesis(hypType + "_NOGEOM", [], LIBRARY, UseExisting=0)
739 self.mesh.smeshpyD.SetName( self.params, hypType )
743 #-----------------------------------------
744 # Periodicity (BLSURF with PreCAD)
745 #-----------------------------------------
747 ## Defines periodicity between two groups of faces, using PreCAD
748 # @param theFace1 : GEOM face (or group, compound) to associate with theFace2
749 # @param theFace2 : GEOM face (or group, compound) associated with theFace1
750 # @param theSourceVertices (optionnal): list of GEOM vertices on theFace1 defining the transformation from theFace1 to theFace2.
751 # If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
752 # @param theTargetVertices (optionnal): list of GEOM vertices on theFace2 defining the transformation from theFace1 to theFace2.
753 # If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
754 def AddPreCadFacesPeriodicity(self, theFace1, theFace2, theSourceVertices=[], theTargetVertices=[]):
755 """calls preCad function:
756 status_t cad_add_face_multiple_periodicity_with_transformation_function(cad t *cad,
757 integer *fid1, integer size1, integer *fid2, integer size2,
758 periodicity_transformation_t transf, void *user data);
760 if theSourceVertices and theTargetVertices:
761 self.Parameters().AddPreCadFacesPeriodicityWithVertices(theFace1, theFace2, theSourceVertices, theTargetVertices)
763 self.Parameters().AddPreCadFacesPeriodicity(theFace1, theFace2)
766 ## Defines periodicity between two groups of edges, using PreCAD
767 # @param theEdge1 : GEOM edge (or group, compound) to associate with theEdge2
768 # @param theEdge2 : GEOM edge (or group, compound) associated with theEdge1
769 # @param theSourceVertices (optionnal): list of GEOM vertices on theEdge1 defining the transformation from theEdge1 to theEdge2.
770 # If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
771 # @param theTargetVertices (optionnal): list of GEOM vertices on theEdge2 defining the transformation from theEdge1 to theEdge2.
772 # If None, PreCAD tries to find a simple translation. Else, need at least 3 not aligned vertices.
773 def AddPreCadEdgesPeriodicity(self, theEdge1, theEdge2, theSourceVertices=[], theTargetVertices=[]):
774 """calls preCad function:
775 status_t cad_add_edge_multiple_periodicity_with_transformation_function(cad t *cad,
776 integer *eid1, integer size1, integer *eid2, integer size2,
777 periodicity_transformation_t transf, void *user data);
779 if theSourceVertices and theTargetVertices:
780 self.Parameters().AddPreCadEdgesPeriodicityWithVertices(theEdge1, theEdge2, theSourceVertices, theTargetVertices)
782 self.Parameters().AddPreCadEdgesPeriodicity(theEdge1, theEdge2)
785 #-----------------------------------------
787 #-----------------------------------------
789 ## Defines hyper-patches. A hyper-patch is a set of adjacent faces meshed as a whole,
790 # ignoring edges between them
791 # @param hyperPatchList : list of hyper-patches. A hyper-patch is defined as a list of
792 # faces or groups of faces. A face can be identified either as a GEOM object or
793 # a face ID (returned e.g. by geompy.GetSubShapeID( mainShape, subShape )).
795 # Example: cadsurf.SetHyperPatches([[ Face_1, Group_2 ],[ 13, 23 ]])
796 def SetHyperPatches(self, hyperPatchList):
798 for patch in hyperPatchList:
801 if isinstance( face, int ):
803 elif isinstance( face, GEOM._objref_GEOM_Object):
804 faces = self.mesh.geompyD.SubShapeAll( face, self.mesh.geompyD.ShapeType["FACE"] )
806 ids.append( self.mesh.geompyD.GetSubShapeID( self.mesh.geom, f ))
808 raise TypeError("Face of hyper-patch should be either ID or GEOM_Object, not %s" % type(face))
812 self.Parameters().SetHyperPatches( hpl )
815 pass # end of BLSURF_Algorithm class
817 def version_less(version: str, ref_version: str):
819 return [int(i) for i in split('[.-]', version)] < [int(i) for i in re.split('[.-]', ref_version)]