X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Fsmeshpy_doc%2Fnamespacesmesh.html;h=a0df057476a9a7fbd4570100973e2efa41b8e05a;hb=5b8dad5b5d30efc06b273afc6b5b0f0cc5c55691;hp=130b8881fc2794cb8f730c0370cb7c3d7ad3c0f0;hpb=c46bd4f9bb602f9863c817bcd622b1b70d5af1e9;p=modules%2Fsmesh.git diff --git a/doc/salome/gui/SMESH/smeshpy_doc/namespacesmesh.html b/doc/salome/gui/SMESH/smeshpy_doc/namespacesmesh.html index 130b8881f..a0df05747 100644 --- a/doc/salome/gui/SMESH/smeshpy_doc/namespacesmesh.html +++ b/doc/salome/gui/SMESH/smeshpy_doc/namespacesmesh.html @@ -1,24 +1,37 @@ - - -SALOME - SMESH - v.version: Package smesh + + + + + + Main Page - + + + + +

Package smesh

-Python package smesh defines several classes, destined for easy and clear mesh creation and edition. -

Example.

+Python package smesh defines several classes, destined for easy and +clear mesh creation and edition. +

Example.
+
+

- + + + + @@ -37,27 +50,138 @@ Python package smesh defines several classes, destined for easy and clear mesh c + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

class Mesh_Algorithm
Mother class to define algorithm, recommended to don't use directly. More...
Mother class to define algorithm, recommended to do not use directly. More...

class Mesh_Segment

Class to define a segment 1D algorithm for discretization. More...
class Mesh_CompositeSegment
Class to define a segment 1D algorithm for discretization. More...

class Mesh_Segment_Python

Class to define a segment 1D algorithm for discretization with python function. More...
class Mesh_Netgen

Class to define a NETGEN-based 2D or 3D algorithm that need no discrete boundary (i.e. More...
class Mesh_Projection1D
Class to define a projection 1D algorithm. More...
class Mesh_Projection2D
Class to define a projection 2D algorithm. More...
class Mesh_Projection3D
Class to define a projection 3D algorithm. More...
class Mesh_Prism3D
Class to define a 3D extrusion algorithm. More...
class Mesh_RadialPrism3D
Class to define a Radial Prism 3D algorithm. More...

class Mesh

Class to define a mesh. More...

Functions

def GetName
Gets object name.

def SetName
Sets name to object.
def EnumToLong
Returns long value from enumeration Uses for SMESH.FunctorType enumeration.
def GetPointStruct
Get PointStruct from vertex.
def GetDirStruct
Get DirStruct from vector.
def GetAxisStruct
Get AxisStruct from object.
def SetEmbeddedMode
Set the current mode.
def IsEmbeddedMode
Get the current mode.
def SetCurrentStudy
Set the current study.
def GetCurrentStudy
Get the current study.
def CreateMeshesFromUNV
Create Mesh object importing data from given UNV file.
def CreateMeshesFromMED
Create Mesh object(s) importing data from given MED file.
def CreateMeshesFromSTL
Create Mesh object importing data from given STL file.
def GetSubShapesId
From SMESH_Gen interface.
def GetPattern
From SMESH_Gen interface.
def GetEmptyCriterion
Creates an empty criterion.
def GetCriterion
Creates a criterion by given parameters.
def GetFilter
Creates filter by given parameters of criterion.
def GetFunctor
Creates numerical functor by its type.
def TreatHypoStatus
Print error message if a hypothesis was not assigned.

Variables
int noNETGENPlugin = 0
int noNETGENPlugin = 1
int REGULAR = 1

int PYTHON = 2
int NETGEN = 3
int COMPOSITE = 3
int GHS3D = 4
int MEFISTO = 3
tuple smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH")
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
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

string NO_NAME = "NoName"
tuple smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH")

Function Documentation

@@ -125,14 +249,18 @@ Python package smesh defines several classes, destined for easy and clear mesh c -

Variable Documentation

@@ -149,13 +277,18 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + + +

int smesh.REGULAR = 1 [static] def smesh.EnumToLong ( theItem )

-

@@ -169,16 +302,61 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + + +

int smesh.PYTHON = 2 [static] def smesh.GetPointStruct ( theVertex )

+
Parameters:
+ + +
theVertex is GEOM object(vertex)
+
+
Returns:
SMESH.PointStruct

-

+ + + + +
+ + + + + + + + + +
def smesh.GetDirStruct ( theVector )
+
+ + + + + +
+ + + +
+
Parameters:
+ + +
theVector is GEOM object(vector)
+
+
Returns:
SMESH.DirStruct
+
+

@@ -192,16 +370,27 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + + +

int smesh.NETGEN = 3 [static] def smesh.GetAxisStruct ( theObj )

+
Parameters:
+ + +
theObj is GEOM object(line or plane)
+
+
Returns:
SMESH.AxisStruct

-

@@ -218,13 +407,17 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + + +

int smesh.GHS3D = 4 [static] def smesh.SetEmbeddedMode ( theMode )

-

@@ -241,13 +434,18 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + +

tuple smesh.smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH") [static] def smesh.IsEmbeddedMode ( )

-

@@ -264,5 +462,1033 @@ Python package smesh defines several classes, destined for easy and clear mesh c

- + + + + + +

string smesh.NO_NAME = "NoName" [static] def smesh.SetCurrentStudy ( theStudy )

- - +

+ + + + +
+ + + + + + + + +
def smesh.GetCurrentStudy ( )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
def smesh.CreateMeshesFromUNV ( theFileName )
+
+ + + + + +
+ + + +
+
Returns:
an instance of Mesh class
+
+

+ + + + +
+ + + + + + + + + +
def smesh.CreateMeshesFromMED ( theFileName )
+
+ + + + + +
+ + + +
+
Returns:
a list of Mesh class instances
+
+

+ + + + +
+ + + + + + + + + +
def smesh.CreateMeshesFromSTL ( theFileName )
+
+ + + + + +
+ + + +
+
Returns:
an instance of Mesh class
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
def smesh.GetSubShapesId ( theMainObject,
theListOfSubObjects
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + +
def smesh.GetPattern ( )
+
+ + + + + +
+ + + +
+Creates pattern
+

+ + + + +
+ + + + + + + + +
def smesh.GetEmptyCriterion ( )
+
+ + + + + +
+ + + +
+
Returns:
SMESH.Filter.Criterion
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
def smesh.GetCriterion ( elementType,
CritType,
Compare = FT_EqualTo,
Treshold = "",
UnaryOp = FT_Undefined,
BinaryOp = FT_Undefined
)
+
+ + + + + +
+ + + +
+
Parameters:
+ + + + + + + +
elementType is the type of elements(NODE, EDGE, FACE, VOLUME)
CritType is type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
Compare belong to {FT_LessThan, FT_MoreThan, FT_EqualTo}
Treshold is threshold value (range of ids as string, shape, numeric)
UnaryOp is FT_LogicalNOT or FT_Undefined
BinaryOp is binary logical operation FT_LogicalAND, FT_LogicalOR or FT_Undefined(must be for the last criterion in criteria)
+
+
Returns:
SMESH.Filter.Criterion
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
def smesh.GetFilter ( elementType,
CritType = FT_Undefined,
Compare = FT_EqualTo,
Treshold = "",
UnaryOp = FT_Undefined
)
+
+ + + + + +
+ + + +
+
Parameters:
+ + + + + + +
elementType is the type of elements in the group
CritType is type of criterion( FT_Taper, FT_Area, FT_RangeOfIds, FT_LyingOnGeom etc. )
Compare belong to {FT_LessThan, FT_MoreThan, FT_EqualTo}
Treshold is threshold value (range of id ids as string, shape, numeric)
UnaryOp is FT_LogicalNOT or FT_Undefined
+
+
Returns:
SMESH_Filter
+
+

+ + + + +
+ + + + + + + + + +
def smesh.GetFunctor ( theCriterion )
+
+ + + + + +
+ + + +
+
Parameters:
+ + +
theCrierion is FT_...; functor type
+
+
Returns:
SMESH_NumericalFunctor
+
+

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

Variable Documentation

+ + + + +
+ + + + +
int smesh.noNETGENPlugin = 0 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.noNETGENPlugin = 1 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.REGULAR = 1 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.PYTHON = 2 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.COMPOSITE = 3 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.MEFISTO = 3 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.NETGEN = 4 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.GHS3D = 5 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.FULL_NETGEN = 6 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.NETGEN_2D = 7 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.NETGEN_1D2D = NETGEN [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.NETGEN_1D2D3D = FULL_NETGEN [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.NETGEN_FULL = FULL_NETGEN [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.POINT = SMESH_MeshEditor.POINT [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.AXIS = SMESH_MeshEditor.AXIS [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.PLANE = SMESH_MeshEditor.PLANE [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.LAPLACIAN_SMOOTH = SMESH_MeshEditor.LAPLACIAN_SMOOTH [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
smesh.CENTROIDAL_SMOOTH = SMESH_MeshEditor.CENTROIDAL_SMOOTH [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.VeryCoarse = 0 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.Coarse = 1 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.Moderate = 2 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.Fine = 3 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.VeryFine = 4 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
int smesh.Custom = 5 [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
string smesh.NO_NAME = "NoName" [static]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + +
tuple smesh.smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH") [static]
+
+ + + + + +
+ + + +
+
+ +

+ +


Data Structures
class	Mesh_Algorithm
	Mother class to define algorithm, recommended to don't use directly. More...
	Mother class to define algorithm, recommended to do not use directly. More...
class	Mesh_Segment
	Class to define a segment 1D algorithm for discretization. More...
class	Mesh_CompositeSegment
	Class to define a segment 1D algorithm for discretization. More...
class	Mesh_Segment_Python
	Class to define a segment 1D algorithm for discretization with python function. More...
class	Mesh_Netgen
	Class to define a NETGEN-based 2D or 3D algorithm that need no discrete boundary (i.e. More...
class	Mesh_Projection1D
	Class to define a projection 1D algorithm. More...
class	Mesh_Projection2D
	Class to define a projection 2D algorithm. More...
class	Mesh_Projection3D
	Class to define a projection 3D algorithm. More...
class	Mesh_Prism3D
	Class to define a 3D extrusion algorithm. More...
class	Mesh_RadialPrism3D
	Class to define a Radial Prism 3D algorithm. More...
class	Mesh
	Class to define a mesh. More...
Functions
def	GetName
	Gets object name.
def	SetName
	Sets name to object.
def	EnumToLong
	Returns long value from enumeration Uses for SMESH.FunctorType enumeration.
def	GetPointStruct
	Get PointStruct from vertex.
def	GetDirStruct
	Get DirStruct from vector.
def	GetAxisStruct
	Get AxisStruct from object.
def	SetEmbeddedMode
	Set the current mode.
def	IsEmbeddedMode
	Get the current mode.
def	SetCurrentStudy
	Set the current study.
def	GetCurrentStudy
	Get the current study.
def	CreateMeshesFromUNV
	Create Mesh object importing data from given UNV file.
def	CreateMeshesFromMED
	Create Mesh object(s) importing data from given MED file.
def	CreateMeshesFromSTL
	Create Mesh object importing data from given STL file.
def	GetSubShapesId
	From SMESH_Gen interface.
def	GetPattern
	From SMESH_Gen interface.
def	GetEmptyCriterion
	Creates an empty criterion.
def	GetCriterion
	Creates a criterion by given parameters.
def	GetFilter
	Creates filter by given parameters of criterion.
def	GetFunctor
	Creates numerical functor by its type.
def	TreatHypoStatus
	Print error message if a hypothesis was not assigned.
Variables
int	noNETGENPlugin = 0
int	noNETGENPlugin = 1
int	REGULAR = 1
int	PYTHON = 2
int	NETGEN = 3
int	COMPOSITE = 3
int	GHS3D = 4
int	MEFISTO = 3
tuple	smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH")
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
	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
string	NO_NAME = "NoName"
tuple	smesh = salome.lcc.FindOrLoadComponent("FactoryServer", "SMESH")