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:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

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

Source files

Definition at line 55 of file lduInterfaceField.H.

Constructor & Destructor Documentation

◆ lduInterfaceField() [1/2]

lduInterfaceField ( const lduInterface &  patch)
inline

Construct given coupled patch.

Definition at line 76 of file lduInterfaceField.H.

References lduInterfaceField::~lduInterfaceField().

Here is the call graph for this function:

◆ lduInterfaceField() [2/2]

lduInterfaceField ( const lduInterfaceField &  )
delete

Disallow default bitwise copy construction.

◆ ~lduInterfaceField()

~lduInterfaceField ( )
virtual

Destructor.

Definition at line 38 of file lduInterfaceField.C.

Referenced by lduInterfaceField::lduInterfaceField().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "lduInterfaceField"  )

Runtime type information.

◆ interface()

const lduInterface& interface ( ) const
inline

Return the interface.

Definition at line 95 of file lduInterfaceField.H.

Referenced by procLduInterface::procLduInterface().

Here is the caller graph for this function:

◆ interfaceFieldType()

virtual const word& interfaceFieldType ( ) const
inlinevirtual

Return the interface type.

Reimplemented in energyRegionCoupledFvPatchScalarField, jumpCyclicAMIFvPatchField< Type >, and jumpCyclicFvPatchField< Type >.

Definition at line 101 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 110 of file lduInterfaceField.H.

Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), processorFvPatchField< Type >::initInterfaceMatrixUpdate(), 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 116 of file lduInterfaceField.H.

◆ ready()

virtual bool ready ( ) const
inlinevirtual

Is all data available.

Reimplemented in processorFvPatchField< Type >.

Definition at line 122 of file lduInterfaceField.H.

References lduInterfaceField::initInterfaceMatrixUpdate().

Referenced by processorFvPatchField< Type >::processorFvPatchField().

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

◆ initInterfaceMatrixUpdate()

virtual void initInterfaceMatrixUpdate ( scalarField &  ,
const scalarField &  ,
const scalarField &  ,
const direction  ,
const Pstream::commsTypes  commsType 
) const
inlinevirtual

Initialise neighbour matrix update.

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

Definition at line 129 of file lduInterfaceField.H.

References lduInterfaceField::operator=(), and lduInterfaceField::updateInterfaceMatrix().

Referenced by LduInterfaceField< Type >::LduInterfaceField(), and lduInterfaceField::ready().

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

◆ updateInterfaceMatrix()

virtual void updateInterfaceMatrix ( scalarField &  ,
const scalarField &  ,
const scalarField &  ,
const direction  ,
const Pstream::commsTypes  commsType 
) const
pure virtual

Update result field based on interface functionality.

Implemented in energyRegionCoupledFvPatchScalarField, processorFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, cyclicAMIFvPatchField< Type >, cyclicFvPatchField< Type >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicFvPatchField< Type >, processorGAMGInterfaceField, cyclicGAMGInterfaceField, jumpCyclicAMIFvPatchField< Type >, jumpCyclicFvPatchField< Type >, cyclicAMIGAMGInterfaceField, regionCoupledGAMGInterfaceField, regionCoupledWallGAMGInterfaceField, processorFvPatchField< Type >, processorFvPatchField< Type >, jumpCyclicAMIFvPatchField< Type >, and jumpCyclicFvPatchField< Type >.

Referenced by LduInterfaceField< Type >::initInterfaceMatrixUpdate(), and lduInterfaceField::initInterfaceMatrixUpdate().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const lduInterfaceField &  )
delete

Disallow default bitwise assignment.

Referenced by lduInterfaceField::initInterfaceMatrixUpdate().

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