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_())

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

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

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

	cyclicAMIFvPatchField (const cyclicAMIFvPatchField< Type > &)

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

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

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

const cyclicAMIFvPatch &	cyclicAMIPatch () const

virtual bool	coupled () const

virtual tmp< Field< Type > >	patchNeighbourField () const

const cyclicAMIFvPatchField< Type > &	neighbourPatchField () const

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

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

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

virtual bool	doTransform () const

virtual const tensorField &	forwardT () const

virtual const tensorField &	reverseT () const

virtual int	rank () const

virtual void	write (Ostream &os) const

Public Member Functions inherited from cyclicAMILduInterfaceField
	TypeName ("cyclicAMILduInterfaceField")

	cyclicAMILduInterfaceField ()

virtual	~cyclicAMILduInterfaceField ()

template<class Type >
void	transformCoupleField (Field< Type > &f) const

void	transformCoupleField (solveScalarField &psiInternal, const direction cmpt) const

Public Member Functions inherited from coupledFvPatchField< Type >
	TypeName (coupledFvPatch::typeName_())

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	coupledFvPatchField (const coupledFvPatchField< Type > &)

	coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	snGrad () const

virtual void	initEvaluate (const Pstream::commsTypes commsType)

virtual void	evaluate (const Pstream::commsTypes commsType)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")

	LduInterfaceField (const lduInterface &patch)

virtual	~LduInterfaceField ()=default

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const

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

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")

	lduInterfaceField (const lduInterface &patch)

virtual	~lduInterfaceField ()=default

const lduInterface &	interface () const

virtual const word &	interfaceFieldType () const

bool	updatedMatrix () const

bool &	updatedMatrix ()

virtual bool	ready () const

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

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")

	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 > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

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

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

const DimensionedField< Type, volMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchField< Type > &, const labelList &)

virtual tmp< Field< Type > >	snGrad () const

virtual void	updateCoeffs ()

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

void	check (const fvPatchField< Type > &) const

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

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

virtual void	operator= (const Type &)

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

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

virtual void	operator+= (const Type &)

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

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

virtual void	operator-= (const Type &)

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

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

virtual void	operator*= (const scalar)

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

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

virtual void	operator/= (const scalar)

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

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

virtual void	operator== (const Type &)

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 > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

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 73 of file cyclicAMIFvPatchField.H.

Constructor & Destructor Documentation

◆ cyclicAMIFvPatchField() [1/5]

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

Definition at line 30 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [2/5]

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

Definition at line 43 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [3/5]

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

Definition at line 80 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [4/5]

cyclicAMIFvPatchField ( const cyclicAMIFvPatchField< Type > & ptf )

Definition at line 105 of file cyclicAMIFvPatchField.C.

◆ cyclicAMIFvPatchField() [5/5]

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

Definition at line 117 of file cyclicAMIFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicAMIFvPatch::typeName_() )

◆ clone() [1/2]

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

inlinevirtual

Implements coupledFvPatchField< Type >.

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

Definition at line 149 of file cyclicAMIFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Implements coupledFvPatchField< Type >.

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

Definition at line 166 of file cyclicAMIFvPatchField.H.

◆ cyclicAMIPatch()

const cyclicAMIFvPatch& cyclicAMIPatch ( ) const

inline

Definition at line 182 of file cyclicAMIFvPatchField.H.

◆ coupled()

bool coupled

virtual

Reimplemented from coupledFvPatchField< Type >.

Definition at line 131 of file cyclicAMIFvPatchField.C.

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Type > > patchNeighbourField

virtual

Implements coupledFvPatchField< Type >.

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

Definition at line 139 of file cyclicAMIFvPatchField.C.

◆ neighbourPatchField()

const Foam::cyclicAMIFvPatchField< Type > & neighbourPatchField

Definition at line 173 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

Implements coupledFvPatchField< Type >.

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

Definition at line 190 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

Implements coupledFvPatchField< Type >.

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

Definition at line 228 of file cyclicAMIFvPatchField.C.

◆ manipulateMatrix()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 265 of file cyclicAMIFvPatchField.C.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Implements cyclicAMILduInterfaceField.

Definition at line 238 of file cyclicAMIFvPatchField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Implements cyclicAMILduInterfaceField.

Definition at line 245 of file cyclicAMIFvPatchField.H.

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Implements cyclicAMILduInterfaceField.

Definition at line 251 of file cyclicAMIFvPatchField.H.

◆ rank()

virtual int rank ( ) const

inlinevirtual

Implements cyclicAMILduInterfaceField.

Definition at line 257 of file cyclicAMIFvPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from coupledFvPatchField< Type >.

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

Definition at line 432 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 >