Public Member Functions | List of all members
cyclicLduInterfaceField Class Referenceabstract

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

Inheritance diagram for cyclicLduInterfaceField:
Inheritance graph
[legend]

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

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.

References cyclicLduInterfaceField::transform(), and cyclicLduInterfaceField::~cyclicLduInterfaceField().

Here is the call graph for this function:

◆ ~cyclicLduInterfaceField()

~cyclicLduInterfaceField ( )
virtual

Destructor.

Definition at line 39 of file cyclicLduInterfaceField.C.

References cyclicLduInterfaceField::transformCoupleField().

Referenced by cyclicLduInterfaceField::cyclicLduInterfaceField().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicLduInterfaceField"  )

Runtime type information.

◆ transform()

virtual const transformer& transform ( ) const
pure virtual

Return the transformation.

Implemented in cyclicFvPatchField< Type >, and cyclicGAMGInterfaceField.

Referenced by cyclicLduInterfaceField::cyclicLduInterfaceField(), 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 f(), cyclicLduInterfaceField::rank(), cyclicLduInterfaceField::transform(), cyclicLduInterfaceField::transformCoupleField(), 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 cyclicFvPatchField< Type >, and cyclicGAMGInterfaceField.

Referenced by cyclicGAMGInterfaceField::cyclicGAMGInterfaceField(), and 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 110 of file cyclicLduInterfaceField.H.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ transformCoupleField() [2/2]

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

Transform given patch component field.

Definition at line 46 of file cyclicLduInterfaceField.C.

References VectorSpace< Form, Cmpt, Ncmpts >::component(), dimensioned< Type >::component(), Foam::diag(), Foam::exit(), 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: