cyclicGAMGInterfaceField Class Reference

GAMG agglomerated cyclic interface field. More...

Inheritance diagram for cyclicGAMGInterfaceField:
Collaboration diagram for cyclicGAMGInterfaceField:

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 int rank)
 Construct from GAMG interface and fine level interface field. More...
 
 cyclicGAMGInterfaceField (const cyclicGAMGInterfaceField &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~cyclicGAMGInterfaceField ()
 Destructor. More...
 
label size () const
 Return size. More...
 
virtual const transformer & transform () const
 Cyclic interface functions. 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...
 
void operator= (const cyclicGAMGInterfaceField &)=delete
 Disallow default bitwise assignment. 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 int rank),(GAMGCp, rank))
 
 GAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &)
 Construct from GAMG interface and fine level interface field. More...
 
 GAMGInterfaceField (const GAMGInterface &GAMGCp, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
 GAMGInterfaceField (const GAMGInterfaceField &)=delete
 Disallow default bitwise copy construction. More...
 
const GAMGInterface & interface () const
 Return interface. More...
 
void operator= (const GAMGInterfaceField &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
 lduInterfaceField (const lduInterfaceField &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const lduInterfaceField &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from cyclicLduInterfaceField
 TypeName ("cyclicLduInterfaceField")
 Runtime type information. More...
 
 cyclicLduInterfaceField ()
 Construct given coupled patch. More...
 
virtual ~cyclicLduInterfaceField ()
 Destructor. More...
 
bool transforms () const
 Is the transform required. 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< 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 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/3]

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 p, and cyclicLduInterfaceField::rank().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [2/3]

cyclicGAMGInterfaceField ( const GAMGInterface &  GAMGCp,
const int  rank 
)

Construct from GAMG interface and fine level interface field.

Definition at line 86 of file cyclicGAMGInterfaceField.C.

◆ cyclicGAMGInterfaceField() [3/3]

Disallow default bitwise copy construction.

◆ ~cyclicGAMGInterfaceField()

Destructor.

Definition at line 99 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 99 of file cyclicGAMGInterfaceField.H.

References GAMGInterface::size().

Here is the call graph for this function:

◆ transform()

virtual const transformer& transform ( ) const
inlinevirtual

Cyclic interface functions.

Return the transformation

Implements cyclicLduInterfaceField.

Definition at line 108 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterface::transform().

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 114 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterfaceField::operator=(), and 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 106 of file cyclicGAMGInterfaceField.C.

References forAll.

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

Here is the caller graph for this function:

◆ operator=()

void operator= ( const cyclicGAMGInterfaceField &  )
delete

Disallow default bitwise assignment.

Referenced by cyclicGAMGInterfaceField::rank().

Here is the caller graph for this function:

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