iron.Interface Class Reference

Inheritance diagram for iron.Interface:

Collaboration diagram for iron.Interface:

Public Member Functions
def	__init__ (self)
def	CoordinateSystemGet (self, CoordinateSystem)
def	CoordinateSystemSet (self, coordinateSystem)
def	CreateFinish (self)
def	CreateStart (self, interfaceUserNumber, region)
def	Destroy (self)
def	Finalise (self)
def	LabelGet (self)
def	LabelSet (self, label)
def	MeshAdd (self, mesh)
def	NodesGet (self, nodes)

Public Attributes
	cmiss_type

Properties
	nodes = property(NodesGet, None, None, )
	coordinateSystem = property(CoordinateSystemGet, CoordinateSystemSet, None, )
	label = property(LabelGet, LabelSet, None, )

Detailed Description

Contains information about an interface.

Definition at line 6320 of file iron.py.

Constructor & Destructor Documentation

def iron.Interface.__init__

(

self

)

Initialise a null cmfe_InterfaceType

Definition at line 6324 of file iron.py.

Member Function Documentation

def iron.Interface.CoordinateSystemGet	(		self,
			CoordinateSystem
	)

Returns the coordinate system for an interface identified by an object.

:param CoordinateSystem: On return, the interface coordinate system.
:type CoordinateSystem: CoordinateSystem
:rtype: None

Definition at line 6329 of file iron.py.

def iron.Interface.CoordinateSystemSet	(		self,
			coordinateSystem
	)

Sets/changes the coordinate system for an interface identified by an object.

:param coordinateSystem: The coordinate system to set.
:type coordinateSystem: CoordinateSystem
:rtype: None

Definition at line 6340 of file iron.py.

def iron.Interface.CreateFinish

(

self

)

Finishes the creation of an interface identified by an object.

:rtype: None

Definition at line 6351 of file iron.py.

def iron.Interface.CreateStart	(		self,
			interfaceUserNumber,
			region
	)

Starts the creation of an interface identified by an object.

:param interfaceUserNumber: The user number of the field to start the creation of.
:type interfaceUserNumber: int
:param region: The region to create the interface on.
:type region: Region
:rtype: None

Definition at line 6360 of file iron.py.

def iron.Interface.Destroy

(

self

)

Destroys an interface identified by an object.

:rtype: None

Definition at line 6373 of file iron.py.

def iron.Interface.Finalise

(

self

)

Finalises a cmfe_InterfaceType object.

:rtype: None

Definition at line 6382 of file iron.py.

def iron.Interface.LabelGet

(

self

)

Returns the character string label for an interface identified by an object.

:returns: label. The region label.
:rtype: string

Definition at line 6391 of file iron.py.

def iron.Interface.LabelSet	(		self,
			label
	)

Sets/changes the character string label for an interface identified by an object.

:param label: The interface label to set.
:type label: string
:rtype: None

Definition at line 6401 of file iron.py.

def iron.Interface.MeshAdd	(		self,
			mesh
	)

Adds a mesh to be coupled in an interface identified by an object.

:param mesh: The mesh to add to the interface.
:type mesh: Mesh
:returns: meshIndex. The mesh index of the mesh in the list of coupled meshes in the interface.
:rtype: int

Definition at line 6412 of file iron.py.

def iron.Interface.NodesGet	(		self,
			nodes
	)

Returns the nodes for a interface identified by an object.

:param nodes: On return, the interfaces nodes.
:type nodes: Nodes
:rtype: None

Definition at line 6424 of file iron.py.

Member Data Documentation

iron.Interface.cmiss_type

Definition at line 6327 of file iron.py.

Property Documentation

iron.Interface.coordinateSystem = property(CoordinateSystemGet, CoordinateSystemSet, None, )

static

Definition at line 6437 of file iron.py.

iron.Interface.label = property(LabelGet, LabelSet, None, )

static

Definition at line 6439 of file iron.py.

iron.Interface.nodes = property(NodesGet, None, None, )

static

Definition at line 6435 of file iron.py.