GAMG agglomerated cyclic interface field. More...

#include <cyclicGAMGInterfaceField.H>

Inheritance diagram for cyclicGAMGInterfaceField:

[legend]

Collaboration diagram for cyclicGAMGInterfaceField:

[legend]

Public Member Functions
	TypeName ("cyclic")
	Runtime type information.
	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
	Construct from GAMG interface and fine level interface field.
	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field.
	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and Istream.
	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &local, const UPtrList< lduInterfaceField > &other)
	Construct from GAMG interface and local and remote fields.
virtual autoPtr< GAMGInterfaceField >	clone (const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const
	Construct by assembling and return a clone.
virtual	~cyclicGAMGInterfaceField ()=default
	Destructor.
label	size () const
	Return size.
virtual bool	doTransform () const
	Cyclic interface functions.
virtual const tensorField &	forwardT () const
	Return face transformation tensor.
virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor.
virtual int	rank () const
	Return rank of component for transform.
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.
virtual void	write (Ostream &) const
	Write to stream.
Public Member Functions inherited from GAMGInterfaceField
	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	~GAMGInterfaceField ()=default
	Destructor.
const GAMGInterface &	interface () const
	Return interface.
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.
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.
Public Member Functions inherited from cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")
	Runtime type information.
	cyclicLduInterfaceField ()=default
	Construct null.
virtual	~cyclicLduInterfaceField ()=default
	Destructor.
template<class Type>
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field.
void	transformCoupleField (solveScalarField &f, const direction cmpt) const
	Transform given patch component field.

Additional Inherited Members
Static Public Member Functions inherited from GAMGInterfaceField
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

GAMG agglomerated cyclic interface field.

Source files

Definition at line 49 of file cyclicGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicGAMGInterfaceField() [1/4]

cyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const lduInterfaceField &	fineInterfaceField )

Construct from GAMG interface and fine level interface field.

Definition at line 77 of file cyclicGAMGInterfaceField.C.

References cyclicLduInterfaceField::cyclicLduInterfaceField(), p, and Foam::refCast().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [2/4]

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

Construct from GAMG interface and fine level interface field.

Definition at line 96 of file cyclicGAMGInterfaceField.C.

References doTransform(), rank(), and Foam::refCast().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [3/4]

cyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		Istream &	is )

Construct from GAMG interface and Istream.

Definition at line 110 of file cyclicGAMGInterfaceField.C.

References Foam::readBool(), Foam::readLabel(), and Foam::refCast().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [4/4]

cyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const lduInterfaceField &	local,
		const UPtrList< lduInterfaceField > &	other )

Construct from GAMG interface and local and remote fields.

Definition at line 123 of file cyclicGAMGInterfaceField.C.

References local, p, and Foam::refCast().

Here is the call graph for this function:

◆ ~cyclicGAMGInterfaceField()

virtual ~cyclicGAMGInterfaceField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclic" )

Runtime type information.

References doTransform(), local, and rank().

Here is the call graph for this function:

◆ clone()

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

inlinevirtual

Construct by assembling and return a clone.

Implements GAMGInterfaceField.

Definition at line 136 of file cyclicGAMGInterfaceField.H.

◆ size()

label size ( ) const

inline

Return size.

Definition at line 167 of file cyclicGAMGInterfaceField.H.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Cyclic interface functions.

Does the interface field perform the transformation

Implements cyclicLduInterfaceField.

Definition at line 180 of file cyclicGAMGInterfaceField.H.

Referenced by cyclicGAMGInterfaceField(), TypeName(), and write().

Here is the caller graph for this function:

◆ forwardT()

virtual const tensorField & forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 188 of file cyclicGAMGInterfaceField.H.

◆ reverseT()

virtual const tensorField & reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 196 of file cyclicGAMGInterfaceField.H.

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicLduInterfaceField.

Definition at line 204 of file cyclicGAMGInterfaceField.H.

Referenced by cyclicGAMGInterfaceField(), TypeName(), and write().

Here is the caller 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 144 of file cyclicGAMGInterfaceField.C.

References Foam::add(), lduInterfaceField::addToInternalField(), lduAddressing::patchAddr(), patchId(), and cyclicLduInterfaceField::transformCoupleField().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write to stream.

Implements GAMGInterfaceField.

Definition at line 174 of file cyclicGAMGInterfaceField.C.

References doTransform(), os(), rank(), and token::SPACE.

Here is the call graph for this function:

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

src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/cyclicGAMGInterfaceField/cyclicGAMGInterfaceField.H
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/cyclicGAMGInterfaceField/cyclicGAMGInterfaceField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicGAMGInterfaceField() [1/4]

◆ cyclicGAMGInterfaceField() [2/4]

◆ cyclicGAMGInterfaceField() [3/4]

◆ cyclicGAMGInterfaceField() [4/4]

◆ ~cyclicGAMGInterfaceField()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ size()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

◆ updateInterfaceMatrix()

◆ write()