HYBRID_Algorithm Class Reference

MG-Hybrid 3D algorithm. More...

Inheritance diagram for HYBRID_Algorithm:

Public Member Functions
def	__init__
	Private constructor. More...
def	Parameters
	Defines hypothesis having several parameters. More...
def	SetLayersOnAllWrap
	To mesh layers on all wrap. More...
def	SetFacesWithLayers
	To mesh layers on given faces. More...
def	SetFacesWithImprinting
	To imprint the layers on given faces. More...
def	SetCollisionMode
	Set Collision Mode: More...
def	SetBoundaryLayersGrowth
	To mesh Boundary Layers growing inward or outward. More...
def	SetElementGeneration
	To mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers). More...
def	SetAddMultinormals
	To mesh adding extra normals at opening ridges and corners. More...
def	SetSmoothNormals
	To mesh smoothing normals at closed ridges and corners. More...
def	SetHeightFirstLayer
	To set height of the first layer. More...
def	SetBoundaryLayersProgression
	To set boundary layers coefficient of geometric progression. More...
def	SetCoreSize
	Set core elements size. More...
def	SetMultinormalsAngle
	To set multinormals angle threshold at opening ridges. More...
def	SetNbOfBoundaryLayers
	To set number of boundary layers. More...
def	SetWorkingDirectory
	Set path to working directory. More...
def	SetKeepFiles
	To keep working files or remove them. More...
def	SetRemoveLogOnSuccess
	Remove or not the log file (if any) in case of successful computation. More...
def	SetPrintLogInFile
	Print the the log in a file. More...
def	SetVerboseLevel
	Set verbosity level [0-10]. More...
def	SetToCreateNewNodes
	To create new nodes. More...
def	SetToUseBoundaryRecoveryVersion
	To use boundary recovery version which tries to create mesh on a very poor quality surface mesh. More...
def	SetFEMCorrection
	Applies finite-element correction by replacing overconstrained elements where it is possible. More...
def	SetToRemoveCentralPoint
	To remove initial central point. More...
def	SetEnforcedVertex
	To set an enforced vertex. More...
def	SetEnforcedVertexGeom
	To set an enforced vertex given a GEOM vertex, group or compound. More...
def	RemoveEnforcedVertex
	To remove an enforced vertex. More...
def	RemoveEnforcedVertexGeom
	To remove an enforced vertex given a GEOM vertex, group or compound. More...
def	SetEnforcedMesh
	To set an enforced mesh with given size and add the enforced elements in the group "groupName". More...
def	SetTextOption
	Sets command line option as text. More...
def	SetAdvancedOption
	Sets command line option as text. More...

Data Fields
	params

Static Public Attributes
string	meshMethod = "Tetrahedron"
	name of the dynamic method in smeshBuilder.Mesh class More...
	algoType = MG_Hybrid
	type of algorithm used with helper function in smeshBuilder.Mesh class More...
string	docHelper = "Creates tetrahedron 3D algorithm for volumes"
	doc string of the method in smeshBuilder.Mesh class More...

Detailed Description

MG-Hybrid 3D algorithm.

It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.HYBRID, geom=0 )

Constructor & Destructor Documentation

def __init__	(		self,
			mesh,
			geom = 0
	)

Private constructor.

Parameters

mesh	parent mesh object algorithm is assigned to
geom	geometry (shape/sub-shape) algorithm is assigned to; if it is 0 (default), the algorithm is assigned to the main shape

References HYBRID_Algorithm.algoType, and Mesh_Algorithm.Create().

Member Function Documentation

def Parameters

(

self

)

Defines hypothesis having several parameters.

Returns

hypothesis object

References Mesh_Algorithm.Hypothesis(), and HYBRID_Algorithm.params.

def SetLayersOnAllWrap	(		self,
			toMesh
	)

To mesh layers on all wrap.

Default is to mesh.

Parameters

toMesh

"mesh layers on all wrap" flag value

References HYBRID_Algorithm.Parameters().

def SetFacesWithLayers	(		self,
			faceIDs
	)

To mesh layers on given faces.

Parameters

faceIDs

faces or face IDs to construct boundary layers on

References HYBRID_Algorithm.Parameters(), and HYBRID_Algorithm.SetLayersOnAllWrap().

def SetFacesWithImprinting	(		self,
			faceIDs
	)

To imprint the layers on given faces.

Parameters

faceIDs

faces or face IDs to imprint the boundary layers on

References HYBRID_Algorithm.Parameters(), and HYBRID_Algorithm.SetLayersOnAllWrap().

def SetCollisionMode	(		self,
			mode
	)

Set Collision Mode:

Parameters

mode	Collision Mode, one of the following values Decrease_Collision_Mode Stop_Collision_Mode Default is Decrease_Collision_Mode

References HYBRID_Algorithm.Parameters().

def SetBoundaryLayersGrowth	(		self,
			mode
	)

To mesh Boundary Layers growing inward or outward.

Parameters

mode,one

of the following values Layer_Growth_Inward Layer_Growth_Outward Default is Layer_Growth_Inward

References HYBRID_Algorithm.Parameters().

def SetElementGeneration	(		self,
			mode
	)

To mesh with element type Tetra Dominant or hexa Dominant in the remaining volume (outside layers).

Parameters

mode,one

of the following values Generation_Tetra_Dominant Generation_Hexa_Dominant Generation_Cartesian_Core Default is Generation_Tetra_Dominant

References HYBRID_Algorithm.Parameters().

def SetAddMultinormals	(		self,
			addMultinormals
	)

To mesh adding extra normals at opening ridges and corners.

Default is no.

Parameters

addMultinormals

boolean value

References HYBRID_Algorithm.Parameters().

def SetSmoothNormals	(		self,
			smoothNormals
	)

To mesh smoothing normals at closed ridges and corners.

Default is no.

Parameters

smoothNormals

boolean value

References HYBRID_Algorithm.Parameters().

def SetHeightFirstLayer	(		self,
			heightFirstLayer
	)

To set height of the first layer.

Default is 0.0

Parameters

heightFirstLayer

double value

References HYBRID_Algorithm.Parameters().

def SetBoundaryLayersProgression	(		self,
			boundaryLayersProgression
	)

To set boundary layers coefficient of geometric progression.

Default is 1.0

Parameters

boundaryLayersProgression

double value

References HYBRID_Algorithm.Parameters().

def SetCoreSize	(		self,
			CoreSize
	)

Set core elements size.

Default is 0.0

Parameters

CoreSize

double value

References HYBRID_Algorithm.Parameters().

def SetMultinormalsAngle	(		self,
			multinormalsAngle
	)

To set multinormals angle threshold at opening ridges.

Default is 30.0

Parameters

multinormalsAngle

double value

References HYBRID_Algorithm.Parameters().

def SetNbOfBoundaryLayers	(		self,
			nbOfBoundaryLayers
	)

To set number of boundary layers.

Default is 1

Parameters

nbOfBoundaryLayers

int value

References HYBRID_Algorithm.Parameters().

def SetWorkingDirectory	(		self,
			path
	)

Set path to working directory.

Parameters

path	working directory

References HYBRID_Algorithm.Parameters().

def SetKeepFiles	(		self,
			toKeep
	)

To keep working files or remove them.

Parameters

toKeep

"keep working files" flag value

References HYBRID_Algorithm.Parameters().

def SetRemoveLogOnSuccess	(		self,
			toRemove
	)

Remove or not the log file (if any) in case of successful computation.

The log file remains in case of errors anyway. If the "keep working files" flag is set to true, this option has no effect.

Parameters

toRemove

"remove log on success" flag value

References HYBRID_Algorithm.Parameters().

def SetPrintLogInFile	(		self,
			toPrintLogInFile
	)

Print the the log in a file.

If set to false, the log is printed on the standard output

Parameters

toPrintLogInFile

"print log in a file" flag value

References HYBRID_Algorithm.Parameters().

def SetVerboseLevel	(		self,
			level
	)

Set verbosity level [0-10].

Parameters

level

verbosity level 0 - no standard output, 2 - prints the data, quality statistics of the skin and final meshes and indicates when the final mesh is being saved. In addition the software gives indication regarding the CPU time. 10 - same as 2 plus the main steps in the computation, quality statistics histogram of the skin mesh, quality statistics histogram together with the characteristics of the final mesh.

References HYBRID_Algorithm.Parameters().

def SetToCreateNewNodes	(		self,
			toCreate
	)

To create new nodes.

Parameters

toCreate

"create new nodes" flag value

References HYBRID_Algorithm.Parameters().

def SetToUseBoundaryRecoveryVersion	(		self,
			toUse
	)

To use boundary recovery version which tries to create mesh on a very poor quality surface mesh.

Parameters

toUse

"use boundary recovery version" flag value

References HYBRID_Algorithm.Parameters().

def SetFEMCorrection	(		self,
			toUseFem
	)

Applies finite-element correction by replacing overconstrained elements where it is possible.

The process is cutting first the overconstrained edges and second the overconstrained facets. This insure that no edges have two boundary vertices and that no facets have three boundary vertices.

Parameters

toUseFem

"apply finite-element correction" flag value

References HYBRID_Algorithm.Parameters().

def SetToRemoveCentralPoint	(		self,
			toRemove
	)

To remove initial central point.

Parameters

toRemove

"remove initial central point" flag value

References HYBRID_Algorithm.Parameters().

def SetEnforcedVertex	(		self,
			x,
			y,
			z,
			size,
			vertexName = "",
			groupName = ""
	)

To set an enforced vertex.

Parameters

x	: x coordinate
y	: y coordinate
z	: z coordinate
size	: size of 1D element around enforced vertex
vertexName	: name of the enforced vertex
groupName	: name of the group

References HYBRID_Algorithm.Parameters().

def SetEnforcedVertexGeom	(		self,
			theVertex,
			size,
			groupName = ""
	)

To set an enforced vertex given a GEOM vertex, group or compound.

Parameters

theVertex	: GEOM vertex (or group, compound) to be projected on theFace.
size	: size of 1D element around enforced vertex
groupName	: name of the group

References Mesh_Algorithm.mesh, and HYBRID_Algorithm.Parameters().

def RemoveEnforcedVertex	(		self,
			x,
			y,
			z
	)

To remove an enforced vertex.

Parameters

x	: x coordinate
y	: y coordinate
z	: z coordinate

References HYBRID_Algorithm.Parameters().

def RemoveEnforcedVertexGeom	(		self,
			theVertex
	)

To remove an enforced vertex given a GEOM vertex, group or compound.

Parameters

theVertex

: GEOM vertex (or group, compound) to be projected on theFace.

References Mesh_Algorithm.mesh, and HYBRID_Algorithm.Parameters().

def SetEnforcedMesh	(		self,
			theSource,
			elementType,
			size = -1,
			groupName = ""
	)

To set an enforced mesh with given size and add the enforced elements in the group "groupName".

Parameters

theSource	: source mesh which provides constraint elements/nodes
elementType	: SMESH.ElementType (NODE, EDGE or FACE)
size	: size of elements around enforced elements. Unused if -1.
groupName	: group in which enforced elements will be added. Unused if "".

References HYBRID_Algorithm.Parameters().

def SetTextOption	(		self,
			option
	)

Sets command line option as text.

OBSOLETE. Use SetAdvancedOption()

Parameters

option

command line option

References HYBRID_Algorithm.Parameters(), and HYBRID_Algorithm.SetAdvancedOption().

def SetAdvancedOption	(		self,
			option
	)

Sets command line option as text.

Parameters

option

command line option

References HYBRID_Algorithm.Parameters().

Field Documentation

string meshMethod = "Tetrahedron"

static

name of the dynamic method in smeshBuilder.Mesh class

algoType = MG_Hybrid

static

type of algorithm used with helper function in smeshBuilder.Mesh class

string docHelper = "Creates tetrahedron 3D algorithm for volumes"

static

doc string of the method in smeshBuilder.Mesh class

params