This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation. More...

Inheritance diagram for cyclicAMIFvPatchField< Type >:

[legend]

Collaboration diagram for cyclicAMIFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName (cyclicAMIFvPatch::typeName_())
	Runtime type information. More...

	cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	cyclicAMIFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given cyclicAMIFvPatchField onto a new patch. More...

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const cyclicAMIFvPatch &	cyclicAMIPatch () const
	Return local reference cast into the cyclic AMI patch. More...

virtual bool	coupled () const
	Return true if coupled. Note that the underlying patch. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return neighbour coupled internal cell data. More...

const cyclicAMIFvPatchField< Type > &	neighbourPatchField () const
	Return reference to neighbour patchField. 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 void	updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

virtual void	manipulateMatrix (fvMatrix< Type > &m, const label iMatrix, const direction cmpt)
	Manipulate matrix. More...

virtual bool	doTransform () const
	Does the patch field perform the transformation. 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 &os) const
	Write. 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...

Public Member Functions inherited from coupledFvPatchField< Type >
	TypeName (coupledFvPatch::typeName_())
	Runtime type information. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given coupledFvPatchField onto a new patch. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &)
	Construct as copy. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")
	Runtime type information. More...

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

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

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. 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
	Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...

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
	Inherit updateInterfaceMatrix from lduInterfaceField. 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

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 fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	Construct from patch, internal field and value. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

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

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	assignable () const
	Return true if the value of the patch field. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	updateWeightedCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

template<class Type2 >
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::cyclicAMIFvPatchField< Type >

This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation.

Usage

Example of the boundary condition specification:

<patchName>
{
    type            cyclicAMI;
}

Note: The outer boundary of the patch pairs must be similar, i.e. if the owner patch is transformed to the neighbour patch, the outer perimiter of each patch should be identical (or very similar).

See also: Foam::AMIInterpolation

Source files

Definition at line 77 of file cyclicAMIFvPatchField.H.

Constructor & Destructor Documentation

◆ cyclicAMIFvPatchField() [1/5]

cyclicAMIFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 37 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [2/5]

cyclicAMIFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 50 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [3/5]

cyclicAMIFvPatchField	(	const cyclicAMIFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given cyclicAMIFvPatchField onto a new patch.

Definition at line 87 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [4/5]

cyclicAMIFvPatchField ( const cyclicAMIFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 112 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [5/5]

cyclicAMIFvPatchField	(	const cyclicAMIFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 124 of file cyclicAMIFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicAMIFvPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements coupledFvPatchField< Type >.

Reimplemented in uniformJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, and energyJumpAMIFvPatchScalarField.

Definition at line 153 of file cyclicAMIFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements coupledFvPatchField< Type >.

Reimplemented in uniformJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, and energyJumpAMIFvPatchScalarField.

Definition at line 170 of file cyclicAMIFvPatchField.H.

◆ cyclicAMIPatch()

const cyclicAMIFvPatch& cyclicAMIPatch ( ) const

inline

Return local reference cast into the cyclic AMI patch.

Definition at line 186 of file cyclicAMIFvPatchField.H.

◆ coupled()

bool coupled ( ) const

virtual

Return true if coupled. Note that the underlying patch.

is not coupled() - the points don't align.

Reimplemented from coupledFvPatchField< Type >.

Definition at line 138 of file cyclicAMIFvPatchField.C.

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Type > > patchNeighbourField ( ) const

virtual

Return neighbour coupled internal cell data.

Implements coupledFvPatchField< Type >.

Reimplemented in jumpCyclicAMIFvPatchField< Type >, and jumpCyclicAMIFvPatchField< scalar >.

Definition at line 146 of file cyclicAMIFvPatchField.C.

◆ neighbourPatchField()

const Foam::cyclicAMIFvPatchField< Type > & neighbourPatchField ( ) const

Return reference to neighbour patchField.

Definition at line 180 of file cyclicAMIFvPatchField.C.

◆ updateInterfaceMatrix() [1/2]

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

Reimplemented in jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicAMIFvPatchField< Type >, and jumpCyclicAMIFvPatchField< scalar >.

Definition at line 197 of file cyclicAMIFvPatchField.C.

◆ updateInterfaceMatrix() [2/2]

void updateInterfaceMatrix	(	Field< Type > &	result,
		const bool	add,
		const lduAddressing &	lduAddr,
		const label	patchId,
		const Field< Type > &	psiInternal,
		const scalarField &	coeffs,
		const Pstream::commsTypes	commsType
	)		const

virtual

Update result field based on interface functionality.

Implements coupledFvPatchField< Type >.

Reimplemented in jumpCyclicAMIFvPatchField< Type >, and jumpCyclicAMIFvPatchField< scalar >.

Definition at line 235 of file cyclicAMIFvPatchField.C.

◆ manipulateMatrix()

void manipulateMatrix	(	fvMatrix< Type > &	m,
		const label	iMatrix,
		const direction	cmpt
	)

virtual

Manipulate matrix.

Reimplemented from fvPatchField< Type >.

Definition at line 272 of file cyclicAMIFvPatchField.C.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Does the patch field perform the transformation.

Implements cyclicAMILduInterfaceField.

Definition at line 242 of file cyclicAMIFvPatchField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 249 of file cyclicAMIFvPatchField.H.

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicAMILduInterfaceField.

Definition at line 255 of file cyclicAMIFvPatchField.H.

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicAMILduInterfaceField.

Definition at line 261 of file cyclicAMIFvPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from coupledFvPatchField< Type >.

Reimplemented in fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, uniformJumpAMIFvPatchField< Type >, and energyJumpAMIFvPatchScalarField.

Definition at line 439 of file cyclicAMIFvPatchField.C.

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

src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::cyclicAMIFvPatchField< Type >

Constructor & Destructor Documentation

◆ cyclicAMIFvPatchField() [1/5]

◆ cyclicAMIFvPatchField() [2/5]

◆ cyclicAMIFvPatchField() [3/5]

◆ cyclicAMIFvPatchField() [4/5]

◆ cyclicAMIFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ cyclicAMIPatch()

◆ coupled()

◆ patchNeighbourField()

◆ neighbourPatchField()

◆ updateInterfaceMatrix() [1/2]

◆ updateInterfaceMatrix() [2/2]

◆ manipulateMatrix()

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

◆ write()

template<class Type>
class Foam::cyclicAMIFvPatchField< Type >