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")
	Runtime type information. More...

	fixedGradientFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fixedGradientFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	fixedGradientFvPatchField (const fixedGradientFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fixedGradientFvPatchField. More...

	fixedGradientFvPatchField (const fixedGradientFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	fixedGradientFvPatchField (const fixedGradientFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual Field< Type > &	gradient ()
	Return gradient at boundary. More...

virtual const Field< Type > &	gradient () const

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	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 > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

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

Private Attributes
Field< Type >	gradient_

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

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

Patch usage

Property	Description	Required	Default value
`gradient`	gradient	yes

Example of the boundary condition specification:

    myPatch
    {
        type            fixedGradient;
        gradient        uniform 0;
    }

Source files

Definition at line 107 of file fixedGradientFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedGradientFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 38 of file fixedGradientFvPatchField.C.

◆ fixedGradientFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 74 of file fixedGradientFvPatchField.C.

◆ fixedGradientFvPatchField() [3/5]

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

Construct by mapping the given fixedGradientFvPatchField.

onto a new patch

Definition at line 50 of file fixedGradientFvPatchField.C.

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

Here is the call graph for this function:

◆ fixedGradientFvPatchField() [4/5]

fixedGradientFvPatchField ( const fixedGradientFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 89 of file fixedGradientFvPatchField.C.

◆ fixedGradientFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 100 of file fixedGradientFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedGradient" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 156 of file fixedGradientFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fvPatchField< Type >.

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 173 of file fixedGradientFvPatchField.H.

◆ gradient() [1/2]

virtual Field<Type>& gradient ( )

inlinevirtual

Return gradient at boundary.

Definition at line 189 of file fixedGradientFvPatchField.H.

References fixedGradientFvPatchField< Type >::gradient_.

Referenced by externalCoupledFunctionObject::readData(), and humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ gradient() [2/2]

virtual const Field<Type>& gradient ( ) const

inlinevirtual

Definition at line 194 of file fixedGradientFvPatchField.H.

References fixedGradientFvPatchField< Type >::gradient_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from fvPatchField< Type >.

Definition at line 114 of file fixedGradientFvPatchField.C.

References fvPatchField::autoMap().

Here is the call graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 125 of file fixedGradientFvPatchField.C.

References fixedGradientFvPatchField< Type >::gradient_, fixedGradientFvPatchField< Type >::rmap(), and fvPatchField::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

Return gradient at boundary.

Definition at line 219 of file fixedGradientFvPatchField.H.

References fixedGradientFvPatchField< Type >::gradient_.

◆ evaluate()

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

virtual

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 140 of file fixedGradientFvPatchField.C.

References fvPatchField::evaluate().

Here is the call graph for this function:

◆ valueInternalCoeffs()

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

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 158 of file fixedGradientFvPatchField.C.

◆ valueBoundaryCoeffs()

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

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from fvPatchField< Type >.

Definition at line 168 of file fixedGradientFvPatchField.C.

◆ gradientInternalCoeffs()

tmp< Field< Type > > gradientInternalCoeffs

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 178 of file fixedGradientFvPatchField.C.

◆ gradientBoundaryCoeffs()

tmp< Field< Type > > gradientBoundaryCoeffs

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 189 of file fixedGradientFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvPatchField< Type >.

Reimplemented in uniformFixedGradientFvPatchField< Type >.

Definition at line 196 of file fixedGradientFvPatchField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ gradient_

Field<Type> gradient_

private

Definition at line 113 of file fixedGradientFvPatchField.H.

Referenced by fixedGradientFvPatchField< Type >::gradient(), fixedGradientFvPatchField< Type >::rmap(), and fixedGradientFvPatchField< Type >::snGrad().

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

Private Attributes

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

Field Documentation

◆ gradient_

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