iron.MeshElements Class Reference

Inheritance diagram for iron.MeshElements:

Collaboration diagram for iron.MeshElements:

Public Member Functions
def	__init__ (self)
def	AdjacentElementGet (self, globalElementNumber, adjacentElementXi)
def	BasisGet (self, globalElementNumber, basis)
def	BasisSet (self, globalElementNumber, basis)
def	CreateFinish (self)
def	CreateStart (self, mesh, meshComponentNumber, basis)
def	Finalise (self)
def	LocalElementNodeVersionSet (self, globalElementNumber, versionNumber, derivativeNumber, localElementNodeNumber)
def	NodesGet (self, globalElementNumber, elementUserNodesSize)
def	NodesSet (self, globalElementNumber, elementUserNodes)
def	UserNodeVersionSet (self, globalElementNumber, versionNumber, derivativeNumber, userNodeNumber)
def	UserNumberGet (self, elementGlobalNumber)
def	UserNumberSet (self, elementGlobalNumber, elementUserNumber)
def	UserNumbersAllSet (self, elementUserNumbers)

Public Attributes
	cmiss_type

Properties
	userNumbersAll = property(None, UserNumbersAllSet, None, )

Detailed Description

Contains information on a mesh elements defined in a mesh

Definition at line 6442 of file iron.py.

Constructor & Destructor Documentation

def iron.MeshElements.__init__

(

self

)

Initialise a null cmfe_MeshElementsType

Definition at line 6446 of file iron.py.

Member Function Documentation

def iron.MeshElements.AdjacentElementGet	(		self,
			globalElementNumber,
			adjacentElementXi
	)

Returns the adjacent element number of a mesh identified by an object.

:param globalElementNumber: The global element number to get the adjacent element for !\todo this should be a user number
:type globalElementNumber: int
:param adjacentElementXi: The xi coordinate direction to get the adjacent element for  Note that -xiCoordinateDirection gives the adjacent element before the element in the xiCoordinateDirection'th direction and +xiCoordinateDirection gives the adjacent element after the element in the xiCoordinateDirection'th direction. The xiCoordinateDirection=0 index will give the information on the current element.
:type adjacentElementXi: int
:returns: adjacentElement. The adjacent element number in the specified xi coordinate direction. Return 0 if the specified element has no adjacent elements in the specified xi coordinate direction.
:rtype: int

Definition at line 6451 of file iron.py.

def iron.MeshElements.BasisGet	(		self,
			globalElementNumber,
			basis
	)

Returns the basis for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to get the basis for.
:type globalElementNumber: int
:param basis: On return, the basis for the element.
:type basis: Basis
:rtype: None

Definition at line 6465 of file iron.py.

def iron.MeshElements.BasisSet	(		self,
			globalElementNumber,
			basis
	)

Sets/changes the basis for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to set the basis for.
:type globalElementNumber: int
:param basis: The basis for the element to set.
:type basis: Basis
:rtype: None

Definition at line 6478 of file iron.py.

def iron.MeshElements.CreateFinish

(

self

)

Finishes creating elements for a mesh component of a mesh identified by an object.

:rtype: None

Definition at line 6491 of file iron.py.

def iron.MeshElements.CreateStart	(		self,
			mesh,
			meshComponentNumber,
			basis
	)

Starts creating elements for a mesh component of a mesh identified by an object.

:param mesh: The mesh to start the creation of elements for.
:type mesh: Mesh
:param meshComponentNumber: The mesh component number of the mesh to start creating the elements for.
:type meshComponentNumber: int
:param basis: The default basis to use for the elements.
:type basis: Basis
:rtype: None

Definition at line 6500 of file iron.py.

def iron.MeshElements.Finalise

(

self

)

Finalises a cmfe_MeshElementsType object.

:rtype: None

Definition at line 6515 of file iron.py.

def iron.MeshElements.LocalElementNodeVersionSet	(		self,
			globalElementNumber,
			versionNumber,
			derivativeNumber,
			localElementNodeNumber
	)

Sets/changes the element nodes for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to set the element nodes for.
:type globalElementNumber: int
:param versionNumber: The version number of the specified element node to set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the specified element node to set.
:type derivativeNumber: int
:param localElementNodeNumber: The local element node to set a version for.
:type localElementNodeNumber: int
:rtype: None

Definition at line 6524 of file iron.py.

def iron.MeshElements.NodesGet	(		self,
			globalElementNumber,
			elementUserNodesSize
	)

Returns the element nodes for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to get the element nodes for.
:type globalElementNumber: int
:param elementUserNodesSize: Size of elementUserNodes to allocate.
:returns: elementUserNodes. elementUserNodes(i). On return, the user node number number of the i'th element node.
:rtype: Array of ints

Definition at line 6541 of file iron.py.

def iron.MeshElements.NodesSet	(		self,
			globalElementNumber,
			elementUserNodes
	)

Sets/changes the element nodes for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to set the element nodes for.
:type globalElementNumber: int
:param elementUserNodes: elementUserNodes(i). The user node number number of the i'th element node to set.
:type elementUserNodes: Array of ints
:rtype: None

Definition at line 6554 of file iron.py.

def iron.MeshElements.UserNodeVersionSet	(		self,
			globalElementNumber,
			versionNumber,
			derivativeNumber,
			userNodeNumber
	)

Sets/changes the element nodes for an element in a mesh identified by an object. \todo should the global element number be a user number?

:param globalElementNumber: The global element number to set the element nodes for.
:type globalElementNumber: int
:param versionNumber: The version number of the specified element node to set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the specified element node to set.
:type derivativeNumber: int
:param userNodeNumber: The user node number to set a version for.
:type userNodeNumber: int
:rtype: None

Definition at line 6567 of file iron.py.

def iron.MeshElements.UserNumberGet	(		self,
			elementGlobalNumber
	)

Returns the element user number for an element in a mesh identified by an object.

:param elementGlobalNumber: The global element number to get the element user number for.
:type elementGlobalNumber: int
:returns: elementUserNumber. The element user number.
:rtype: int

Definition at line 6584 of file iron.py.

def iron.MeshElements.UserNumbersAllSet	(		self,
			elementUserNumbers
	)

Sets/changes the element user numbers for all elements in a mesh identified by an object.

:param elementUserNumbers: The element user numbers to set.
:type elementUserNumbers: Array of ints
:rtype: None

Definition at line 6609 of file iron.py.

def iron.MeshElements.UserNumberSet	(		self,
			elementGlobalNumber,
			elementUserNumber
	)

Sets/changes the element user number for an element in a mesh identified by an object.

:param elementGlobalNumber: The global element number to set the element user number for.
:type elementGlobalNumber: int
:param elementUserNumber: The element user number to set.
:type elementUserNumber: int
:rtype: None

Definition at line 6596 of file iron.py.

Member Data Documentation

iron.MeshElements.cmiss_type

Definition at line 6449 of file iron.py.

Property Documentation

iron.MeshElements.userNumbersAll = property(None, UserNumbersAllSet, None, )

static

Definition at line 6620 of file iron.py.