This boundary condition provides a uniform fixed gradient condition. More...

Inheritance diagram for uniformFixedGradientFvPatchField< Type >:

Collaboration diagram for uniformFixedGradientFvPatchField< Type >:

Public Member Functions
	TypeName ("uniformFixedGradient")

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

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

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

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

	uniformFixedGradientFvPatchField (const uniformFixedGradientFvPatchField< Type > &)

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

	uniformFixedGradientFvPatchField (const uniformFixedGradientFvPatchField< 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 fixedGradientFvPatchField< Type >
	TypeName ("fixedGradient")

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

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

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

	fixedGradientFvPatchField (const fixedGradientFvPatchField< Type > &)

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

virtual Field< Type > &	gradient ()

virtual const Field< Type > &	gradient () const

virtual void	autoMap (const fvPatchFieldMapper &)

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

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

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

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

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

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () 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 tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) 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 void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

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 > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

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

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

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

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

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

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

This boundary condition provides a uniform fixed gradient condition.

Usage

Property	Description	Required	Default
`uniformGradient`	uniform gradient	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            uniformFixedGradient;
        uniformGradient constant 0.2;
    }

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

See also: Foam::Function1Types Foam::fixedGradientFvPatchField

Source files

Definition at line 86 of file uniformFixedGradientFvPatchField.H.

Constructor & Destructor Documentation

◆ uniformFixedGradientFvPatchField() [1/6]

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

Definition at line 28 of file uniformFixedGradientFvPatchField.C.

◆ uniformFixedGradientFvPatchField() [2/6]

uniformFixedGradientFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const Field< Type > &	fld
	)

Definition at line 40 of file uniformFixedGradientFvPatchField.C.

◆ uniformFixedGradientFvPatchField() [3/6]

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

Definition at line 53 of file uniformFixedGradientFvPatchField.C.

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

Here is the call graph for this function:

◆ uniformFixedGradientFvPatchField() [4/6]

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

Definition at line 72 of file uniformFixedGradientFvPatchField.C.

◆ uniformFixedGradientFvPatchField() [5/6]

uniformFixedGradientFvPatchField ( const uniformFixedGradientFvPatchField< Type > & ptf )

Definition at line 86 of file uniformFixedGradientFvPatchField.C.

◆ uniformFixedGradientFvPatchField() [6/6]

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

Definition at line 97 of file uniformFixedGradientFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "uniformFixedGradient" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedGradientFvPatchField< Type >.

Definition at line 143 of file uniformFixedGradientFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedGradientFvPatchField< Type >.

Definition at line 160 of file uniformFixedGradientFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 116 of file uniformFixedGradientFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedGradientFvPatchField< Type >.

Definition at line 131 of file uniformFixedGradientFvPatchField.C.

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

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformFixedGradientFvPatchField< Type >

Constructor & Destructor Documentation

◆ uniformFixedGradientFvPatchField() [1/6]

◆ uniformFixedGradientFvPatchField() [2/6]

◆ uniformFixedGradientFvPatchField() [3/6]

◆ uniformFixedGradientFvPatchField() [4/6]

◆ uniformFixedGradientFvPatchField() [5/6]

◆ uniformFixedGradientFvPatchField() [6/6]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::uniformFixedGradientFvPatchField< Type >