iron.GeneratedMesh Class Reference

Inheritance diagram for iron.GeneratedMesh:

Collaboration diagram for iron.GeneratedMesh:

Public Member Functions
def	__init__ (self)
def	BaseVectorsSet (self, baseVectors)
def	BasisGet (self, bases)
def	BasisSet (self, bases)
def	CreateFinish (self, meshUserNumber, mesh)
def	CreateStartInterface (self, generatedMeshUserNumber, interface)
def	CreateStart (self, generatedMeshUserNumber, region)
def	Destroy (self)
def	ExtentGet (self, extentSize)
def	ExtentSet (self, extent)
def	Finalise (self)
def	GeometricParametersCalculate (self, field)
def	NumberOfElementsGet (self, numberOfElementsSize)
def	NumberOfElementsSet (self, numberOfElements)
def	OriginGet (self, originSize)
def	OriginSet (self, origin)
def	TypeGet (self)
def	TypeSet (self, generatedMeshType)

Public Attributes
	cmiss_type

Properties
	origin = property(OriginGet, OriginSet, None, )
	basis = property(BasisGet, BasisSet, None, )
	baseVectors = property(None, BaseVectorsSet, None, )
	extent = property(ExtentGet, ExtentSet, None, )
	type = property(TypeGet, TypeSet, None, )
	numberOfElements = property(NumberOfElementsGet, NumberOfElementsSet, None, )

Detailed Description

Contains information on a generated mesh.

Definition at line 5573 of file iron.py.

Constructor & Destructor Documentation

def iron.GeneratedMesh.__init__

(

self

)

Initialise a null cmfe_GeneratedMeshType

Definition at line 5577 of file iron.py.

Member Function Documentation

def iron.GeneratedMesh.BaseVectorsSet	(		self,
			baseVectors
	)

Sets/changes the base vectors for a generated mesh identified by an object.

:param baseVectors: baseVectors(coordinate_idx,xi_idx). The base vectors to set.
:type baseVectors: 2d array of floats
:rtype: None

Definition at line 5582 of file iron.py.

def iron.GeneratedMesh.BasisGet	(		self,
			bases
	)

Returns the basis for a generated mesh identified by an object.

:param bases: On return, the array of bases.
:type bases: Array of Basis objects
:rtype: None

Definition at line 5593 of file iron.py.

def iron.GeneratedMesh.BasisSet	(		self,
			bases
	)

Sets/changes the basis for a generated mesh identified by an object.

:param bases: The bases to set.
:type bases: Array of Basis objects
:rtype: None

Definition at line 5604 of file iron.py.

def iron.GeneratedMesh.CreateFinish	(		self,
			meshUserNumber,
			mesh
	)

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

:param meshUserNumber: The user number of the mesh to generate.
:type meshUserNumber: int
:param mesh: On return, the generated mesh.
:type mesh: Mesh
:rtype: None

Definition at line 5615 of file iron.py.

def iron.GeneratedMesh.CreateStart	(		self,
			generatedMeshUserNumber,
			region
	)

Starts the creation of a generated mesh on a region identified by an object.

:param generatedMeshUserNumber: The user number of the generated mesh to create.
:type generatedMeshUserNumber: int
:param region: The region to created generated mesh in.
:type region: Region
:rtype: None

Definition at line 5641 of file iron.py.

def iron.GeneratedMesh.CreateStartInterface	(		self,
			generatedMeshUserNumber,
			interface
	)

Starts the creation of a generated mesh on an interface identified by an object.

:param generatedMeshUserNumber: The user number of the generated mesh to create.
:type generatedMeshUserNumber: int
:param interface: The interface to created generated mesh in.
:type interface: Interface
:rtype: None

Definition at line 5628 of file iron.py.

def iron.GeneratedMesh.Destroy

(

self

)

Destroys a generated mesh identified by an object.

:rtype: None

Definition at line 5654 of file iron.py.

def iron.GeneratedMesh.ExtentGet	(		self,
			extentSize
	)

Returns the extent for a generated mesh identified by an object.

:param extentSize: Size of extent to allocate.
:returns: extent. extent(i). On return, the extent for the i'th dimension of the generated mesh.
:rtype: Array of floats

Definition at line 5663 of file iron.py.

def iron.GeneratedMesh.ExtentSet	(		self,
			extent
	)

Sets/changes the extent for a generated mesh identified by an object.

:param extent: extent(i). the extent for the i'th dimension of the generated mesh to set.
:type extent: Array of floats
:rtype: None

Definition at line 5674 of file iron.py.

def iron.GeneratedMesh.Finalise

(

self

)

Finalises a cmfe_GeneratedMeshType object.

:rtype: None

Definition at line 5685 of file iron.py.

def iron.GeneratedMesh.GeometricParametersCalculate	(		self,
			field
	)

Calculates and sets the geometric field parameters for a generated mesh identified by an object.

:param field: The field to calculate the geometric parameters for
:type field: Field
:rtype: None

Definition at line 5694 of file iron.py.

def iron.GeneratedMesh.NumberOfElementsGet	(		self,
			numberOfElementsSize
	)

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

:param numberOfElementsSize: Size of numberOfElements to allocate.
:returns: numberOfElements. numberOfElements(i). On return, the number of elements in the i'th dimension of the generated mesh.
:rtype: Array of ints

Definition at line 5705 of file iron.py.

def iron.GeneratedMesh.NumberOfElementsSet	(		self,
			numberOfElements
	)

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

:param numberOfElements: numberOfElements(i). The number of elements in the i'th dimension of the generated mesh to set.
:type numberOfElements: Array of ints
:rtype: None

Definition at line 5716 of file iron.py.

def iron.GeneratedMesh.OriginGet	(		self,
			originSize
	)

Returns the origin of a generated mesh identified by an object.

:param originSize: Size of origin to allocate.
:returns: origin. origin(i). On return, the origin of the i'th dimension of the generated mesh.
:rtype: Array of floats

Definition at line 5727 of file iron.py.

def iron.GeneratedMesh.OriginSet	(		self,
			origin
	)

Sets/changes the origin of a generated mesh identified by an object.

:param origin: origin(i). The origin of the i'th dimension of the generated mesh to set.
:type origin: Array of floats
:rtype: None

Definition at line 5738 of file iron.py.

def iron.GeneratedMesh.TypeGet

(

self

)

Returns the type of a generated mesh identified by an object.

:returns: generatedMeshType. The type of the generated mesh. Will be a value from the GeneratedMeshTypes enum.
:rtype: int

Definition at line 5749 of file iron.py.

def iron.GeneratedMesh.TypeSet	(		self,
			generatedMeshType
	)

Sets/changes the type of a generated mesh identified by an object.

:param generatedMeshType: The type of the generated mesh to set. Must be a value from the GeneratedMeshTypes enum.
:type generatedMeshType: int
:rtype: None

Definition at line 5759 of file iron.py.

Member Data Documentation

iron.GeneratedMesh.cmiss_type

Definition at line 5580 of file iron.py.

Property Documentation

iron.GeneratedMesh.baseVectors = property(None, BaseVectorsSet, None, )

static

Definition at line 5774 of file iron.py.

iron.GeneratedMesh.basis = property(BasisGet, BasisSet, None, )

static

Definition at line 5772 of file iron.py.

iron.GeneratedMesh.extent = property(ExtentGet, ExtentSet, None, )

static

Definition at line 5776 of file iron.py.

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

static

Definition at line 5780 of file iron.py.

iron.GeneratedMesh.origin = property(OriginGet, OriginSet, None, )

static

Definition at line 5770 of file iron.py.

iron.GeneratedMesh.type = property(TypeGet, TypeSet, None, )

static

Definition at line 5778 of file iron.py.