GAMG agglomerated cyclic interface field. More...

Inheritance diagram for cyclicGAMGInterfaceField:

Collaboration diagram for cyclicGAMGInterfaceField:

Public Member Functions
	TypeName ("cyclic")
	Runtime type information. More...

	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
	Construct from GAMG interface and fine level interface field. More...

	cyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field. More...

virtual	~cyclicGAMGInterfaceField ()=default
	Destructor. More...

label	size () const
	Return size. More...

virtual bool	doTransform () const
	Cyclic interface functions. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual int	rank () const
	Return rank of component for transform. 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...

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 GAMGInterface &	interface () 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 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 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 cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")
	Runtime type information. More...

	cyclicLduInterfaceField ()=default
	Construct null. More...

virtual	~cyclicLduInterfaceField ()=default
	Destructor. More...

virtual bool	doTransform () const =0
	Is the transform required. More...

virtual const tensorField &	forwardT () const =0
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () 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 &f, const direction cmpt) const
	Transform given patch component field. More...

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

static autoPtr< GAMGInterfaceField >	New (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 field.

Source files

Definition at line 53 of file cyclicGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicGAMGInterfaceField() [1/2]

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

Construct from GAMG interface and fine level interface field.

Definition at line 71 of file cyclicGAMGInterfaceField.C.

References p, and Foam::refCast().

Here is the call graph for this function:

◆ cyclicGAMGInterfaceField() [2/2]

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

Construct from GAMG interface and fine level interface field.

Definition at line 90 of file cyclicGAMGInterfaceField.C.

◆ ~cyclicGAMGInterfaceField()

virtual ~cyclicGAMGInterfaceField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclic" )

Runtime type information.

◆ size()

label size ( ) const

inline

Return size.

Definition at line 112 of file cyclicGAMGInterfaceField.H.

References GAMGInterface::size().

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

Definition at line 121 of file cyclicGAMGInterfaceField.H.

◆ forwardT()

virtual const tensorField & forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 127 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterface::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField & reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 133 of file cyclicGAMGInterfaceField.H.

References cyclicGAMGInterface::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicLduInterfaceField.

Definition at line 139 of file cyclicGAMGInterfaceField.H.

◆ 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 106 of file cyclicGAMGInterfaceField.C.

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

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/2]

◆ cyclicGAMGInterfaceField() [2/2]

◆ ~cyclicGAMGInterfaceField()

Member Function Documentation

◆ TypeName()

◆ size()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

◆ updateInterfaceMatrix()