cyclicLduInterfaceField Class Reference

Abstract base class for cyclic coupled interfaces. More...

Inheritance diagram for cyclicLduInterfaceField:

Public Member Functions
	TypeName ("cyclicLduInterfaceField")
	Runtime type information. More...
	cyclicLduInterfaceField ()
	Construct given coupled patch. More...
virtual	~cyclicLduInterfaceField ()
	Destructor. More...
virtual const transformer &	transform () const =0
	Return the transformation. More...
bool	transforms () const
	Is the transform required. More...
virtual int	rank () const =0
	Return rank of component for transform. More...
template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...
void	transformCoupleField (scalarField &f, const direction cmpt) const
	Transform given patch component field. More...

Detailed Description

Abstract base class for cyclic coupled interfaces.

Source files

• cyclicLduInterfaceField.H
• cyclicLduInterfaceField.C

Definition at line 50 of file cyclicLduInterfaceField.H.

Constructor & Destructor Documentation

cyclicLduInterfaceField()

cyclicLduInterfaceField ( )

inline

Construct given coupled patch.

Definition at line 62 of file cyclicLduInterfaceField.H.

~cyclicLduInterfaceField()

~cyclicLduInterfaceField ( )

virtual

Destructor.

Definition at line 39 of file cyclicLduInterfaceField.C.

Member Function Documentation

TypeName()

TypeName

(

"cyclicLduInterfaceField"

)

Runtime type information.

transform()

virtual const transformer& transform ( ) const

pure virtual

Return the transformation.

Implemented in cyclicGAMGInterfaceField, and cyclicFvPatchField< Type >.

Referenced by cyclicLduInterfaceField::transformCoupleField(), and cyclicLduInterfaceField::transforms().

Here is the caller graph for this function:

transforms()

bool transforms ( ) const

inline

Is the transform required.

Definition at line 78 of file cyclicLduInterfaceField.H.

References cyclicLduInterfaceField::rank(), cyclicLduInterfaceField::transform(), and transformer::transforms().

Referenced by cyclicLduInterfaceField::transformCoupleField().

Here is the call graph for this function:

Here is the caller graph for this function:

rank()

virtual int rank ( ) const

pure virtual

Return rank of component for transform.

Implemented in cyclicGAMGInterfaceField, and cyclicFvPatchField< Type >.

Referenced by cyclicLduInterfaceField::transforms().

Here is the caller graph for this function:

transformCoupleField() [1/2]

void transformCoupleField ( Field< Type > &  f ) const

inline

Transform given patch field.

Definition at line 109 of file cyclicLduInterfaceField.H.

References f(), cyclicLduInterfaceField::transform(), transformer::transform(), and cyclicLduInterfaceField::transforms().

Here is the call graph for this function:

transformCoupleField() [2/2]

void transformCoupleField	(	scalarField &	f,
		const direction	cmpt
	)		const

Transform given patch component field.

Definition at line 45 of file cyclicLduInterfaceField.C.

References VectorSpace< Form, Cmpt, Ncmpts >::component(), Foam::diag(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::sqr(), Foam::T(), Foam::transform(), and transforms.

Here is the call graph for this function:

---

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

• src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/cyclicLduInterfaceField/cyclicLduInterfaceField.H
• src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/cyclicLduInterfaceField/cyclicLduInterfaceField.C