SALOME documentation central

Auxiliary methods and structures

Data Structures

class  PointStructStr
class  PointStructStr6
class  AxisStructStr
class  DirStructStr

Functions

def DegreesToRadians
 Converts an angle from degrees to radians.
def ParsePointStruct
def ParseDirStruct
def ParseAxisStruct
def ParseAngles
 Return list of variable values from salome notebook.
def IsEqual
def GetName
 Gets object name.
def TreatHypoStatus
 Prints error message if a hypothesis was not assigned.
def CheckPlugin
 Check meshing plugin availability.
def init_smesh
 Sets the current study and Geometry component.
def GetPointStruct
 Gets PointStruct from vertex.
def GetDirStruct
 Gets DirStruct from vector.
def MakeDirStruct
 Makes DirStruct from a triplet.
def GetAxisStruct
 Get AxisStruct from object.
def SetName
 Sets the given name to the object.
def SetEmbeddedMode
 Sets the current mode.
def IsEmbeddedMode
 Gets the current mode.
def SetCurrentStudy
 Sets the current study.
def GetCurrentStudy
 Gets the current study.
def GetSubShapesId
 From SMESH_Gen interface.
def SetBoundaryBoxSegmentation
 Sets number of segments per diagonal of boundary box of geometry by which default segment length of appropriate 1D hypotheses is defined.
def MeshDimension
 Returns the mesh dimension depending on the dimension of the underlying shape.
def GetLog
 Returns the log of nodes and elements added or removed since the previous clear of the log.
def ClearLog
 Clears the log of nodes and elements added or removed since the previous clear.
def SetAutoColor
 Toggles auto color mode on the object.
def GetAutoColor
 Gets flag of object auto color mode.
def GetId
 Gets the internal ID.
def GetStudyId
 Get the study Id.
def HasDuplicatedGroupNamesMED
 Checks the group names for duplications.
def GetMEDMesh
 Gets MED Mesh.
def SplitQuadsNearTriangularFacets
 Splits quadrangle faces near triangular facets of volumes.
def SplitHexaToTetras
 Splits hexahedrons into tetrahedrons.
def SplitHexaToPrisms
 Split hexahedrons into prisms.
def GetLastCreatedNodes
 If during the last operation of MeshEditor some nodes were created, this method returns the list of their IDs,
if new nodes were not created - returns empty list.
def GetLastCreatedElems
 If during the last operation of MeshEditor some elements were created this method returns the list of their IDs,
if new elements were not created - returns empty list.

Variables

int REGULAR = 1
int PYTHON = 2
int COMPOSITE = 3
int SOLE = 0
int SIMPLE = 1
int MEFISTO = 3
int NETGEN = 4
int GHS3D = 5
int FULL_NETGEN = 6
int NETGEN_2D = 7
 NETGEN_1D2D = NETGEN
 NETGEN_1D2D3D = FULL_NETGEN
 NETGEN_FULL = FULL_NETGEN
int Hexa = 8
int Hexotic = 9
int BLSURF = 10
int GHS3DPRL = 11
 POINT = SMESH_MeshEditor.POINT
 AXIS = SMESH_MeshEditor.AXIS
 PLANE = SMESH_MeshEditor.PLANE
 LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH
 CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH
int VeryCoarse = 0
int Coarse = 1
int Moderate = 2
int Fine = 3
int VeryFine = 4
int Custom = 5
int PrecisionConfusion = 1
string var_separator = ":"
string NO_NAME = "NoName"

Function Documentation

def smesh.DegreesToRadians (   AngleInDegrees  ) 

Converts an angle from degrees to radians.

def smesh.ParsePointStruct (   Point  ) 
def smesh.ParseDirStruct (   Dir  ) 
def smesh.ParseAxisStruct (   Axis  ) 
def smesh.ParseAngles (   list  ) 

Return list of variable values from salome notebook.

def smesh.IsEqual (   val1,
  val2,
  tol = PrecisionConfusion 
)
def smesh.GetName (   obj  ) 

Gets object name.

def smesh.TreatHypoStatus (   status,
  hypName,
  geomName,
  isAlgo 
)

Prints error message if a hypothesis was not assigned.

def smesh.CheckPlugin (   plugin  ) 

Check meshing plugin availability.

def init_smesh (   self,
  theStudy,
  geompyD 
) [inherited]

Sets the current study and Geometry component.

def GetPointStruct (   self,
  theVertex 
) [inherited]

Gets PointStruct from vertex.

Parameters:
theVertex a GEOM object(vertex)
Returns:
SMESH.PointStruct
def GetDirStruct (   self,
  theVector 
) [inherited]

Gets DirStruct from vector.

Parameters:
theVector a GEOM object(vector)
Returns:
SMESH.DirStruct
def MakeDirStruct (   self,
  x,
  y,
  z 
) [inherited]

Makes DirStruct from a triplet.

Parameters:
x,y,z vector components
Returns:
SMESH.DirStruct
def GetAxisStruct (   self,
  theObj 
) [inherited]

Get AxisStruct from object.

Parameters:
theObj a GEOM object (line or plane)
Returns:
SMESH.AxisStruct
def SetName (   self,
  obj,
  name 
) [inherited]

Sets the given name to the object.

Parameters:
obj the object to rename
name a new object name
def SetEmbeddedMode (   self,
  theMode 
) [inherited]

Sets the current mode.

def IsEmbeddedMode (   self  )  [inherited]

Gets the current mode.

def SetCurrentStudy (   self,
  theStudy,
  geompyD = None 
) [inherited]

Sets the current study.

def GetCurrentStudy (   self  )  [inherited]

Gets the current study.

def GetSubShapesId (   self,
  theMainObject,
  theListOfSubObjects 
) [inherited]

From SMESH_Gen interface.

Returns:
the list of integer values
def SetBoundaryBoxSegmentation (   self,
  nbSegments 
) [inherited]

Sets number of segments per diagonal of boundary box of geometry by which default segment length of appropriate 1D hypotheses is defined.

Default value is 10

def MeshDimension (   self  )  [inherited]

Returns the mesh dimension depending on the dimension of the underlying shape.

Returns:
mesh dimension as an integer value [0,3]
def GetLog (   self,
  clearAfterGet 
) [inherited]

Returns the log of nodes and elements added or removed since the previous clear of the log.

Parameters:
clearAfterGet log is emptied after Get (safe if concurrents access)
Returns:
list of log_block structures: commandType number coords indexes
def ClearLog (   self  )  [inherited]

Clears the log of nodes and elements added or removed since the previous clear.

Must be used immediately after GetLog if clearAfterGet is false.

def SetAutoColor (   self,
  theAutoColor 
) [inherited]

Toggles auto color mode on the object.

Parameters:
theAutoColor the flag which toggles auto color mode.
def GetAutoColor (   self  )  [inherited]

Gets flag of object auto color mode.

Returns:
True or False
def GetId (   self  )  [inherited]

Gets the internal ID.

Returns:
integer value, which is the internal Id of the mesh
def GetStudyId (   self  )  [inherited]

Get the study Id.

Returns:
integer value, which is the study Id of the mesh
def HasDuplicatedGroupNamesMED (   self  )  [inherited]

Checks the group names for duplications.

Consider the maximum group name length stored in MED file.

Returns:
True or False
def GetMEDMesh (   self  )  [inherited]

Gets MED Mesh.

Returns:
an instance of SALOME_MED.MESH
def SplitQuadsNearTriangularFacets (   self  )  [inherited]

Splits quadrangle faces near triangular facets of volumes.

def SplitHexaToTetras (   self,
  theObject,
  theNode000,
  theNode001 
) [inherited]

Splits hexahedrons into tetrahedrons.

This operation uses pattern mapping functionality for splitting.

Parameters:
theObject the object from which the list of hexahedrons is taken; this is mesh, submesh or group.
theNode000,theNode001 within the range [0,7]; gives the orientation of the pattern relatively each hexahedron: the (0,0,0) key-point of the pattern will be mapped into theNode000-th node of each volume, the (0,0,1) key-point will be mapped into theNode001-th node of each volume. The (0,0,0) key-point of the used pattern corresponds to a non-split corner.
Returns:
TRUE in case of success, FALSE otherwise.
def SplitHexaToPrisms (   self,
  theObject,
  theNode000,
  theNode001 
) [inherited]

Split hexahedrons into prisms.

Uses the pattern mapping functionality for splitting.

Parameters:
theObject the object (mesh, submesh or group) from where the list of hexahedrons is taken;
theNode000,theNode001 (within the range [0,7]) gives the orientation of the pattern relatively each hexahedron: keypoint (0,0,0) of the pattern will be mapped into the theNode000-th node of each volume, keypoint (0,0,1) will be mapped into the theNode001-th node of each volume. Edge (0,0,0)-(0,0,1) of used pattern connects two not split corners.
Returns:
TRUE in case of success, FALSE otherwise.
def GetLastCreatedNodes (   self  )  [inherited]

If during the last operation of MeshEditor some nodes were created, this method returns the list of their IDs,
if new nodes were not created - returns empty list.

Returns:
the list of integer values (can be empty)
def GetLastCreatedElems (   self  )  [inherited]

If during the last operation of MeshEditor some elements were created this method returns the list of their IDs,
if new elements were not created - returns empty list.

Returns:
the list of integer values (can be empty)

Variable Documentation

int REGULAR = 1
int PYTHON = 2
int COMPOSITE = 3
int SOLE = 0
int SIMPLE = 1
int MEFISTO = 3
int NETGEN = 4
int GHS3D = 5
int FULL_NETGEN = 6
int NETGEN_2D = 7
NETGEN_1D2D = NETGEN
NETGEN_1D2D3D = FULL_NETGEN
NETGEN_FULL = FULL_NETGEN
int Hexa = 8
int Hexotic = 9
int BLSURF = 10
int GHS3DPRL = 11
POINT = SMESH_MeshEditor.POINT
AXIS = SMESH_MeshEditor.AXIS
PLANE = SMESH_MeshEditor.PLANE
LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH
CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH
int VeryCoarse = 0
int Coarse = 1
int Moderate = 2
int Fine = 3
int VeryFine = 4
int Custom = 5
int PrecisionConfusion = 1
string var_separator = ":"
string NO_NAME = "NoName"
 All Data Structures Namespaces Files Functions Variables

Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS