fixedJumpFvPatchField< Type > Class Template Reference

This boundary condition provides a jump condition, using the cyclic condition as a base. More...

Inheritance diagram for fixedJumpFvPatchField< Type >:

Collaboration diagram for fixedJumpFvPatchField< Type >:

Public Member Functions
	TypeName ("fixedJump")
	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &)
virtual tmp< fvPatchField< Type > >	clone () const
	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
virtual void	setJump (const Field< Type > &jump)
virtual void	setJump (const Type &jump)
virtual tmp< Field< Type > >	jump () const
virtual tmp< Field< Type > >	jump0 () const
virtual scalar	relaxFactor () const
virtual void	relax ()
virtual void	autoMap (const fvPatchFieldMapper &)
virtual void	rmap (const fvPatchField< Type > &, const labelList &)
virtual void	write (Ostream &) const
Public Member Functions inherited from jumpCyclicFvPatchField< Type >
	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
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 > &)
	cyclicFvPatchField (const cyclicFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
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
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 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::fixedJumpFvPatchField< Type >

This boundary condition provides a jump condition, using the cyclic condition as a base.

The jump is specified as a fixed value field, applied as an offset to the 'owner' patch.

Usage

Property	Description	Required	Default value
patchType	underlying patch type should be cyclic	yes
jump	current jump value	yes
relax	under-relaxation factor	no
minJump	Minimum jump value	no

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedJump;
        patchType       cyclic;
        jump            uniform 10;
    }

The above example shows the use of a fixed jump of '10'.

Note

The underlying patchType should be set to cyclic

See also

Foam::jumpCyclicFvPatchField

Source files

• fixedJumpFvPatchField.H
• fixedJumpFvPatchField.C

Definition at line 107 of file fixedJumpFvPatchField.H.

Constructor & Destructor Documentation

fixedJumpFvPatchField() [1/5]

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

Definition at line 28 of file fixedJumpFvPatchField.C.

fixedJumpFvPatchField() [2/5]

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

Definition at line 62 of file fixedJumpFvPatchField.C.

fixedJumpFvPatchField() [3/5]

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

Definition at line 44 of file fixedJumpFvPatchField.C.

fixedJumpFvPatchField() [4/5]

fixedJumpFvPatchField

(

const fixedJumpFvPatchField< Type > &

ptf

)

Definition at line 108 of file fixedJumpFvPatchField.C.

fixedJumpFvPatchField() [5/5]

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

Definition at line 123 of file fixedJumpFvPatchField.C.

Member Function Documentation

TypeName()

TypeName

(

"fixedJump"

)

clone() [1/2]

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

inlinevirtual

Reimplemented from cyclicFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >, and uniformJumpFvPatchField< Type >.

Definition at line 171 of file fixedJumpFvPatchField.H.

clone() [2/2]

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

inlinevirtual

Reimplemented from cyclicFvPatchField< Type >.

Reimplemented in swirlFanVelocityFvPatchField, fanFvPatchField< Type >, uniformJumpFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, and energyJumpFvPatchScalarField.

Definition at line 188 of file fixedJumpFvPatchField.H.

setJump() [1/2]

void setJump ( const Field< Type > &  jump )

virtual

Definition at line 140 of file fixedJumpFvPatchField.C.

setJump() [2/2]

void setJump ( const Type &  jump )

virtual

Definition at line 150 of file fixedJumpFvPatchField.C.

jump()

Foam::tmp< Foam::Field< Type > > jump

virtual

Implements jumpCyclicFvPatchField< Type >.

Definition at line 160 of file fixedJumpFvPatchField.C.

jump0()

Foam::tmp< Foam::Field< Type > > jump0

virtual

Definition at line 177 of file fixedJumpFvPatchField.C.

relaxFactor()

Foam::scalar relaxFactor

virtual

Definition at line 194 of file fixedJumpFvPatchField.C.

relax()

void relax

virtual

Definition at line 201 of file fixedJumpFvPatchField.C.

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file fixedJumpFvPatchField.C.

rmap()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 233 of file fixedJumpFvPatchField.C.

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from cyclicFvPatchField< Type >.

Reimplemented in swirlFanVelocityFvPatchField, fanFvPatchField< Type >, uniformJumpFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, and energyJumpFvPatchScalarField.

Definition at line 247 of file fixedJumpFvPatchField.C.

Referenced by energyJumpFvPatchScalarField::write(), porousBafflePressureFvPatchField< Type >::write(), and swirlFanVelocityFvPatchField::write().

Here is the caller graph for this function:

---

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

• src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
• src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.C