GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields. More...

Inheritance diagram for cyclicACMIGAMGInterfaceField:

Collaboration diagram for cyclicACMIGAMGInterfaceField:

[legend]

Public Member Functions
	TypeName ("cyclicACMI")
	Runtime type information. More...

	cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
	Construct from GAMG interface and fine level interface field. More...

	cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field. More...

virtual	~cyclicACMIGAMGInterfaceField ()
	Destructor. More...

label	size () const
	Return size. More...

virtual void	updateInterfaceMatrix (scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

virtual bool	doTransform () const
	Cyclic interface functions. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual int	rank () const
	Return rank of component for transform. More...

Public Member Functions inherited from GAMGInterfaceField
	TypeName ("GAMGInterfaceField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, lduInterfaceField,(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface),(GAMGCp, fineInterface))

	declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, lduInterface,(const GAMGInterface &GAMGCp, const bool doTransform, const int rank),(GAMGCp, doTransform, rank))

	GAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &)
	Construct from GAMG interface and fine level interface field. More...

	GAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field. More...

const GAMGInterface &	interface () const
	Return interface. More...

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...

	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~lduInterfaceField ()
	Destructor. More...

const lduInterface &	interface () const
	Return the interface. More...

virtual const word &	interfaceFieldType () const
	Return the interface type. More...

bool	updatedMatrix () const
	Whether matrix has been updated. More...

bool &	updatedMatrix ()
	Whether matrix has been updated. More...

virtual bool	ready () const
	Is all data available. More...

virtual void	initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

Public Member Functions inherited from cyclicACMILduInterfaceField
	TypeName ("cyclicACMILduInterfaceField")
	Runtime type information. More...

	cyclicACMILduInterfaceField ()
	Construct null. More...

virtual	~cyclicACMILduInterfaceField ()
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (scalarField &psiInternal, const direction cmpt) const
	Transform given patch internal field. More...

Public Member Functions inherited from cyclicAMILduInterfaceField
	TypeName ("cyclicAMILduInterfaceField")
	Runtime type information. More...

	cyclicAMILduInterfaceField ()
	Construct null. More...

virtual	~cyclicAMILduInterfaceField ()
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (scalarField &psiInternal, const direction cmpt) const
	Transform given patch internal field. More...

Private Member Functions
	cyclicACMIGAMGInterfaceField (const cyclicACMIGAMGInterfaceField &)
	Disallow default bitwise copy construct. More...

void	operator= (const cyclicACMIGAMGInterfaceField &)
	Disallow default bitwise assignment. More...

Private Attributes
const cyclicACMIGAMGInterface &	cyclicACMIInterface_
	Local reference cast into the cyclic interface. More...

bool	doTransform_
	Is the transform required. More...

int	rank_
	Rank of component for transformation. More...

Additional Inherited Members
Static Public Member Functions inherited from GAMGInterfaceField
static autoPtr< GAMGInterfaceField >	New (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
	Return a pointer to a new interface created on freestore given. More...

static autoPtr< GAMGInterfaceField >	New (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Return a pointer to a new interface created on freestore given. More...

Detailed Description

GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields.

Source files

Definition at line 51 of file cyclicACMIGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicACMIGAMGInterfaceField() [1/3]

cyclicACMIGAMGInterfaceField ( const cyclicACMIGAMGInterfaceField & )

private

Disallow default bitwise copy construct.

◆ cyclicACMIGAMGInterfaceField() [2/3]

cyclicACMIGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const lduInterfaceField &	fineInterfaceField
	)

Construct from GAMG interface and fine level interface field.

Definition at line 53 of file cyclicACMIGAMGInterfaceField.C.

References p.

◆ cyclicACMIGAMGInterfaceField() [3/3]

cyclicACMIGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const bool	doTransform,
		const int	rank
	)

Construct from GAMG interface and fine level interface field.

Definition at line 72 of file cyclicACMIGAMGInterfaceField.C.

◆ ~cyclicACMIGAMGInterfaceField()

~cyclicACMIGAMGInterfaceField ( )

virtual

Destructor.

Definition at line 87 of file cyclicACMIGAMGInterfaceField.C.

Member Function Documentation

◆ operator=()

void operator= ( const cyclicACMIGAMGInterfaceField & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "cyclicACMI" )

Runtime type information.

◆ size()

label size ( ) const

inline

Return size.

Definition at line 110 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterfaceField::cyclicACMIInterface_, and GAMGInterface::size().

Here is the call graph for this function:

◆ updateInterfaceMatrix()

void updateInterfaceMatrix	(	scalarField &	result,
		const scalarField &	psiInternal,
		const scalarField &	coeffs,
		const direction	cmpt,
		const Pstream::commsTypes	commsType
	)		const

virtual

Update result field based on interface functionality.

Implements lduInterfaceField.

Definition at line 94 of file cyclicACMIGAMGInterfaceField.C.

References forAll.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Cyclic interface functions.

Does the interface field perform the transfromation

Implements cyclicAMILduInterfaceField.

Definition at line 132 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterfaceField::doTransform_.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 138 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterfaceField::cyclicACMIInterface_, and cyclicACMIGAMGInterface::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 144 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterfaceField::cyclicACMIInterface_, and cyclicACMIGAMGInterface::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicAMILduInterfaceField.

Definition at line 150 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterfaceField::rank_.

Field Documentation

◆ cyclicACMIInterface_

const cyclicACMIGAMGInterface& cyclicACMIInterface_

private

Local reference cast into the cyclic interface.

Definition at line 59 of file cyclicACMIGAMGInterfaceField.H.

Referenced by cyclicACMIGAMGInterfaceField::forwardT(), cyclicACMIGAMGInterfaceField::reverseT(), and cyclicACMIGAMGInterfaceField::size().

◆ doTransform_

bool doTransform_

private

Is the transform required.

Definition at line 62 of file cyclicACMIGAMGInterfaceField.H.

Referenced by cyclicACMIGAMGInterfaceField::doTransform().

◆ rank_

int rank_

private

Rank of component for transformation.

Definition at line 65 of file cyclicACMIGAMGInterfaceField.H.

Referenced by cyclicACMIGAMGInterfaceField::rank().

The documentation for this class was generated from the following files:

src/meshTools/AMIInterpolation/GAMG/interfaceFields/cyclicACMIGAMGInterfaceField/cyclicACMIGAMGInterfaceField.H
src/meshTools/AMIInterpolation/GAMG/interfaceFields/cyclicACMIGAMGInterfaceField/cyclicACMIGAMGInterfaceField.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicACMIGAMGInterfaceField() [1/3]

◆ cyclicACMIGAMGInterfaceField() [2/3]

◆ cyclicACMIGAMGInterfaceField() [3/3]

◆ ~cyclicACMIGAMGInterfaceField()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ size()

◆ updateInterfaceMatrix()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

Field Documentation

◆ cyclicACMIInterface_

◆ doTransform_

◆ rank_