This boundary condition provides a base class for coupled-cyclic conditions with a specified 'jump' (or offset) between the values. More...

Inheritance diagram for jumpCyclicFvPatchField< Type >:

[legend]

Collaboration diagram for jumpCyclicFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("jumpCyclic")

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

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

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

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< Type > &)

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

virtual const word &	interfaceFieldType () const

virtual tmp< Field< Type > >	jump () const =0

tmp< Field< Type > >	patchNeighbourField () 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

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

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

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

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

Public Member Functions inherited from cyclicFvPatchField< Type >
	TypeName (cyclicFvPatch::typeName_())

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

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

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

	cyclicFvPatchField (const cyclicFvPatchField< Type > &)

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

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

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

const cyclicFvPatch &	cyclicPatch () const

const cyclicFvPatchField< Type > &	neighbourPatchField () const

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

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 cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")

	cyclicLduInterfaceField ()=default

virtual	~cyclicLduInterfaceField ()=default

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

void	transformCoupleField (solveScalarField &f, 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 bool	coupled () const

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

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

This boundary condition provides a base class for coupled-cyclic conditions with a specified 'jump' (or offset) between the values.

See also: Foam::cyclicFvPatchField

Source files

Definition at line 55 of file jumpCyclicFvPatchField.H.

Constructor & Destructor Documentation

◆ jumpCyclicFvPatchField() [1/5]

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

Definition at line 28 of file jumpCyclicFvPatchField.C.

◆ jumpCyclicFvPatchField() [2/5]

jumpCyclicFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict,
		const bool	valueRequired = `true`
	)

Definition at line 52 of file jumpCyclicFvPatchField.C.

◆ jumpCyclicFvPatchField() [3/5]

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

Definition at line 39 of file jumpCyclicFvPatchField.C.

◆ jumpCyclicFvPatchField() [4/5]

jumpCyclicFvPatchField ( const jumpCyclicFvPatchField< Type > & ptf )

Definition at line 68 of file jumpCyclicFvPatchField.C.

◆ jumpCyclicFvPatchField() [5/5]

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

Definition at line 78 of file jumpCyclicFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "jumpCyclic" )

◆ interfaceFieldType()

virtual const word& interfaceFieldType ( ) const

inlinevirtual

Reimplemented from lduInterfaceField.

Definition at line 112 of file jumpCyclicFvPatchField.H.

◆ jump()

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

pure virtual

Implemented in fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, and fixedJumpFvPatchField< vector >.

◆ patchNeighbourField()

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

virtual

Reimplemented from cyclicFvPatchField< Type >.

Definition at line 91 of file jumpCyclicFvPatchField.C.

◆ updateInterfaceMatrix() [1/6]

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

Reimplemented from cyclicFvPatchField< Type >.

Definition at line 130 of file jumpCyclicFvPatchField.C.

◆ updateInterfaceMatrix() [2/6]

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

Reimplemented from cyclicFvPatchField< Type >.

Definition at line 147 of file jumpCyclicFvPatchField.C.

◆ updateInterfaceMatrix() [3/6]

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

Reimplemented from cyclicFvPatchField< Type >.

◆ updateInterfaceMatrix() [4/6]

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

Reimplemented from cyclicFvPatchField< Type >.

◆ updateInterfaceMatrix() [5/6]

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

virtual

Reimplemented from cyclicFvPatchField< Type >.

Definition at line 37 of file jumpCyclicFvPatchFields.C.

◆ updateInterfaceMatrix() [6/6]

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

virtual

Reimplemented from cyclicFvPatchField< Type >.

Definition at line 95 of file jumpCyclicFvPatchFields.C.

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

src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.H
src/finiteVolume/fields/fvPatchFields/constraint/jumpCyclic/jumpCyclicFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::jumpCyclicFvPatchField< Type >

Constructor & Destructor Documentation

◆ jumpCyclicFvPatchField() [1/5]

◆ jumpCyclicFvPatchField() [2/5]

◆ jumpCyclicFvPatchField() [3/5]

◆ jumpCyclicFvPatchField() [4/5]

◆ jumpCyclicFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ interfaceFieldType()

◆ jump()

◆ patchNeighbourField()

◆ updateInterfaceMatrix() [1/6]

◆ updateInterfaceMatrix() [2/6]

◆ updateInterfaceMatrix() [3/6]

◆ updateInterfaceMatrix() [4/6]

◆ updateInterfaceMatrix() [5/6]

◆ updateInterfaceMatrix() [6/6]

template<class Type>
class Foam::jumpCyclicFvPatchField< Type >