GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields. More...

Inheritance diagram for cyclicACMIGAMGInterfaceField:

Collaboration diagram for cyclicACMIGAMGInterfaceField:

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

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

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

	cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and Istream. More...

	cyclicACMIGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &local, const UPtrList< lduInterfaceField > &other)
	Construct from GAMG interface and local and remote fields. More...

virtual autoPtr< GAMGInterfaceField >	clone (const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const
	Construct by assembling and return a clone. More...

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

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

virtual bool	ready () const
	Are all (receive) data available? More...

virtual void	initInterfaceMatrixUpdate (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
	Initialise neighbour matrix update. 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...

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	write (Ostream &) const
	Write to stream. 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))

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

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

	GAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and fine level interface field. More...

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

const GAMGInterface &	interface () const
	Return interface. More...

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...

	lduInterfaceField (const lduInterfaceField &)=delete
	No copy construct. More...

void	operator= (const lduInterfaceField &)=delete
	No copy assignment. More...

	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

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

const lduInterface &	interface () const noexcept
	Return the interface. More...

virtual const word &	interfaceFieldType () const
	Return the interface type. More...

bool	updatedMatrix () const noexcept
	Whether matrix has been updated. More...

bool	updatedMatrix (bool flag) const noexcept
	Set matrix as update-to-date, return the previous value. More...

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

bool &	updatedMatrix () noexcept
	Adjust whether matrix has been updated. More...

Public Member Functions inherited from cyclicACMILduInterfaceField
	TypeName ("cyclicACMILduInterfaceField")
	Runtime type information. More...

	cyclicACMILduInterfaceField ()
	Construct null. More...

virtual	~cyclicACMILduInterfaceField ()
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
	Transform given patch internal field. More...

Public Member Functions inherited from cyclicAMILduInterfaceField
	TypeName ("cyclicAMILduInterfaceField")
	Runtime type information. More...

	cyclicAMILduInterfaceField ()
	Construct null. More...

virtual	~cyclicAMILduInterfaceField ()
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const
	Transform given patch internal 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...

static autoPtr< GAMGInterfaceField >	New (const word &patchFieldType, const GAMGInterface &GAMGCp, Istream &is)
	Return a pointer to a new interface created on freestore given. More...

Detailed Description

GAMG agglomerated cyclic interface for Arbitrarily Coupled Mesh Interface (ACMI) fields.

Source files

Definition at line 50 of file cyclicACMIGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ cyclicACMIGAMGInterfaceField() [1/4]

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

Construct from GAMG interface and fine level interface field.

Definition at line 55 of file cyclicACMIGAMGInterfaceField.C.

References p.

◆ cyclicACMIGAMGInterfaceField() [2/4]

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

Construct from GAMG interface and fine level interface field.

Definition at line 76 of file cyclicACMIGAMGInterfaceField.C.

◆ cyclicACMIGAMGInterfaceField() [3/4]

cyclicACMIGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		Istream &	is
	)

Construct from GAMG interface and Istream.

Definition at line 92 of file cyclicACMIGAMGInterfaceField.C.

◆ cyclicACMIGAMGInterfaceField() [4/4]

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

Construct from GAMG interface and local and remote fields.

Definition at line 107 of file cyclicACMIGAMGInterfaceField.C.

References local, and p.

◆ ~cyclicACMIGAMGInterfaceField()

virtual ~cyclicACMIGAMGInterfaceField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicACMI" )

Runtime type information.

◆ 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 164 of file cyclicACMIGAMGInterfaceField.H.

◆ size()

label size ( ) const

inline

Return size.

Definition at line 194 of file cyclicACMIGAMGInterfaceField.H.

References GAMGInterface::size().

Here is the call graph for this function:

◆ ready()

bool ready ( ) const

virtual

Are all (receive) data available?

Reimplemented from lduInterfaceField.

Definition at line 129 of file cyclicACMIGAMGInterfaceField.C.

References IntRange< IntType >::clear(), UPstream::finishedRequests(), IntRange< IntType >::size(), and IntRange< IntType >::start().

Here is the call graph for this function:

◆ initInterfaceMatrixUpdate()

void initInterfaceMatrixUpdate	(	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

Initialise neighbour matrix update.

Reimplemented from lduInterfaceField.

Definition at line 162 of file cyclicACMIGAMGInterfaceField.C.

References UPstream::commWarn(), DebugPout, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, UPstream::nonBlocking, and lduAddressing::patchAddr().

Here is the call 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 230 of file cyclicACMIGAMGInterfaceField.C.

References Foam::add(), DebugPout, Foam::endl(), Field< solveScalar >::null(), lduAddressing::patchAddr(), patchId(), and Foam::Zero.

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

Definition at line 245 of file cyclicACMIGAMGInterfaceField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 253 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterface::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 261 of file cyclicACMIGAMGInterfaceField.H.

References cyclicACMIGAMGInterface::reverseT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicAMILduInterfaceField.

Definition at line 269 of file cyclicACMIGAMGInterfaceField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write to stream.

Implements GAMGInterfaceField.

Definition at line 311 of file cyclicACMIGAMGInterfaceField.C.

References os(), Foam::expressions::Detail::rank(), and token::SPACE.

Here is the call graph for this function:

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

src/meshTools/AMIInterpolation/GAMG/interfaceFields/cyclicACMIGAMGInterfaceField/cyclicACMIGAMGInterfaceField.H
src/meshTools/AMIInterpolation/GAMG/interfaceFields/cyclicACMIGAMGInterfaceField/cyclicACMIGAMGInterfaceField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicACMIGAMGInterfaceField() [1/4]

◆ cyclicACMIGAMGInterfaceField() [2/4]

◆ cyclicACMIGAMGInterfaceField() [3/4]

◆ cyclicACMIGAMGInterfaceField() [4/4]

◆ ~cyclicACMIGAMGInterfaceField()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ size()

◆ ready()

◆ initInterfaceMatrixUpdate()

◆ updateInterfaceMatrix()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

◆ write()