Version: 9.12.0
StdMeshers::StdMeshers_CartesianParameters3D Interface Reference

interface of "Body fitting Parameters" hypothesis. More...

import"SMESH_BasicHypothesis.idl";

Inheritance diagram for StdMeshers::StdMeshers_CartesianParameters3D:

Public Member Functions

void SetSizeThreshold (in double threshold) raises (SALOME::SALOME_Exception)
 Set size threshold. More...
 
double GetSizeThreshold ()
 
boolean IsGridBySpacing (in short axis)
 Return true if the grid is defined by spacing functions and not by node coordinates in given direction (X==0,...) More...
 
void SetGrid (in SMESH::double_array coords, in short axis) raises (SALOME::SALOME_Exception)
 Set coordinates of nodes along an axis (countered from zero) More...
 
SMESH::double_array GetGrid (in short axis) raises (SALOME::SALOME_Exception)
 
void SetGridSpacing (in SMESH::string_array spaceFunctions, in SMESH::double_array internalPoints, in short axis) raises (SALOME::SALOME_Exception)
 Set grid spacing along an axis. More...
 
void GetGridSpacing (out SMESH::string_array spaceFunctions, out SMESH::double_array internalPoints, in short axis) raises (SALOME::SALOME_Exception)
 
void SetAxesDirs (in SMESH::DirStruct x, in SMESH::DirStruct y, in SMESH::DirStruct z) raises (SALOME::SALOME_Exception)
 Set custom direction of axes. More...
 
void GetAxesDirs (out SMESH::DirStruct x, out SMESH::DirStruct y, out SMESH::DirStruct z)
 
void SetFixedPoint (in SMESH::PointStruct p, in boolean toUnset)
 Set/unset a fixed point, at which a node will be created provided that grid is defined by spacing in all directions. More...
 
boolean GetFixedPoint (out SMESH::PointStruct p)
 
void SetToAddEdges (in boolean toAdd)
 Enable implementation of geometrical edges into the mesh. More...
 
boolean GetToAddEdges ()
 
void SetToConsiderInternalFaces (in boolean toTreat)
 Enable treatment of geom faces, either shared by solids or internal. More...
 
boolean GetToConsiderInternalFaces ()
 
void SetToUseThresholdForInternalFaces (in boolean toUse)
 Enable applying size threshold to grid cells cut by internal geom faces. More...
 
boolean GetToUseThresholdForInternalFaces ()
 
void SetToCreateFaces (in boolean toCreate)
 Enable creation of mesh faces. More...
 
boolean GetToCreateFaces ()
 
void ComputeOptimalAxesDirs (in GEOM::GEOM_Object shape, in boolean isOrthogonal, out SMESH::DirStruct x, out SMESH::DirStruct y, out SMESH::DirStruct z) raises (SALOME::SALOME_Exception)
 Return axes at which a number of generated hexahedra is maximal. More...
 
SMESH::double_array ComputeCoordinates (in double x0, in double x1, in SMESH::string_array spaceFuns, in SMESH::double_array points, in string axisName) raises (SALOME::SALOME_Exception)
 Compute node coordinates by spacing functions. More...
 
string GetName ()
 Get the Hypothesis typeName. More...
 
string GetLibName ()
 Get the Hypothesis plugin library Name. More...
 
short GetId ()
 Get the internal Id. More...
 
void SetVarParameter (in string parameter, in string method)
 Set the variable parameter. More...
 
string GetVarParameter (in string methodName)
 Return the variable parameter used for Hypothesis creation by name of method setting this parameter. More...
 
void SetHolderHypothesis (in SMESH::SMESH_Hypothesis hyp)
 Store a hypothesis wrapping this not published one. More...
 
boolean IsDimSupported (in Dimension type)
 Verify whether hypothesis supports given entity type. More...
 
boolean HasParameters ()
 Return true if a hypothesis has parameters. More...
 

Detailed Description

interface of "Body fitting Parameters" hypothesis.

This hypothesis specifies

  • Size threshold
  • Definition of the Cartesian grid
  • Direction of grid axes

Member Function Documentation

◆ ComputeCoordinates()

SMESH::double_array StdMeshers::StdMeshers_CartesianParameters3D::ComputeCoordinates ( in double  x0,
in double  x1,
in SMESH::string_array  spaceFuns,
in SMESH::double_array  points,
in string  axisName 
)
raises (SALOME::SALOME_Exception
)

Compute node coordinates by spacing functions.

Parameters
x0- lower coordinate
x1- upper coordinate
spaceFuns- space functions
points- internal points
axisName- e.g. "X"
Returns
the computed coordinates

◆ ComputeOptimalAxesDirs()

void StdMeshers::StdMeshers_CartesianParameters3D::ComputeOptimalAxesDirs ( in GEOM::GEOM_Object  shape,
in boolean  isOrthogonal,
out SMESH::DirStruct  x,
out SMESH::DirStruct  y,
out SMESH::DirStruct  z 
)
raises (SALOME::SALOME_Exception
)

Return axes at which a number of generated hexahedra is maximal.

◆ GetAxesDirs()

void StdMeshers::StdMeshers_CartesianParameters3D::GetAxesDirs ( out SMESH::DirStruct  x,
out SMESH::DirStruct  y,
out SMESH::DirStruct  z 
)

◆ GetFixedPoint()

boolean StdMeshers::StdMeshers_CartesianParameters3D::GetFixedPoint ( out SMESH::PointStruct  p)

◆ GetGrid()

SMESH::double_array StdMeshers::StdMeshers_CartesianParameters3D::GetGrid ( in short  axis)
raises (SALOME::SALOME_Exception
)

◆ GetGridSpacing()

void StdMeshers::StdMeshers_CartesianParameters3D::GetGridSpacing ( out SMESH::string_array  spaceFunctions,
out SMESH::double_array  internalPoints,
in short  axis 
)
raises (SALOME::SALOME_Exception
)

◆ GetId()

short SMESH::SMESH_Hypothesis::GetId ( )
inherited

Get the internal Id.

◆ GetLibName()

string SMESH::SMESH_Hypothesis::GetLibName ( )
inherited

Get the Hypothesis plugin library Name.

◆ GetName()

string SMESH::SMESH_Hypothesis::GetName ( )
inherited

Get the Hypothesis typeName.

Referenced by StdMeshers_Regular_1D::CheckHypothesis().

◆ GetSizeThreshold()

double StdMeshers::StdMeshers_CartesianParameters3D::GetSizeThreshold ( )

◆ GetToAddEdges()

boolean StdMeshers::StdMeshers_CartesianParameters3D::GetToAddEdges ( )

◆ GetToConsiderInternalFaces()

boolean StdMeshers::StdMeshers_CartesianParameters3D::GetToConsiderInternalFaces ( )

◆ GetToCreateFaces()

boolean StdMeshers::StdMeshers_CartesianParameters3D::GetToCreateFaces ( )

◆ GetToUseThresholdForInternalFaces()

boolean StdMeshers::StdMeshers_CartesianParameters3D::GetToUseThresholdForInternalFaces ( )

◆ GetVarParameter()

string SMESH::SMESH_Hypothesis::GetVarParameter ( in string  methodName)
inherited

Return the variable parameter used for Hypothesis creation by name of method setting this parameter.

◆ HasParameters()

boolean SMESH::SMESH_Hypothesis::HasParameters ( )
inherited

Return true if a hypothesis has parameters.

This method is intended for GUI to know if "Edit" menu item should be available

◆ IsDimSupported()

boolean SMESH::SMESH_Hypothesis::IsDimSupported ( in Dimension  type)
inherited

Verify whether hypothesis supports given entity type.

◆ IsGridBySpacing()

boolean StdMeshers::StdMeshers_CartesianParameters3D::IsGridBySpacing ( in short  axis)

Return true if the grid is defined by spacing functions and not by node coordinates in given direction (X==0,...)

◆ SetAxesDirs()

void StdMeshers::StdMeshers_CartesianParameters3D::SetAxesDirs ( in SMESH::DirStruct  x,
in SMESH::DirStruct  y,
in SMESH::DirStruct  z 
)
raises (SALOME::SALOME_Exception
)

Set custom direction of axes.

◆ SetFixedPoint()

void StdMeshers::StdMeshers_CartesianParameters3D::SetFixedPoint ( in SMESH::PointStruct  p,
in boolean  toUnset 
)

Set/unset a fixed point, at which a node will be created provided that grid is defined by spacing in all directions.

◆ SetGrid()

void StdMeshers::StdMeshers_CartesianParameters3D::SetGrid ( in SMESH::double_array  coords,
in short  axis 
)
raises (SALOME::SALOME_Exception
)

Set coordinates of nodes along an axis (countered from zero)

◆ SetGridSpacing()

void StdMeshers::StdMeshers_CartesianParameters3D::SetGridSpacing ( in SMESH::string_array  spaceFunctions,
in SMESH::double_array  internalPoints,
in short  axis 
)
raises (SALOME::SALOME_Exception
)

Set grid spacing along an axis.

Parameters
spaceFunctions- functions defining spacing values at given point on axis
internalPoints- points dividing a grid into parts along an axis
axis- index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z

Parameter t of spaceFunction f(t) is a position [0,1] within bounding box of the shape to mesh or within an interval defined by internal points

◆ SetHolderHypothesis()

void SMESH::SMESH_Hypothesis::SetHolderHypothesis ( in SMESH::SMESH_Hypothesis  hyp)
inherited

Store a hypothesis wrapping this not published one.

This hyp, which has no own parameters but is published, is used to store variables defining parameters of this hypothesis.

◆ SetSizeThreshold()

void StdMeshers::StdMeshers_CartesianParameters3D::SetSizeThreshold ( in double  threshold)
raises (SALOME::SALOME_Exception
)

Set size threshold.

A polyhedral cell got by cutting an initial hexahedron by geometry boundary is considered small and is removed if it's size is threshold times less than the size of the initial hexahedron. threshold must be > 1.0

◆ SetToAddEdges()

void StdMeshers::StdMeshers_CartesianParameters3D::SetToAddEdges ( in boolean  toAdd)

Enable implementation of geometrical edges into the mesh.

If this feature is disabled, sharp edges of the shape are lost ("smoothed") in the mesh if they don't coincide with the grid lines

◆ SetToConsiderInternalFaces()

void StdMeshers::StdMeshers_CartesianParameters3D::SetToConsiderInternalFaces ( in boolean  toTreat)

Enable treatment of geom faces, either shared by solids or internal.

◆ SetToCreateFaces()

void StdMeshers::StdMeshers_CartesianParameters3D::SetToCreateFaces ( in boolean  toCreate)

Enable creation of mesh faces.

◆ SetToUseThresholdForInternalFaces()

void StdMeshers::StdMeshers_CartesianParameters3D::SetToUseThresholdForInternalFaces ( in boolean  toUse)

Enable applying size threshold to grid cells cut by internal geom faces.

◆ SetVarParameter()

void SMESH::SMESH_Hypothesis::SetVarParameter ( in string  parameter,
in string  method 
)
inherited

Set the variable parameter.

Parameters
parameteris a string containing the notebook variable used for Hypothesis creation
methodis a name of Hypothesis method setting this parameter

This method must be called before calling method()