iron.InterfacePointsConnectivity Class Reference

Inheritance diagram for iron.InterfacePointsConnectivity:

Collaboration diagram for iron.InterfacePointsConnectivity:

Public Member Functions
def	__init__ (self)
def	CreateFinish (self)
def	CreateStart (self, interface, interfaceMesh)
def	Destroy (self)
def	ElementNumberGet (self, interfaceDataPointIndexNumber, coupledMeshIndexNumber, meshComponentNumber)
def	ElementNumberSet (self, interfaceDataPointIndexNumber, coupledMeshIndexNumber, coupledMeshElementNumber, meshComponentNumber)
def	Finalise (self)
def	PointXiGet (self, interfaceDataPointIndexNumber, coupledMeshIndexNumber, xiSize)
def	PointXiSet (self, interfaceDataPointIndexNumber, coupledMeshIndexNumber, xi)
def	UpdateFromProjection (self, dataProjection, coupledMeshIndex)

Public Attributes
	cmiss_type

Detailed Description

Contains information on an interfaces points connectivity.

Definition at line 6194 of file iron.py.

Constructor & Destructor Documentation

def iron.InterfacePointsConnectivity.__init__

(

self

)

Initialise a null cmfe_InterfacePointsConnectivityType

Definition at line 6198 of file iron.py.

Member Function Documentation

def iron.InterfacePointsConnectivity.CreateFinish

(

self

)

Finishes the creation of an interface meshes connectivity identified by an object.

:rtype: None

Definition at line 6203 of file iron.py.

def iron.InterfacePointsConnectivity.CreateStart	(		self,
			interface,
			interfaceMesh
	)

Starts the creation of an interface points connectivity identified by an object.

:param interface: The interface to start the creation of the meshes connectivity for
:type interface: Interface
:param interfaceMesh:
:type interfaceMesh: Mesh
:rtype: None

Definition at line 6212 of file iron.py.

def iron.InterfacePointsConnectivity.Destroy

(

self

)

Destroys an interface points connectivity identified by an object.

:rtype: None

Definition at line 6225 of file iron.py.

def iron.InterfacePointsConnectivity.ElementNumberGet	(		self,
			interfaceDataPointIndexNumber,
			coupledMeshIndexNumber,
			meshComponentNumber
	)

Gets coupled mesh element number that the data point in the interface is connected to

:param interfaceDataPointIndexNumber: The index of the interface data point, i.e.user defined global number
:type interfaceDataPointIndexNumber: int
:param coupledMeshIndexNumber: The index number of the coupled mesh
:type coupledMeshIndexNumber: int
:param meshComponentNumber: The mesh component number of the interface mesh that points connectivity is associated to
:type meshComponentNumber: int
:returns: coupledMeshElementNumber. The element number where the data point is projected to.
:rtype: int

Definition at line 6234 of file iron.py.

def iron.InterfacePointsConnectivity.ElementNumberSet	(		self,
			interfaceDataPointIndexNumber,
			coupledMeshIndexNumber,
			coupledMeshElementNumber,
			meshComponentNumber
	)

Sets coupled mesh element number that the data point in the interface is connected to

:param interfaceDataPointIndexNumber: The index of the interface data point, i.e.user defined global number
:type interfaceDataPointIndexNumber: int
:param coupledMeshIndexNumber: The index number of the coupled mesh
:type coupledMeshIndexNumber: int
:param coupledMeshElementNumber: The element number where the data point is projected to.
:type coupledMeshElementNumber: int
:param meshComponentNumber: The mesh component number to set the points connectivity element number for
:type meshComponentNumber: int
:rtype: None

Definition at line 6250 of file iron.py.

def iron.InterfacePointsConnectivity.Finalise

(

self

)

Finalise a cmfe_InterfaceMeshConnectivityType object.

:rtype: None

Definition at line 6267 of file iron.py.

def iron.InterfacePointsConnectivity.PointXiGet	(		self,
			interfaceDataPointIndexNumber,
			coupledMeshIndexNumber,
			xiSize
	)

Gets the xi coordinate mapping between the interface data points and xi coordinates in a coupled region mesh

:param interfaceDataPointIndexNumber: The index of the interface data point, i.e.user defined global number
:type interfaceDataPointIndexNumber: int
:param coupledMeshIndexNumber: The index number of the coupled mesh
:type coupledMeshIndexNumber: int
:param xiSize: Size of xi to allocate.
:returns: xi. xi(xiIdx). The full xi location in the coupled mesh that the data point is connected to
:rtype: Array of floats

Definition at line 6276 of file iron.py.

def iron.InterfacePointsConnectivity.PointXiSet	(		self,
			interfaceDataPointIndexNumber,
			coupledMeshIndexNumber,
			xi
	)

Sets the xi coordinate mapping between the interface data points and xi coordinates in a coupled region mesh

:param interfaceDataPointIndexNumber: The index of the interface data point, i.e.user defined global number
:type interfaceDataPointIndexNumber: int
:param coupledMeshIndexNumber: The index number of the coupled mesh
:type coupledMeshIndexNumber: int
:param xi: xi(xiIdx). The full xi location in the coupled mesh that the data point is connected to
:type xi: Array of floats
:rtype: None

Definition at line 6291 of file iron.py.

def iron.InterfacePointsConnectivity.UpdateFromProjection	(		self,
			dataProjection,
			coupledMeshIndex
	)

Update points connectivity with projection results, data projection identified by object

:param dataProjection: The data projection to update points connectivity with
:type dataProjection: DataProjection
:param coupledMeshIndex: The mesh index of the the points connectivity to be updated
:type coupledMeshIndex: int
:rtype: None

Definition at line 6306 of file iron.py.

Member Data Documentation

iron.InterfacePointsConnectivity.cmiss_type

Definition at line 6201 of file iron.py.