1 # -*- coding: utf-8 -*-
2 # Copyright (C) 2007-2016 CEA/DEN, EDF R&D
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.
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.
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
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 # @package HYBRIDPluginBuilder
23 # Python API for the HYBRID meshing plug-in module.
25 from salome.smesh.smesh_algorithm import Mesh_Algorithm
26 from salome.smesh.smeshBuilder import AssureGeomPublished
28 # import HYBRIDPlugin module if possible
36 # Optimization level of HYBRID
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
43 Decrease_Collision_Mode, Stop_Collision_Mode = 0,1
45 # Boundary Layers growing inward or outward.
46 Layer_Growth_Inward, Layer_Growth_Outward = 0,1
48 # Mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers).
49 Generation_Tetra_Dominant, Generation_Hexa_Dominant = 0,1
51 #----------------------------
52 # Mesh algo type identifiers
53 #----------------------------
55 ## Algorithm type: HYBRID tetra-hexahedron 3D algorithm, see HYBRID_Algorithm
58 ## Tetrahedron HYBRID 3D algorithm
60 # It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.HYBRID, geom=0 )
61 class HYBRID_Algorithm(Mesh_Algorithm):
63 ## name of the dynamic method in smeshBuilder.Mesh class
65 meshMethod = "Tetrahedron"
66 ## type of algorithm used with helper function in smeshBuilder.Mesh class
69 ## doc string of the method in smeshBuilder.Mesh class
71 docHelper = "Creates tetrahedron 3D algorithm for volumes"
73 ## Private constructor.
74 # @param mesh parent mesh object algorithm is assigned to
75 # @param geom geometry (shape/sub-shape) algorithm is assigned to;
76 # if it is @c 0 (default), the algorithm is assigned to the main shape
77 def __init__(self, mesh, geom=0):
78 Mesh_Algorithm.__init__(self)
79 if noHYBRIDPlugin: print "Warning: HYBRIDPlugin module unavailable"
80 self.Create(mesh, geom, self.algoType, "libHYBRIDEngine.so")
84 ## Defines hypothesis having several parameters
85 # @return hypothesis object
88 self.params = self.Hypothesis("HYBRID_Parameters", [],
89 "libHYBRIDEngine.so", UseExisting=0)
93 ## To mesh layers on all wrap. Default is to mesh.
94 # @param toMesh "mesh layers on all wrap" flag value
95 def SetLayersOnAllWrap(self, toMesh):
96 self.Parameters().SetLayersOnAllWrap(toMesh)
101 ## To mesh "holes" in a solid or not. Default is to mesh.
102 # @param toMesh "mesh holes" flag value
103 def SetToMeshHoles(self, toMesh):
104 self.Parameters().SetToMeshHoles(toMesh)
107 ## To make groups of volumes of different domains when mesh is generated from skin.
108 # Default is to make groups.
109 # This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
110 # @param toMesh "mesh holes" flag value
111 def SetToMakeGroupsOfDomains(self, toMakeGroups):
112 self.Parameters().SetToMakeGroupsOfDomains(toMakeGroups)
115 ## Set Optimization level:
116 # @param level optimization level, one of the following values
117 # - None_Optimization
118 # - Light_Optimization
119 # - Standard_Optimization
120 # - StandardPlus_Optimization
121 # - Strong_Optimization.
123 # Default is Standard_Optimization
124 def SetOptimizationLevel(self, level):
125 self.Parameters().SetOptimizationLevel(level)
128 ## Set maximal size of memory to be used by the algorithm (in Megabytes).
129 # @param MB maximal size of memory
130 def SetMaximumMemory(self, MB):
131 self.Parameters().SetMaximumMemory(MB)
134 ## Set initial size of memory to be used by the algorithm (in Megabytes) in
135 # automatic memory adjustment mode.
136 # @param MB initial size of memory
137 def SetInitialMemory(self, MB):
138 self.Parameters().SetInitialMemory(MB)
142 ## Set Collision Mode:
143 # @param mode Collision Mode, one of the following values
144 # - Decrease_Collision_Mode
145 # - Stop_Collision_Mode
147 # Default is Decrease_Collision_Mode
148 def SetCollisionMode(self, mode):
149 self.Parameters().SetCollisionMode(mode)
152 ## To mesh Boundary Layers growing inward or outward.
153 # @param mode, one of the following values
154 # - Layer_Growth_Inward
155 # - Layer_Growth_Outward
157 # Default is Layer_Growth_Inward
158 def SetBoundaryLayersGrowth(self, mode):
159 self.Parameters().SetBoundaryLayersGrowth(mode)
162 ## To mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers).
163 # @param mode, one of the following values
164 # - Generation_Tetra_Dominant
165 # - Generation_Hexa_Dominant
167 # Default is Generation_Tetra_Dominant
168 def SetElementGeneration(self, mode):
169 self.Parameters().SetElementGeneration(mode)
172 ## To mesh adding extra normals at opening ridges and corners.
174 # @param addMultinormals boolean value
175 def SetAddMultinormals(self, addMultinormals):
176 self.Parameters().SetAddMultinormals(addMultinormals)
179 ## To mesh smoothing normals at closed ridges and corners.
181 # @param smoothNormals boolean value
182 def SetSmoothNormals(self, smoothNormals):
183 self.Parameters().SetSmoothNormals(smoothNormals)
186 ## To set height of the first layer.
188 # @param heightFirstLayer double value
189 def SetHeightFirstLayer(self, heightFirstLayer):
190 self.Parameters().SetHeightFirstLayer(heightFirstLayer)
193 ## To set boundary layers coefficient of geometric progression.
195 # @param boundaryLayersProgression double value
196 def SetBoundaryLayersProgression(self, boundaryLayersProgression):
197 self.Parameters().SetBoundaryLayersProgression(boundaryLayersProgression)
200 ## To set multinormals angle threshold at opening ridges.
202 # @param multinormalsAngle double value
203 def SetMultinormalsAngle(self, multinormalsAngle):
204 self.Parameters().SetMultinormalsAngle(multinormalsAngle)
207 ## To set number of boundary layers.
209 # @param nbOfBoundaryLayers int value
210 def SetNbOfBoundaryLayers(self, nbOfBoundaryLayers):
211 self.Parameters().SetNbOfBoundaryLayers(nbOfBoundaryLayers)
214 ## Set path to working directory.
215 # @param path working directory
216 def SetWorkingDirectory(self, path):
217 self.Parameters().SetWorkingDirectory(path)
220 ## To keep working files or remove them.
221 # @param toKeep "keep working files" flag value
222 def SetKeepFiles(self, toKeep):
223 self.Parameters().SetKeepFiles(toKeep)
226 ## Remove or not the log file (if any) in case of successful computation.
227 # The log file remains in case of errors anyway. If
228 # the "keep working files" flag is set to true, this option
230 # @param toRemove "remove log on success" flag value
231 def SetRemoveLogOnSuccess(self, toRemove):
232 self.Parameters().SetRemoveLogOnSuccess(toRemove)
235 ## Print the the log in a file. If set to false, the
236 # log is printed on the standard output
237 # @param toPrintLogInFile "print log in a file" flag value
238 def SetPrintLogInFile(self, toPrintLogInFile):
239 self.Parameters().SetStandardOutputLog(not toPrintLogInFile)
242 ## Set verbosity level [0-10].
243 # @param level verbosity level
244 # - 0 - no standard output,
245 # - 2 - prints the data, quality statistics of the skin and final meshes and
246 # indicates when the final mesh is being saved. In addition the software
247 # gives indication regarding the CPU time.
248 # - 10 - same as 2 plus the main steps in the computation, quality statistics
249 # histogram of the skin mesh, quality statistics histogram together with
250 # the characteristics of the final mesh.
251 def SetVerboseLevel(self, level):
252 self.Parameters().SetVerboseLevel(level)
255 ## To create new nodes.
256 # @param toCreate "create new nodes" flag value
257 def SetToCreateNewNodes(self, toCreate):
258 self.Parameters().SetToCreateNewNodes(toCreate)
261 ## To use boundary recovery version which tries to create mesh on a very poor
262 # quality surface mesh.
263 # @param toUse "use boundary recovery version" flag value
264 def SetToUseBoundaryRecoveryVersion(self, toUse):
265 self.Parameters().SetToUseBoundaryRecoveryVersion(toUse)
268 ## Applies finite-element correction by replacing overconstrained elements where
269 # it is possible. The process is cutting first the overconstrained edges and
270 # second the overconstrained facets. This insure that no edges have two boundary
271 # vertices and that no facets have three boundary vertices.
272 # @param toUseFem "apply finite-element correction" flag value
273 def SetFEMCorrection(self, toUseFem):
274 self.Parameters().SetFEMCorrection(toUseFem)
277 ## To remove initial central point.
278 # @param toRemove "remove initial central point" flag value
279 def SetToRemoveCentralPoint(self, toRemove):
280 self.Parameters().SetToRemoveCentralPoint(toRemove)
283 ## To set an enforced vertex.
284 # @param x : x coordinate
285 # @param y : y coordinate
286 # @param z : z coordinate
287 # @param size : size of 1D element around enforced vertex
288 # @param vertexName : name of the enforced vertex
289 # @param groupName : name of the group
290 def SetEnforcedVertex(self, x, y, z, size, vertexName = "", groupName = ""):
293 return self.Parameters().SetEnforcedVertex(x, y, z, size)
295 return self.Parameters().SetEnforcedVertexWithGroup(x, y, z, size, groupName)
299 return self.Parameters().SetEnforcedVertexNamed(x, y, z, size, vertexName)
301 return self.Parameters().SetEnforcedVertexNamedWithGroup(x, y, z, size, vertexName, groupName)
305 ## To set an enforced vertex given a GEOM vertex, group or compound.
306 # @param theVertex : GEOM vertex (or group, compound) to be projected on theFace.
307 # @param size : size of 1D element around enforced vertex
308 # @param groupName : name of the group
309 def SetEnforcedVertexGeom(self, theVertex, size, groupName = ""):
310 AssureGeomPublished( self.mesh, theVertex )
312 return self.Parameters().SetEnforcedVertexGeom(theVertex, size)
314 return self.Parameters().SetEnforcedVertexGeomWithGroup(theVertex, size, groupName)
317 ## To remove an enforced vertex.
318 # @param x : x coordinate
319 # @param y : y coordinate
320 # @param z : z coordinate
321 def RemoveEnforcedVertex(self, x, y, z):
322 return self.Parameters().RemoveEnforcedVertex(x, y, z)
324 ## To remove an enforced vertex given a GEOM vertex, group or compound.
325 # @param theVertex : GEOM vertex (or group, compound) to be projected on theFace.
326 def RemoveEnforcedVertexGeom(self, theVertex):
327 AssureGeomPublished( self.mesh, theVertex )
328 return self.Parameters().RemoveEnforcedVertexGeom(theVertex)
330 ## To set an enforced mesh with given size and add the enforced elements in the group "groupName".
331 # @param theSource : source mesh which provides constraint elements/nodes
332 # @param elementType : SMESH.ElementType (NODE, EDGE or FACE)
333 # @param size : size of elements around enforced elements. Unused if -1.
334 # @param groupName : group in which enforced elements will be added. Unused if "".
335 def SetEnforcedMesh(self, theSource, elementType, size = -1, groupName = ""):
338 return self.Parameters().SetEnforcedMesh(theSource, elementType)
340 return self.Parameters().SetEnforcedMeshWithGroup(theSource, elementType, groupName)
344 return self.Parameters().SetEnforcedMeshSize(theSource, elementType, size)
346 return self.Parameters().SetEnforcedMeshSizeWithGroup(theSource, elementType, size, groupName)
350 ## Sets command line option as text.
352 # OBSOLETE. Use SetAdvancedOption()
353 # @param option command line option
354 def SetTextOption(self, option):
355 self.Parameters().SetAdvancedOption(option)
358 ## Sets command line option as text.
359 # @param option command line option
360 def SetAdvancedOption(self, option):
361 self.Parameters().SetAdvancedOption(option)
364 pass # end of HYBRID_Algorithm class