GHS3D_Algorithm Class Reference

Tetrahedron MG-Tetra 3D algorithm. More...

Inheritance diagram for GHS3D_Algorithm:

Public Member Functions
def	__init__
	Private constructor. More...
def	Parameters
	Defines hypothesis having several parameters. More...
def	SetToMeshHoles
	To mesh "holes" in a solid or not. More...
def	SetToMakeGroupsOfDomains
	To make groups of volumes of different domains when mesh is generated from skin. More...
def	SetOptimizationLevel
	Set Optimization level: More...
def	SetMaximumMemory
	Set maximal size of memory to be used by the algorithm (in Megabytes). More...
def	SetInitialMemory
	Set initial size of memory to be used by the algorithm (in Megabytes) in automatic memory adjustment mode. 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_Tetra
	type of algorithm used with helper function in smeshBuilder.Mesh class More...
string	docHelper = "Creates tetrahedron 3D algorithm"
	doc string of the method in smeshBuilder.Mesh class More...

Detailed Description

Tetrahedron MG-Tetra 3D algorithm.

It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.MG_Tetra, 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 GHS3D_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 GHS3D_Algorithm.params.

def SetToMeshHoles	(		self,
			toMesh
	)

To mesh "holes" in a solid or not.

Default is to mesh.

Parameters

toMesh

"mesh holes" flag value

References GHS3D_Algorithm.Parameters().

def SetToMakeGroupsOfDomains	(		self,
			toMakeGroups
	)

To make groups of volumes of different domains when mesh is generated from skin.

Default is to make groups. This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true

Parameters

toMakeGroups

"Make groups of domains" flag value

References GHS3D_Algorithm.Parameters().

def SetOptimizationLevel	(		self,
			level
	)

Set Optimization level:

Parameters

level

optimization level, one of the following values None_Optimization Light_Optimization Standard_Optimization StandardPlus_Optimization Strong_Optimization. Default is Standard_Optimization

References GHS3D_Algorithm.Parameters().

def SetMaximumMemory	(		self,
			MB
	)

Set maximal size of memory to be used by the algorithm (in Megabytes).

Parameters

MB	maximal size of memory

References GHS3D_Algorithm.Parameters().

def SetInitialMemory	(		self,
			MB
	)

Set initial size of memory to be used by the algorithm (in Megabytes) in automatic memory adjustment mode.

Parameters

MB	initial size of memory

References GHS3D_Algorithm.Parameters().

def SetWorkingDirectory	(		self,
			path
	)

Set path to working directory.

Parameters

path	working directory

References GHS3D_Algorithm.Parameters().

def SetKeepFiles	(		self,
			toKeep
	)

To keep working files or remove them.

Parameters

toKeep

"keep working files" flag value

References GHS3D_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 GHS3D_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 GHS3D_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 GHS3D_Algorithm.Parameters().

def SetToCreateNewNodes	(		self,
			toCreate
	)

To create new nodes.

Parameters

toCreate

"create new nodes" flag value

References GHS3D_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 GHS3D_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 GHS3D_Algorithm.Parameters().

def SetToRemoveCentralPoint	(		self,
			toRemove
	)

To remove initial central point.

Parameters

toRemove

"remove initial central point" flag value

References GHS3D_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 GHS3D_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 GHS3D_Algorithm.Parameters().

def RemoveEnforcedVertex	(		self,
			x,
			y,
			z
	)

To remove an enforced vertex.

Parameters

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

References GHS3D_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 GHS3D_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 GHS3D_Algorithm.Parameters().

def SetTextOption	(		self,
			option
	)

Sets command line option as text.

Parameters

option

command line option

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

def SetAdvancedOption	(		self,
			option
	)

Sets command line option as text.

Parameters

option

command line option

References GHS3D_Algorithm.Parameters().

Field Documentation

string meshMethod = "Tetrahedron"

static

name of the dynamic method in smeshBuilder.Mesh class

algoType = MG_Tetra

static

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

string docHelper = "Creates tetrahedron 3D algorithm"

static

doc string of the method in smeshBuilder.Mesh class

params