Version: 9.7.0
Home
Hexotic_Algorithm Class Reference

Defines a hexahedron 3D algorithm. More...

Inheritance diagram for Hexotic_Algorithm:
Inheritance graph

Public Member Functions

def __init__ (self, mesh, geom=0)
 Private constructor. More...
 
def SetMinMaxHexes (self, min=3, max=8)
 Defines "SetMinMaxHexes" hypothesis to give two MG-Hexa parameters. More...
 
def SetMinMaxSize (self, min, max)
 Defines "SetMinMaxSize" hypothesis to give two MG-Hexa parameters. More...
 
def SetSizeMap (self, theObject, theSize)
 Sets a size map. More...
 
def UnsetSizeMap (self, theObject)
 Unsets a size map : this is meant to be used only by the dump. More...
 
def SetAdvancedOption (self, theOptions)
 Set values of advanced options. More...
 
def GetAdvancedOption (self)
 
def MinMaxQuad (self, min=3, max=8, quad=True)
 (OBSOLETE) Defines "MinMaxQuad" hypothesis to give three MG-Hexa parameters More...
 
def SetOptionValue (self, optionName, optionValue)
 Set advanced option value. More...
 
def SetViscousLayers (self, numberOfLayers, firstLayerSize, growth, facesWithLayers, imprintedFaces=[], direction=Inward)
 Defines "ViscousLayers" hypothesis to give MG-Hexa parameters. 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 Parameters (self)
 Defines hypothesis having several parameters. More...
 

Data Fields

 params
 

Static Public Attributes

string meshMethod = "Hexahedron"
 name of the dynamic method in smeshBuilder.Mesh class More...
 
 algoType = MG_Hexa
 type of algorithm used with helper function in smeshBuilder.Mesh class More...
 
string docHelper = "Creates hexahedron 3D algorithm for volumes"
 doc string of the method in smeshBuilder.Mesh class More...
 

Detailed Description

Defines a hexahedron 3D algorithm.

It is created by calling smeshBuilder.Mesh.Hexahedron( smeshBuilder.MG_Hexa, geom=0 )

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  mesh,
  geom = 0 
)

Private constructor.

Parameters
meshparent mesh object algorithm is assigned to
geomgeometry (shape/sub-shape) algorithm is assigned to; if it is 0 (default), the algorithm is assigned to the main shape

References Mesh_Algorithm.Create().

Member Function Documentation

◆ SetMinMaxHexes()

def SetMinMaxHexes (   self,
  min = 3,
  max = 8 
)

Defines "SetMinMaxHexes" hypothesis to give two MG-Hexa parameters.

Parameters
minminimal level of recursive partitioning on the initial octree cube
maxmaximal level of recursive partitioning on the initial octree cube
Returns
hypothesis object

References Hexotic_Algorithm.Parameters().

◆ SetMinMaxSize()

def SetMinMaxSize (   self,
  min,
  max 
)

Defines "SetMinMaxSize" hypothesis to give two MG-Hexa parameters.

Parameters
minminimal element's size
maxmaximal element's size
Returns
hypothesis object

References Hexotic_Algorithm.Parameters().

◆ SetSizeMap()

def SetSizeMap (   self,
  theObject,
  theSize 
)

Sets a size map.

Parameters
theObjectgeometrical object to assign local size to
theSizelocal size on the given object
Returns
hypothesis object

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

◆ UnsetSizeMap()

def UnsetSizeMap (   self,
  theObject 
)

Unsets a size map : this is meant to be used only by the dump.

Parameters
theObjectgeometrical object to unassign local size
Returns
hypothesis object

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

◆ SetAdvancedOption()

def SetAdvancedOption (   self,
  theOptions 
)

Set values of advanced options.

Parameters
theOptionsstring in a form "option_1 v1 option_2 v2"

References Hexotic_Algorithm.Parameters().

◆ GetAdvancedOption()

def GetAdvancedOption (   self)

◆ MinMaxQuad()

def MinMaxQuad (   self,
  min = 3,
  max = 8,
  quad = True 
)

(OBSOLETE) Defines "MinMaxQuad" hypothesis to give three MG-Hexa parameters

Parameters
minminimal level of recursive partitioning on the initial octree cube
maxmaximal level of recursive partitioning on the initial octree cube
quadnot documented
Returns
hypothesis object

References Hexotic_Algorithm.SetMinMaxHexes().

◆ SetOptionValue()

def SetOptionValue (   self,
  optionName,
  optionValue 
)

Set advanced option value.

Parameters
optionNameoption name
optionValueoption value

References Hexotic_Algorithm.Parameters(), and Hexotic_Algorithm.SetViscousLayers().

◆ SetViscousLayers()

def SetViscousLayers (   self,
  numberOfLayers,
  firstLayerSize,
  growth,
  facesWithLayers,
  imprintedFaces = [],
  direction = Inward 
)

Defines "ViscousLayers" hypothesis to give MG-Hexa parameters.

Parameters
numberOfLayersnumber of boundary layers
firstLayerSizeheight of the first layer
growthgeometric progression for the boundary layer growth
directiondescribes whether the layers grow inwards or outwards. Possible values are:
  • smeshBuilder.Inward : means the layers grow inwards,
  • smeshBuilder.Outward : means the layers grow outwards
facesWithLayerslist of surfaces from which the boundary layers should be grown
imprintedFaceslist of surfaces that can be imprinted by boundary layers
Returns
hypothesis object

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

◆ SetKeepFiles()

def SetKeepFiles (   self,
  toKeep 
)

To keep working files or remove them.

Parameters
toKeep"keep working files" flag value

References Hexotic_Algorithm.Parameters().

◆ 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

References Hexotic_Algorithm.Parameters().

◆ 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

References Hexotic_Algorithm.Parameters().

◆ Parameters()

def Parameters (   self)

Defines hypothesis having several parameters.

Returns
hypothesis object

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

Field Documentation

◆ meshMethod

string meshMethod = "Hexahedron"
static

name of the dynamic method in smeshBuilder.Mesh class

◆ algoType

algoType = MG_Hexa
static

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

◆ docHelper

string docHelper = "Creates hexahedron 3D algorithm for volumes"
static

doc string of the method in smeshBuilder.Mesh class

◆ params

params