cyclicACMIGAMGInterfaceField Class Reference

GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields. More...

Inheritance diagram for cyclicACMIGAMGInterfaceField:
[legend]
Collaboration diagram for cyclicACMIGAMGInterfaceField:
[legend]

Public Member Functions

 TypeName ("cyclicACMI")
 Runtime type information. More...
 
 cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
 Construct from GAMG interface and fine level interface field. More...
 
 cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
 Construct from GAMG interface and fine level interface field. More...
 
virtual ~cyclicACMIGAMGInterfaceField ()
 Destructor. More...
 
label size () const
 Return size. 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 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...
 
- 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 ()=default
 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...
 
boolupdatedMatrix ()
 Whether matrix has been updated. More...
 
virtual bool ready () const
 Is all data available. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const =0
 
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...
 
- Public Member Functions inherited from cyclicACMILduInterfaceField
 TypeName ("cyclicACMILduInterfaceField")
 Runtime type information. More...
 
 cyclicACMILduInterfaceField ()
 Construct null. More...
 
virtual ~cyclicACMILduInterfaceField ()
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
 Transform given patch internal field. More...
 
- Public Member Functions inherited from cyclicAMILduInterfaceField
 TypeName ("cyclicAMILduInterfaceField")
 Runtime type information. More...
 
 cyclicAMILduInterfaceField ()
 Construct null. More...
 
virtual ~cyclicAMILduInterfaceField ()
 Destructor. More...
 
virtual bool doTransform () const =0
 Is the transform required. More...
 
virtual const tensorFieldforwardT () const =0
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const =0
 Return neighbour-cell transformation tensor. More...
 
virtual int rank () const =0
 Return rank of component for transform. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &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 bool doTransform, const int rank)
 Return a pointer to a new interface created on freestore given. More...
 

Detailed Description

GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields.

Source files

Definition at line 54 of file cyclicACMIGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicACMIGAMGInterfaceField() [1/2]

cyclicACMIGAMGInterfaceField ( const GAMGInterface GAMGCp,
const lduInterfaceField fineInterfaceField 
)

Construct from GAMG interface and fine level interface field.

Definition at line 55 of file cyclicACMIGAMGInterfaceField.C.

References p, and Foam::refCast().

Here is the call graph for this function:

◆ cyclicACMIGAMGInterfaceField() [2/2]

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

Construct from GAMG interface and fine level interface field.

Definition at line 74 of file cyclicACMIGAMGInterfaceField.C.

◆ ~cyclicACMIGAMGInterfaceField()

Destructor.

Definition at line 90 of file cyclicACMIGAMGInterfaceField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicACMI"  )

Runtime type information.

◆ size()

label size ( ) const
inline

Return size.

Definition at line 116 of file cyclicACMIGAMGInterfaceField.H.

References GAMGInterface::size().

Here is the call graph for this function:

◆ updateInterfaceMatrix()

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
virtual

Update result field based on interface functionality.

Implements lduInterfaceField.

Definition at line 96 of file cyclicACMIGAMGInterfaceField.C.

References Foam::add(), lduAddressing::patchAddr(), and patchId().

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 cyclicAMILduInterfaceField.

Definition at line 141 of file cyclicACMIGAMGInterfaceField.H.

◆ forwardT()

virtual const tensorField & forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 147 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterface::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField & reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 153 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterface::reverseT().

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 159 of file cyclicACMIGAMGInterfaceField.H.


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