This boundary condition provides a jump condition, using the cyclic condition as a base. The jump is specified as a time-varying uniform value across the patch. More...

Inheritance diagram for uniformJumpFvPatchField< Type >:

[legend]

Collaboration diagram for uniformJumpFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("uniformJump")

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

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

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

	uniformJumpFvPatchField (const uniformJumpFvPatchField< Type > &)

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

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

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

virtual void	updateCoeffs ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from fixedJumpFvPatchField< Type >
	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 > &)

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

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

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

Protected Attributes
autoPtr< Function1< Type > >	jumpTable_

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

This boundary condition provides a jump condition, using the cyclic condition as a base. The jump is specified as a time-varying uniform value across the patch.

Usage

Property	Description	Required	Default
`patchType`	underlying patch type should be `cyclic`	yes
`jumpTable`	jump value	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            uniformJump;
        patchType       cyclic;
        jumpTable       constant 10;
    }

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

Note: The uniformValue entry is a Function1 type, able to describe time varying functions. The example above gives the usage for supplying a constant value.

The underlying patchType should be set to cyclic

See also: Foam::fixedJumpFvPatchField Foam::Function1Types

Source files

Definition at line 98 of file uniformJumpFvPatchField.H.

Constructor & Destructor Documentation

◆ uniformJumpFvPatchField() [1/5]

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

Definition at line 28 of file uniformJumpFvPatchField.C.

◆ uniformJumpFvPatchField() [2/5]

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

Definition at line 54 of file uniformJumpFvPatchField.C.

References dict, Foam::stringOps::evaluate(), Foam::New(), and p.

Here is the call graph for this function:

◆ uniformJumpFvPatchField() [3/5]

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

Definition at line 40 of file uniformJumpFvPatchField.C.

◆ uniformJumpFvPatchField() [4/5]

uniformJumpFvPatchField ( const uniformJumpFvPatchField< Type > & ptf )

Definition at line 88 of file uniformJumpFvPatchField.C.

◆ uniformJumpFvPatchField() [5/5]

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

Definition at line 99 of file uniformJumpFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformJump" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 151 of file uniformJumpFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 168 of file uniformJumpFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 112 of file uniformJumpFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 129 of file uniformJumpFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

Member Data Documentation

◆ jumpTable_

autoPtr<Function1<Type> > jumpTable_

protected

Definition at line 108 of file uniformJumpFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformJumpFvPatchField< Type >

Constructor & Destructor Documentation

◆ uniformJumpFvPatchField() [1/5]

◆ uniformJumpFvPatchField() [2/5]

◆ uniformJumpFvPatchField() [3/5]

◆ uniformJumpFvPatchField() [4/5]

◆ uniformJumpFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ jumpTable_

template<class Type>
class Foam::uniformJumpFvPatchField< Type >