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

#include <GAMGInterfaceField.H>

Inheritance diagram for GAMGInterfaceField:

[legend]

Collaboration diagram for GAMGInterfaceField:

Public Member Functions
	TypeName ("GAMGInterfaceField")
	Runtime type information.
	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.
	GAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field.
	GAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and fine level interface field.
virtual autoPtr< GAMGInterfaceField >	clone (const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const =0
	Construct by assembling and return a clone.
virtual	~GAMGInterfaceField ()=default
	Destructor.
const GAMGInterface &	interface () const
	Return interface.
virtual void	write (Ostream &) const =0
	Write to stream.
Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information.
	lduInterfaceField (const lduInterfaceField &)=delete
	No copy construct.
void	operator= (const lduInterfaceField &)=delete
	No copy assignment.
	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch.
virtual	~lduInterfaceField ()=default
	Destructor.
const lduInterface &	interface () const noexcept
	Return the interface.
virtual const word &	interfaceFieldType () const
	Return the interface type.
virtual bool	ready () const
	Are all (receive) data available?
bool	updatedMatrix () const noexcept
	Whether matrix has been updated.
bool	updatedMatrix (bool flag) const noexcept
	Set matrix as update-to-date, return the previous value.
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
	Initialise neighbour matrix update. Add/subtract coupled contributions to matrix.
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
	Update result field based on interface functionality. Add/subtract coupled contributions to matrix.
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.
bool &	updatedMatrix () noexcept
	Adjust whether matrix has been updated.

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.
static autoPtr< GAMGInterfaceField >	New (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Return a pointer to a new interface created on freestore given.
static autoPtr< GAMGInterfaceField >	New (const word &patchFieldType, const GAMGInterface &GAMGCp, Istream &is)
	Return a pointer to a new interface created on freestore given.

Detailed Description

Abstract base class for GAMG agglomerated interface fields.

Source files

Definition at line 50 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 166 of file GAMGInterfaceField.H.

References lduInterfaceField::lduInterfaceField().

Here is the call graph for this function:

◆ GAMGInterfaceField() [2/3]

GAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const bool	doTransform,
		const int	rank )

inline

Construct from GAMG interface and fine level interface field.

Definition at line 179 of file GAMGInterfaceField.H.

References lduInterfaceField::lduInterfaceField().

Here is the call graph for this function:

◆ GAMGInterfaceField() [3/3]

GAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		Istream &	is )

inline

Construct from GAMG interface and fine level interface field.

Definition at line 193 of file GAMGInterfaceField.H.

References lduInterfaceField::lduInterfaceField().

Here is the call graph for this function:

◆ ~GAMGInterfaceField()

virtual ~GAMGInterfaceField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "GAMGInterfaceField" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

References lduInterfaceField::lduInterfaceField().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/3]

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

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	autoPtr	,
		GAMGInterfaceField	,
		Istream	,
		(const GAMGInterface &GAMGCp, Istream &is)	,
		(GAMGCp, is)	)

References lduInterfaceField::lduInterfaceField().

Here is the call graph for this function:

◆ New() [1/3]

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 26 of file GAMGInterfaceFieldNew.C.

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

Here is the call graph for this function:

◆ New() [2/3]

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

static

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

the fine interface

Definition at line 50 of file GAMGInterfaceFieldNew.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::GAMGInterfaceField > New	(	const word &	patchFieldType,
		const GAMGInterface &	GAMGCp,
		Istream &	is )

static

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

the fine interface and stream

Definition at line 75 of file GAMGInterfaceFieldNew.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

Here is the call graph for this function:

◆ clone()

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

pure virtual

Construct by assembling and return a clone.

Implemented in calculatedProcessorGAMGInterfaceField, cyclicACMIGAMGInterfaceField, cyclicAMIGAMGInterfaceField, cyclicGAMGInterfaceField, oversetGAMGInterfaceField, processorCyclicGAMGInterfaceField, and processorGAMGInterfaceField.

◆ interface()

const GAMGInterface & interface ( ) const

inline

Return interface.

Definition at line 226 of file GAMGInterfaceField.H.

◆ write()

virtual void write ( Ostream & ) const

pure virtual

Write to stream.

Implemented in calculatedProcessorGAMGInterfaceField, cyclicACMIGAMGInterfaceField, cyclicAMIGAMGInterfaceField, cyclicGAMGInterfaceField, oversetGAMGInterfaceField, and processorGAMGInterfaceField.

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

src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/GAMGInterfaceField/GAMGInterfaceField.H
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/GAMGInterfaceField/GAMGInterfaceFieldNew.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GAMGInterfaceField() [1/3]

◆ GAMGInterfaceField() [2/3]

◆ GAMGInterfaceField() [3/3]

◆ ~GAMGInterfaceField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ clone()

◆ interface()

◆ write()