Public Member Functions | List of all members
cyclicGAMGInterfaceField Class Reference

GAMG agglomerated cyclic interface field. More...

Inheritance diagram for cyclicGAMGInterfaceField:
Inheritance graph
[legend]
Collaboration diagram for cyclicGAMGInterfaceField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("cyclic")
 Runtime type information. More...
 
 cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
 Construct from GAMG interface and fine level interface field. More...
 
 cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
virtual ~cyclicGAMGInterfaceField ()
 Destructor. More...
 
label size () const
 Return size. More...
 
virtual bool doTransform () const
 Cyclic interface functions. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. 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...
 
- 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 GAMGInterfaceinterface () 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 lduInterfaceinterface () const
 Return the interface. More...
 
virtual const wordinterfaceFieldType () 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 cyclicLduInterfaceField
 TypeName ("cyclicLduInterfaceField")
 Runtime type information. More...
 
 cyclicLduInterfaceField ()
 Construct given coupled patch. More...
 
virtual ~cyclicLduInterfaceField ()
 Destructor. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from GAMGInterfaceField
static autoPtr< GAMGInterfaceFieldNew (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
 Return a pointer to a new interface created on freestore given. More...
 
static autoPtr< GAMGInterfaceFieldNew (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 field.

Source files

Definition at line 50 of file cyclicGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicGAMGInterfaceField() [1/2]

cyclicGAMGInterfaceField ( const GAMGInterface GAMGCp,
const lduInterfaceField fineInterfaceField 
)

Construct from GAMG interface and fine level interface field.

Definition at line 69 of file cyclicGAMGInterfaceField.C.

References cyclicLduInterfaceField::doTransform(), p, and cyclicLduInterfaceField::rank().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [2/2]

cyclicGAMGInterfaceField ( const GAMGInterface GAMGCp,
const bool  doTransform,
const int  rank 
)

Construct from GAMG interface and fine level interface field.

Definition at line 88 of file cyclicGAMGInterfaceField.C.

◆ ~cyclicGAMGInterfaceField()

Destructor.

Definition at line 103 of file cyclicGAMGInterfaceField.C.

References cyclicGAMGInterfaceField::updateInterfaceMatrix().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cyclic"  )

Runtime type information.

◆ size()

label size ( ) const
inline

Return size.

Definition at line 109 of file cyclicGAMGInterfaceField.H.

References GAMGInterface::size().

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Cyclic interface functions.

Does the interface field perform the transformation

Implements cyclicLduInterfaceField.

Definition at line 118 of file cyclicGAMGInterfaceField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 124 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterface::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 130 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterface::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const
inlinevirtual

Return rank of component for transform.

Implements cyclicLduInterfaceField.

Definition at line 136 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterfaceField::updateInterfaceMatrix().

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 110 of file cyclicGAMGInterfaceField.C.

References forAll.

Referenced by cyclicGAMGInterfaceField::rank(), and cyclicGAMGInterfaceField::~cyclicGAMGInterfaceField().

Here is the caller graph for this function:

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