iron.Mesh Class Reference

Inheritance diagram for iron.Mesh:

Collaboration diagram for iron.Mesh:

Public Member Functions
def	__init__ (self)
def	CreateFinish (self)
def	CreateStartInterface (self, meshUserNumber, interface, numberOfDimensions)
def	CreateStart (self, meshUserNumber, region, numberOfDimensions)
def	Destroy (self)
def	ElementExists (self, meshComponentNumber, elementUserNumber)
def	ElementsGet (self, meshComponentNumber, meshElements)
def	Finalise (self)
def	NodeExists (self, meshComponentNumber, nodeUserNumber)
def	NodesGet (self, meshComponentNumber, meshNodes)
def	NumberOfComponentsGet (self)
def	NumberOfComponentsSet (self, numberOfComponents)
def	NumberOfElementsGet (self)
def	NumberOfElementsSet (self, numberOfElements)
def	SurroundingElementsCalculateSet (self, surroundingElementsCalculateFlag)
def	TopologyDataPointsCalculateProjection (self, DataProjection)

Public Attributes
	cmiss_type

Properties
	numberOfComponents = property(NumberOfComponentsGet, NumberOfComponentsSet, None, )
	surroundingElementsCalculate = property(None, SurroundingElementsCalculateSet, None, )
	numberOfElements = property(NumberOfElementsGet, NumberOfElementsSet, None, )

Detailed Description

Contains information on a mesh defined on a region.

Definition at line 6780 of file iron.py.

Constructor & Destructor Documentation

def iron.Mesh.__init__

(

self

)

Initialise a null cmfe_MeshType

Definition at line 6784 of file iron.py.

Member Function Documentation

def iron.Mesh.CreateFinish

(

self

)

Finishes the creation of a mesh for a mesh identified by an object.

:rtype: None

Definition at line 6789 of file iron.py.

def iron.Mesh.CreateStart	(		self,
			meshUserNumber,
			region,
			numberOfDimensions
	)

Starts the creation of a mesh for a mesh identified by an object.

:param meshUserNumber: The user number of the mesh to start the creation of.
:type meshUserNumber: int
:param region: The region containing the mesh to start the creation of.
:type region: Region
:param numberOfDimensions: The number of dimensions for the mesh.
:type numberOfDimensions: int
:rtype: None

Definition at line 6813 of file iron.py.

def iron.Mesh.CreateStartInterface	(		self,
			meshUserNumber,
			interface,
			numberOfDimensions
	)

Starts the creation of a mesh for a mesh identified by an object.

:param meshUserNumber: The user number of the mesh to start the creation of.
:type meshUserNumber: int
:param interface: The interface containing the mesh to start the creation of.
:type interface: Interface
:param numberOfDimensions: The number of dimensions for the mesh.
:type numberOfDimensions: int
:rtype: None

Definition at line 6798 of file iron.py.

def iron.Mesh.Destroy

(

self

)

Destroys a mesh identified by an object.

:rtype: None

Definition at line 6828 of file iron.py.

def iron.Mesh.ElementExists	(		self,
			meshComponentNumber,
			elementUserNumber
	)

Checks if the given element exists on the given mesh component.

:param meshComponentNumber: The mesh component number to check the element for.
:type meshComponentNumber: int
:param elementUserNumber: The user number of the element to check.
:type elementUserNumber: int
:returns: elementExists. True if the element exists, false otherwise.
:rtype: bool

Definition at line 6837 of file iron.py.

def iron.Mesh.ElementsGet	(		self,
			meshComponentNumber,
			meshElements
	)

:param meshComponentNumber: The mesh component number to get the elements for.
:type meshComponentNumber: int
:param meshElements: The mesh elements.
:type meshElements: MeshElements
:rtype: None

Definition at line 6851 of file iron.py.

def iron.Mesh.Finalise

(

self

)

Finalises a cmfe_MeshType object.

:rtype: None

Definition at line 6862 of file iron.py.

def iron.Mesh.NodeExists	(		self,
			meshComponentNumber,
			nodeUserNumber
	)

Checks if the given node exists on the given mesh component.

:param meshComponentNumber: The mesh component number to check the node for.
:type meshComponentNumber: int
:param nodeUserNumber: The user number of the node to check.
:type nodeUserNumber: int
:returns: nodeExists. True if the node exists, false otherwise.
:rtype: bool

Definition at line 6871 of file iron.py.

def iron.Mesh.NodesGet	(		self,
			meshComponentNumber,
			meshNodes
	)

Returns the mesh nodes for a mesh component on a mesh identified by an object.

:param meshComponentNumber: The mesh component number to get the nodes for.
:type meshComponentNumber: int
:param meshNodes: On return, the mesh nodes.
:type meshNodes: MeshNodes
:rtype: None

Definition at line 6885 of file iron.py.

def iron.Mesh.NumberOfComponentsGet

(

self

)

Returns the number of components in a mesh identified by an object.

:returns: numberOfComponents. The number of components in the mesh.
:rtype: int

Definition at line 6898 of file iron.py.

def iron.Mesh.NumberOfComponentsSet	(		self,
			numberOfComponents
	)

Sets/changes the number of components in a mesh identified by an object.

:param numberOfComponents: The number of components in the mesh to set.
:type numberOfComponents: int
:rtype: None

Definition at line 6908 of file iron.py.

def iron.Mesh.NumberOfElementsGet

(

self

)

Returns the number of elements in a mesh identified by an object.

:returns: numberOfElements. The number of elements in the mesh.
:rtype: int

Definition at line 6919 of file iron.py.

def iron.Mesh.NumberOfElementsSet	(		self,
			numberOfElements
	)

Sets/changes the number of elements in a mesh identified by an object.

:param numberOfElements: The number of elements in the mesh to set.
:type numberOfElements: int
:rtype: None

Definition at line 6929 of file iron.py.

def iron.Mesh.SurroundingElementsCalculateSet	(		self,
			surroundingElementsCalculateFlag
	)

Sets/changes the surrounding elements calculate flag.

:param surroundingElementsCalculateFlag: Boolean flag to determine whether to calculate surrounding elements.
:type surroundingElementsCalculateFlag: bool
:rtype: None

Definition at line 6940 of file iron.py.

def iron.Mesh.TopologyDataPointsCalculateProjection	(		self,
			DataProjection
	)

Calculate mesh data points topology identified by object based on projection

:param DataProjection: The data projection
:type DataProjection: DataProjection
:rtype: None

Definition at line 6951 of file iron.py.

Member Data Documentation

iron.Mesh.cmiss_type

Definition at line 6787 of file iron.py.

Property Documentation

iron.Mesh.numberOfComponents = property(NumberOfComponentsGet, NumberOfComponentsSet, None, )

static

Definition at line 6962 of file iron.py.

iron.Mesh.numberOfElements = property(NumberOfElementsGet, NumberOfElementsSet, None, )

static

Definition at line 6966 of file iron.py.

iron.Mesh.surroundingElementsCalculate = property(None, SurroundingElementsCalculateSet, None, )

static

Definition at line 6964 of file iron.py.