cyclicAMIGAMGInterfaceField Class Reference

GAMG agglomerated cyclic interface field. More...

Inheritance diagram for cyclicAMIGAMGInterfaceField:
Collaboration diagram for cyclicAMIGAMGInterfaceField:

Public Member Functions

 TypeName ("cyclicAMI")
 Runtime type information. More...
 
 cyclicAMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
 Construct from GAMG interface and fine level interface field. More...
 
 cyclicAMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
 cyclicAMIGAMGInterfaceField (const cyclicAMIGAMGInterfaceField &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~cyclicAMIGAMGInterfaceField ()
 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 const transformertransform () const
 Cyclic interface functions. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
void operator= (const cyclicAMIGAMGInterfaceField &)=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 GAMGInterfaceinterface () 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 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...
 
void operator= (const lduInterfaceField &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from cyclicAMILduInterfaceField
 TypeName ("cyclicAMILduInterfaceField")
 Runtime type information. More...
 
 cyclicAMILduInterfaceField ()
 Construct null. More...
 
virtual ~cyclicAMILduInterfaceField ()
 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 &psiInternal, const direction cmpt) const
 Transform given patch internal 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 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 cyclicAMIGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicAMIGAMGInterfaceField() [1/3]

cyclicAMIGAMGInterfaceField ( const GAMGInterface GAMGCp,
const lduInterfaceField fineInterfaceField 
)

Construct from GAMG interface and fine level interface field.

Definition at line 53 of file cyclicAMIGAMGInterfaceField.C.

References p, and cyclicAMILduInterfaceField::rank().

Here is the call graph for this function:

◆ cyclicAMIGAMGInterfaceField() [2/3]

cyclicAMIGAMGInterfaceField ( const GAMGInterface GAMGCp,
const int  rank 
)

Construct from GAMG interface and fine level interface field.

Definition at line 70 of file cyclicAMIGAMGInterfaceField.C.

◆ cyclicAMIGAMGInterfaceField() [3/3]

Disallow default bitwise copy construction.

◆ ~cyclicAMIGAMGInterfaceField()

Destructor.

Definition at line 83 of file cyclicAMIGAMGInterfaceField.C.

References cyclicAMIGAMGInterfaceField::updateInterfaceMatrix().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicAMI"  )

Runtime type information.

◆ size()

label size ( ) const
inline

Return size.

Definition at line 102 of file cyclicAMIGAMGInterfaceField.H.

References GAMGInterface::size(), and cyclicAMIGAMGInterfaceField::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

◆ transform()

virtual const transformer& transform ( ) const
inlinevirtual

Cyclic interface functions.

Return transformation between the coupled patches

Implements cyclicAMILduInterfaceField.

Definition at line 124 of file cyclicAMIGAMGInterfaceField.H.

References cyclicAMIGAMGInterface::transform().

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 130 of file cyclicAMIGAMGInterfaceField.H.

References cyclicAMIGAMGInterfaceField::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const cyclicAMIGAMGInterfaceField )
delete

Disallow default bitwise assignment.

Referenced by cyclicAMIGAMGInterfaceField::rank().

Here is the caller graph for this function:

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