This boundary condition supplies a fixed gradient condition, such that the patch values are calculated using: More...

Inheritance diagram for fixedGradientFvPatchField< Type >:

Collaboration diagram for fixedGradientFvPatchField< Type >:

Public Member Functions
	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 > &)

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

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

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

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

virtual void	write (Ostream &) 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	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 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::fixedGradientFvPatchField< Type >

This boundary condition supplies a fixed gradient condition, such that the patch values are calculated using:

$x_p = x_c + \frac{\nabla(x)}{\Delta}$

where

	=	patch values
	=	internal field values
$\nabla(x)$	=	gradient (user-specified)
$\Delta$	=	inverse distance from patch face centre to cell centre

Usage

Property	Description	Required	Default value
`gradient`	gradient	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedGradient;
        gradient        uniform 0;
    }

Source files

Definition at line 104 of file fixedGradientFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedGradientFvPatchField() [1/5]

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

Definition at line 28 of file fixedGradientFvPatchField.C.

◆ fixedGradientFvPatchField() [2/5]

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

Definition at line 40 of file fixedGradientFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ fixedGradientFvPatchField() [3/5]

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

Definition at line 55 of file fixedGradientFvPatchField.C.

References Foam::endl(), FieldMapper::hasUnmapped(), Foam::nl, Foam::notNull(), p, and WarningInFunction.

Here is the call graph for this function:

◆ fixedGradientFvPatchField() [4/5]

fixedGradientFvPatchField ( const fixedGradientFvPatchField< Type > & ptf )

Definition at line 79 of file fixedGradientFvPatchField.C.

◆ fixedGradientFvPatchField() [5/5]

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

Definition at line 90 of file fixedGradientFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedGradient" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 153 of file fixedGradientFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 170 of file fixedGradientFvPatchField.H.

◆ gradient() [1/2]

virtual Field<Type>& gradient ( )

inlinevirtual

Definition at line 186 of file fixedGradientFvPatchField.H.

Referenced by humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ gradient() [2/2]

virtual const Field<Type>& gradient ( ) const

inlinevirtual

Definition at line 191 of file fixedGradientFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 104 of file fixedGradientFvPatchField.C.

◆ rmap()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 115 of file fixedGradientFvPatchField.C.

References fixedGradientFvPatchField< Type >::rmap().

Referenced by fixedGradientFvPatchField< Type >::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ snGrad()

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

inlinevirtual

Definition at line 216 of file fixedGradientFvPatchField.H.

◆ evaluate()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 130 of file fixedGradientFvPatchField.C.

References Foam::stringOps::evaluate(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > & ) const

virtual

Definition at line 149 of file fixedGradientFvPatchField.C.

References Foam::New().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > & ) const

virtual

Definition at line 160 of file fixedGradientFvPatchField.C.

References Foam::foamVersion::patch.

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs

virtual

Definition at line 170 of file fixedGradientFvPatchField.C.

References Foam::New(), and Foam::Zero.

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs

virtual

Definition at line 178 of file fixedGradientFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 185 of file fixedGradientFvPatchField.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/basic/fixedGradient/fixedGradientFvPatchField.H
src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fixedGradientFvPatchField< Type >

Constructor & Destructor Documentation

◆ fixedGradientFvPatchField() [1/5]

◆ fixedGradientFvPatchField() [2/5]

◆ fixedGradientFvPatchField() [3/5]

◆ fixedGradientFvPatchField() [4/5]

◆ fixedGradientFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ gradient() [1/2]

◆ gradient() [2/2]

◆ autoMap()

◆ rmap()

◆ snGrad()

◆ evaluate()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ write()

template<class Type>
class Foam::fixedGradientFvPatchField< Type >