Public Member Functions | List of all members
lduInterfaceField Class Referenceabstract

An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields. More...

Inheritance diagram for lduInterfaceField:
[legend]

Public Member Functions

 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 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 (solveScalarField &result, const bool add, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, 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 scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. More...
 

Detailed Description

An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields.

Source files

Definition at line 58 of file lduInterfaceField.H.

Constructor & Destructor Documentation

◆ lduInterfaceField()

lduInterfaceField ( const lduInterface &  patch)
inlineexplicit

Construct given coupled patch.

Definition at line 88 of file lduInterfaceField.H.

◆ ~lduInterfaceField()

virtual ~lduInterfaceField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "lduInterfaceField"  )

Runtime type information.

◆ interface()

const lduInterface& interface ( ) const
inline

Return the interface.

Definition at line 104 of file lduInterfaceField.H.

◆ interfaceFieldType()

virtual const word& interfaceFieldType ( ) const
inlinevirtual

Return the interface type.

Reimplemented in jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, and jumpCyclicFvPatchField< vector >.

Definition at line 110 of file lduInterfaceField.H.

References Foam::type().

Referenced by GAMGInterfaceField::New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updatedMatrix() [1/2]

bool updatedMatrix ( ) const
inline

Whether matrix has been updated.

Definition at line 119 of file lduInterfaceField.H.

Referenced by calculatedProcessorGAMGInterfaceField::initInterfaceMatrixUpdate(), processorGAMGInterfaceField::initInterfaceMatrixUpdate(), processorFvPatchField< Type >::initInterfaceMatrixUpdate(), calculatedProcessorGAMGInterfaceField::updateInterfaceMatrix(), processorGAMGInterfaceField::updateInterfaceMatrix(), and processorFvPatchField< Type >::updateInterfaceMatrix().

Here is the caller graph for this function:

◆ updatedMatrix() [2/2]

bool& updatedMatrix ( )
inline

Whether matrix has been updated.

Definition at line 125 of file lduInterfaceField.H.

◆ ready()

virtual bool ready ( ) const
inlinevirtual

Is all data available.

Reimplemented in calculatedProcessorFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 131 of file lduInterfaceField.H.

◆ initInterfaceMatrixUpdate()

virtual void initInterfaceMatrixUpdate ( solveScalarField &  result,
const bool  add,
const solveScalarField &  psiInternal,
const scalarField &  coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
inlinevirtual

Initialise neighbour matrix update. Add/subtract coupled contributions to matrix

Reimplemented in processorFaPatchField< Type >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, processorFaPatchField< Type >, processorGAMGInterfaceField, calculatedProcessorGAMGInterfaceField, and processorFaPatchField< Type >.

Definition at line 139 of file lduInterfaceField.H.

◆ updateInterfaceMatrix()

virtual void updateInterfaceMatrix ( solveScalarField &  result,
const bool  add,
const solveScalarField &  psiInternal,
const scalarField &  coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
pure virtual

Update result field based on interface functionality. Add/subtract coupled contributions to matrix

Implemented in coupledFvPatchField< scalar >, coupledFvPatchField< vector >, coupledFvPatchField< Type >, coupledFaPatchField< Type >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, processorFaPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, cyclicFaPatchField< Type >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, processorGAMGInterfaceField, calculatedProcessorGAMGInterfaceField, cyclicGAMGInterfaceField, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< vector >, cyclicACMIGAMGInterfaceField, cyclicAMIGAMGInterfaceField, processorFaPatchField< Type >, and processorFaPatchField< Type >.

◆ addToInternalField()

void addToInternalField ( Field< Type > &  result,
const bool  add,
const scalarField &  coeffs,
const Field< Type > &  vals 
) const

Add/subtract weighted contributions to internal field.

Definition at line 32 of file lduInterfaceFieldTemplates.C.

References forAll, and interface().

Here is the call graph for this function:
The documentation for this class was generated from the following files: