Public Member Functions | Static Public Member Functions | List of all members
GAMGInterfaceField Class Reference

Abstract base class for GAMG agglomerated interface fields. More...

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

Public Member Functions

 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...
 
virtual void updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const =0
 Update result field based on interface functionality. More...
 
void operator= (const lduInterfaceField &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

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

Abstract base class for GAMG agglomerated interface fields.

Source files

Definition at line 51 of file GAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ GAMGInterfaceField() [1/3]

GAMGInterfaceField ( const GAMGInterface &  GAMGCp,
const lduInterfaceField &   
)
inline

Construct from GAMG interface and fine level interface field.

Definition at line 116 of file GAMGInterfaceField.H.

◆ GAMGInterfaceField() [2/3]

GAMGInterfaceField ( const GAMGInterface &  GAMGCp,
const int  rank 
)
inline

Construct from GAMG interface and fine level interface field.

Definition at line 127 of file GAMGInterfaceField.H.

◆ GAMGInterfaceField() [3/3]

GAMGInterfaceField ( const GAMGInterfaceField &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "GAMGInterfaceField"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
GAMGInterfaceField  ,
lduInterfaceField  ,
(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)  ,
(GAMGCp, fineInterface)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
GAMGInterfaceField  ,
lduInterface  ,
(const GAMGInterface &GAMGCp, const int rank)  ,
(GAMGCp, rank)   
)

◆ New() [1/2]

Foam::autoPtr< Foam::GAMGInterfaceField > New ( const GAMGInterface &  GAMGCp,
const lduInterfaceField &  fineInterface 
)
static

Return a pointer to a new interface created on freestore given.

the fine interface

Definition at line 30 of file GAMGInterfaceFieldNew.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, lduInterfaceField::interfaceFieldType(), and Foam::nl.

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::GAMGInterfaceField > New ( const GAMGInterface &  GAMGCp,
const int  rank 
)
static

Return a pointer to a new interface created on freestore given.

the fine interface

Definition at line 55 of file GAMGInterfaceFieldNew.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ interface()

const GAMGInterface& interface ( ) const
inline

Return interface.

Definition at line 146 of file GAMGInterfaceField.H.

◆ operator=()

void operator= ( const GAMGInterfaceField &  )
delete

Disallow default bitwise assignment.

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