This boundary condition enforces a cyclic condition between a pair of boundaries. More...

Inheritance diagram for cyclicFvPatchField< Type >:

[legend]

Collaboration diagram for cyclicFvPatchField< Type >:

[legend]

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

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

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

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

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

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

	cyclicFvPatchField (const cyclicFvPatchField< 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 cyclicFvPatch &	cyclicPatch () const
	Return local reference cast into the cyclic patch. More...

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

const cyclicFvPatchField< Type > &	neighbourPatchField () const
	Return reference to neighbour patchField. More...

virtual void	updateInterfaceMatrix (scalarField &result, const scalarField &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 > &result, const Field< Type > &psiInternal, const scalarField &coeffs, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. 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 cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")
	Runtime type information. More...

	cyclicLduInterfaceField ()
	Construct given coupled patch. More...

virtual	~cyclicLduInterfaceField ()
	Destructor. More...

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

void	transformCoupleField (scalarField &f, const direction cmpt) const
	Transform given patch component 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 &)
	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 bool	coupled () const
	Return true if this patch field is derived from. 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 ()
	Destructor. More...

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

virtual void	initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...

virtual void	updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, 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 ()
	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 (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. 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 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=false)
	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 tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

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

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

virtual	~fvPatchField ()
	Destructor. More...

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

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

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

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

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

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

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

virtual bool	coupled () const
	Return true if this patch field is coupled. 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 tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

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

virtual void	updateCoeffs (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 > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

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

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () 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	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. 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 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 &)

Private Member Functions
template<class Type2 >
tmp< Field< Type2 > >	neighbourSideField (const Field< Type2 > &) const
	Return neighbour side field given internal fields. More...

Private Attributes
const cyclicFvPatch &	cyclicPatch_
	Local reference cast into the cyclic patch. More...

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

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

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::cyclicFvPatchField< Type >

This boundary condition enforces a cyclic condition between a pair of boundaries.

Patch usage

Example of the boundary condition specification:

myPatch
{
    type            cyclic;
}

Note: The patches must be topologically similar, i.e. if the owner patch is transformed to the neighbour patch, the patches should be identical (or very similar).

Source files

Definition at line 70 of file cyclicFvPatchField.H.

Constructor & Destructor Documentation

◆ cyclicFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 38 of file cyclicFvPatchField.C.

◆ cyclicFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 74 of file cyclicFvPatchField.C.

◆ cyclicFvPatchField() [3/5]

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

Construct by mapping given cyclicFvPatchField onto a new patch.

Definition at line 50 of file cyclicFvPatchField.C.

◆ cyclicFvPatchField() [4/5]

cyclicFvPatchField ( const cyclicFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 102 of file cyclicFvPatchField.C.

◆ cyclicFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 114 of file cyclicFvPatchField.C.

Member Function Documentation

◆ neighbourSideField()

tmp<Field<Type2> > neighbourSideField ( const Field< Type2 > & ) const

private

Return neighbour side field given internal fields.

◆ TypeName()

TypeName ( cyclicFvPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Implements coupledFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >, uniformJumpFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, cyclicSlipFvPatchField< Type >, and nonuniformTransformCyclicFvPatchField< Type >.

Definition at line 130 of file cyclicFvPatchField.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 fanFvPatchField< Type >, uniformJumpFvPatchField< Type >, fixedJumpFvPatchField< Type >, cyclicSlipFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, fixedJumpFvPatchField< scalar >, and energyJumpFvPatchScalarField.

Definition at line 147 of file cyclicFvPatchField.H.

◆ cyclicPatch()

const cyclicFvPatch& cyclicPatch ( ) const

inline

Return local reference cast into the cyclic patch.

Definition at line 163 of file cyclicFvPatchField.H.

◆ patchNeighbourField()

tmp< Field< Type > > patchNeighbourField

virtual

Return neighbour coupled internal cell data.

Implements coupledFvPatchField< Type >.

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

Definition at line 127 of file cyclicFvPatchField.C.

◆ neighbourPatchField()

const cyclicFvPatchField< Type > & neighbourPatchField

Return reference to neighbour patchField.

Definition at line 160 of file cyclicFvPatchField.C.

◆ updateInterfaceMatrix() [1/2]

void updateInterfaceMatrix	(	scalarField &	result,
		const scalarField &	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 jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, and jumpCyclicFvPatchField< scalar >.

Definition at line 178 of file cyclicFvPatchField.C.

◆ updateInterfaceMatrix() [2/2]

void updateInterfaceMatrix	(	Field< Type > &	result,
		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 jumpCyclicFvPatchField< Type >, and jumpCyclicFvPatchField< scalar >.

Definition at line 206 of file cyclicFvPatchField.C.

◆ doTransform()

virtual bool doTransform ( ) const

inlinevirtual

Does the patch field perform the transformation.

Implements cyclicLduInterfaceField.

Definition at line 200 of file cyclicFvPatchField.H.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 206 of file cyclicFvPatchField.H.

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterfaceField.

Definition at line 212 of file cyclicFvPatchField.H.

◆ rank()

virtual int rank ( ) const

inlinevirtual

Return rank of component for transform.

Implements cyclicLduInterfaceField.

Definition at line 218 of file cyclicFvPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from coupledFvPatchField< Type >.

Reimplemented in porousBafflePressureFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, uniformJumpFvPatchField< Type >, and energyJumpFvPatchScalarField.

Definition at line 232 of file cyclicFvPatchField.C.

Field Documentation

◆ cyclicPatch_

const cyclicFvPatch& cyclicPatch_

private

Local reference cast into the cyclic patch.

Definition at line 78 of file cyclicFvPatchField.H.

Referenced by cyclicFvPatchField< scalar >::cyclicPatch(), cyclicFvPatchField< scalar >::doTransform(), cyclicFvPatchField< scalar >::forwardT(), and cyclicFvPatchField< scalar >::reverseT().

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

src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::cyclicFvPatchField< Type >

Constructor & Destructor Documentation

◆ cyclicFvPatchField() [1/5]

◆ cyclicFvPatchField() [2/5]

◆ cyclicFvPatchField() [3/5]

◆ cyclicFvPatchField() [4/5]

◆ cyclicFvPatchField() [5/5]

Member Function Documentation

◆ neighbourSideField()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ cyclicPatch()

◆ patchNeighbourField()

◆ neighbourPatchField()

◆ updateInterfaceMatrix() [1/2]

◆ updateInterfaceMatrix() [2/2]

◆ doTransform()

◆ forwardT()

◆ reverseT()

◆ rank()

◆ write()

Field Documentation

◆ cyclicPatch_

template<class Type>
class Foam::cyclicFvPatchField< Type >