GHS3D_Optimizer Class Reference

MG-Tetra Optimization algorithm - optimizer of tetrahedral meshes. More...

Inheritance diagram for GHS3D_Optimizer:

Public Member Functions
def	__init__ (self, mesh, geom=0)
	Private constructor. More...
def	Parameters (self)
	Defines hypothesis having several parameters. More...
def	SetOptimizationOnly (self, optMode)
	Set Optimization mode. More...
def	SetSplitOverConstrained (self, ovcMode)
	Set mode of splitting over-constrained elements. More...
def	SetSmoothOffSlivers (self, toSmooth)
	Activate smoothing sliver elements: More...
def	SetPThreadsMode (self, mode)
	Set multithread mode. More...
def	SetMaximalNumberOfThreads (self, nb)
	Set maximal number of threads. More...
def	SetOptimizationLevel (self, level)
	Set Optimization level: More...
def	SetMaximumMemory (self, MB)
	Set maximal size of memory to be used by the algorithm (in Megabytes). More...
def	SetInitialMemory (self, MB)
	Set initial size of memory to be used by the algorithm (in Megabytes) in automatic memory adjustment mode. More...
def	SetWorkingDirectory (self, path)
	Set path to working directory. More...
def	SetKeepFiles (self, toKeep)
	To keep working files or remove them. More...
def	SetRemoveLogOnSuccess (self, toRemove)
	Remove or not the log file (if any) in case of successful computation. More...
def	SetPrintLogInFile (self, toPrintLogInFile)
	Print the the log in a file. More...
def	SetVerboseLevel (self, level)
	Set verbosity level [0-10]. More...
def	SetToCreateNewNodes (self, toCreate)
	To create new nodes. More...
def	SetAdvancedOption (self, option)
	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_Optimization
	type of algorithm used with helper function in smeshBuilder.Mesh class More...
string	docHelper = "Creates MG-Tetra optimizer of tetrahedral meshes"
	doc string of the method in smeshBuilder.Mesh class More...

Detailed Description

MG-Tetra Optimization algorithm - optimizer of tetrahedral meshes.

It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.MG_Tetra_Optimization )

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			mesh,
			geom = 0
	)

Private constructor.

Parameters

mesh	parent mesh object algorithm is assigned to
geom	- not used

Reimplemented from GHS3D_Algorithm.

Member Function Documentation

Parameters()

def Parameters

(

self

)

Defines hypothesis having several parameters.

Returns

hypothesis object

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.params, and GHS3D_Optimizer.params.

SetOptimizationOnly()

def SetOptimizationOnly	(		self,
			optMode
	)

Set Optimization mode.

Parameters

optMode

optimization mode, one of the following values: smeshBuilder.Mode_NO, smeshBuilder.Mode_YES (default), smeshBuilder.MODE_ONLY

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetOptimizationOnly().

SetSplitOverConstrained()

def SetSplitOverConstrained	(		self,
			ovcMode
	)

Set mode of splitting over-constrained elements.

Parameters

ovcMode,one

of the following values smeshBuilder.Mode_NO (default), smeshBuilder.Mode_YES, smeshBuilder.Mode_ONLY

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetSplitOverConstrained().

SetSmoothOffSlivers()

def SetSmoothOffSlivers	(		self,
			toSmooth
	)

Activate smoothing sliver elements:

Parameters

toSmooth

- Boolean flag

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetSmoothOffSlivers().

SetPThreadsMode()

def SetPThreadsMode	(		self,
			mode
	)

Set multithread mode.

Parameters

mode	- the mode, one of the following values: smeshBuilder.Mode_SAFE, smeshBuilder.Mode_AGGRESSIVE, smeshBuilder.Mode_NONE (default)

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetPThreadsMode().

SetMaximalNumberOfThreads()

def SetMaximalNumberOfThreads	(		self,
			nb
	)

Set maximal number of threads.

Parameters

nb	- number of threads

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetMaximalNumberOfThreads().

SetOptimizationLevel()

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

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetOptimizationLevel().

SetMaximumMemory()

def SetMaximumMemory	(		self,
			MB
	)

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

Parameters

MB	maximal size of memory

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetMaximumMemory().

SetInitialMemory()

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

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetInitialMemory().

SetWorkingDirectory()

def SetWorkingDirectory	(		self,
			path
	)

Set path to working directory.

Parameters

path	working directory

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetWorkingDirectory().

SetKeepFiles()

def SetKeepFiles	(		self,
			toKeep
	)

To keep working files or remove them.

Parameters

toKeep

"keep working files" flag value

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetKeepFiles().

SetRemoveLogOnSuccess()

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

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetRemoveLogOnSuccess().

SetPrintLogInFile()

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

Reimplemented from GHS3D_Algorithm.

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

SetVerboseLevel()

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.

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetVerboseLevel().

SetToCreateNewNodes()

def SetToCreateNewNodes	(		self,
			toCreate
	)

To create new nodes.

Parameters

toCreate

"create new nodes" flag value

Reimplemented from GHS3D_Algorithm.

References GHS3D_Algorithm.Parameters(), GHS3D_Optimizer.Parameters(), and GHS3D_Optimizer.SetToCreateNewNodes().

SetAdvancedOption()

def SetAdvancedOption	(		self,
			option
	)

Sets command line option as text.

Parameters

option

command line option

Reimplemented from GHS3D_Algorithm.

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

Field Documentation

meshMethod

string meshMethod = "Tetrahedron"

static

name of the dynamic method in smeshBuilder.Mesh class

algoType

algoType = MG_Tetra_Optimization

static

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

docHelper

string docHelper = "Creates MG-Tetra optimizer of tetrahedral meshes"

static

doc string of the method in smeshBuilder.Mesh class

params

params