processorCyclicGAMGInterfaceField Class Reference

GAMG agglomerated processor interface field. More...

Inheritance diagram for processorCyclicGAMGInterfaceField:
Collaboration diagram for processorCyclicGAMGInterfaceField:

Public Member Functions

 TypeName ("processorCyclic")
 Runtime type information. More...
 
 processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
 Construct from GAMG interface and fine level interface field. More...
 
 processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
 processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
 Construct from GAMG interface and Istream. More...
 
virtual autoPtr< GAMGInterfaceFieldclone (const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const
 Construct by assembling and return a clone. More...
 
virtual ~processorCyclicGAMGInterfaceField ()
 
- Public Member Functions inherited from processorGAMGInterfaceField
 TypeName ("processor")
 Runtime type information. More...
 
 processorGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
 Construct from GAMG interface and fine level interface field. More...
 
 processorGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
 processorGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
 Construct from GAMG interface and Istream. More...
 
virtual ~processorGAMGInterfaceField ()=default
 Destructor. More...
 
label size () const
 Return size. More...
 
virtual bool ready () const
 Are all (receive) data available? More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual label comm () const
 Processor interface functions. More...
 
virtual int myProcNo () const
 Return processor number. More...
 
virtual int neighbProcNo () const
 Return neighbour processor number. More...
 
virtual bool doTransform () const
 Does the interface field perform the transformation. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
virtual void write (Ostream &) const
 Write to stream. 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))
 
 declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, Istream,(const GAMGInterface &GAMGCp, Istream &is),(GAMGCp, is))
 
 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...
 
 GAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
 Construct from GAMG interface and fine level interface field. More...
 
virtual ~GAMGInterfaceField ()=default
 Destructor. More...
 
const GAMGInterfaceinterface () const
 Return interface. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterfaceField &)=delete
 No copy construct. More...
 
void operator= (const lduInterfaceField &)=delete
 No copy assignment. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 Destructor. More...
 
const lduInterfaceinterface () const noexcept
 Return the interface. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
bool updatedMatrix () const noexcept
 Whether matrix has been updated. More...
 
bool updatedMatrix (bool flag) const noexcept
 Set matrix as update-to-date, return the previous value. More...
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. More...
 
bool & updatedMatrix () noexcept
 Adjust whether matrix has been updated. More...
 
- Public Member Functions inherited from processorLduInterfaceField
 TypeName ("processorLduInterfaceField")
 Runtime type information. More...
 
 processorLduInterfaceField ()=default
 Default construct. More...
 
virtual ~processorLduInterfaceField ()=default
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &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...
 
static autoPtr< GAMGInterfaceFieldNew (const word &patchFieldType, const GAMGInterface &GAMGCp, Istream &is)
 Return a pointer to a new interface created on freestore given. More...
 

Detailed Description

GAMG agglomerated processor interface field.

Source files

Definition at line 46 of file processorCyclicGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ processorCyclicGAMGInterfaceField() [1/3]

processorCyclicGAMGInterfaceField ( const GAMGInterface GAMGCp,
const lduInterfaceField fineInterface 
)

Construct from GAMG interface and fine level interface field.

Definition at line 54 of file processorCyclicGAMGInterfaceField.C.

◆ processorCyclicGAMGInterfaceField() [2/3]

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

Construct from GAMG interface and fine level interface field.

Definition at line 64 of file processorCyclicGAMGInterfaceField.C.

◆ processorCyclicGAMGInterfaceField() [3/3]

Construct from GAMG interface and Istream.

Definition at line 75 of file processorCyclicGAMGInterfaceField.C.

◆ ~processorCyclicGAMGInterfaceField()

Member Function Documentation

◆ TypeName()

TypeName ( "processorCyclic"  )

Runtime type information.

◆ clone()

virtual autoPtr<GAMGInterfaceField> clone ( const GAMGInterface GAMGCp,
const UPtrList< lduInterfaceField > &  other 
) const
inlinevirtual

Construct by assembling and return a clone.

Reimplemented from processorGAMGInterfaceField.

Definition at line 108 of file processorCyclicGAMGInterfaceField.H.

References NotImplemented.


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