This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. More...

Inheritance diagram for fixedValueFvPatchField< Type >:

[legend]

Collaboration diagram for fixedValueFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("fixedValue")
	Runtime type information. More...

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

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

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

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

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

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

	fixedValueFvPatchField (const fixedValueFvPatchField< 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 bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	assignable () const
	Return false: this patch field is not altered by assignment. 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...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

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 Type &value)
	Construct from patch, internal field and value. 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=true)
	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	~fvPatchField ()=default
	Destructor. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

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

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

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

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

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

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

word &	patchType ()
	Optional patch type. 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 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 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	updateWeightedCoeffs (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::commsTypes::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field, sets Updated to false. More...

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

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source 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 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...

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

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

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

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

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

template<class Type2 >
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::fixedValueFvPatchField< Type >

This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions.

Usage

Property	Description	Required	Default value
`value`	Patch face values	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedValue;
        value           uniform 0;  // Example for scalar field usage
    }

Source files

Definition at line 80 of file fixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedValueFvPatchField() [1/6]

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

Construct from patch and internal field.

Definition at line 34 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [2/6]

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

Construct from patch, internal field and value.

Definition at line 45 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 57 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [4/6]

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

Construct by mapping the given fixedValueFvPatchField<Type>

onto a new patch

Definition at line 70 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [5/6]

fixedValueFvPatchField ( const fixedValueFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 93 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 103 of file fixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fvPatchField< Type >.

Definition at line 134 of file fixedValueFvPatchField.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 >.

Definition at line 151 of file fixedValueFvPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented from fvPatchField< Type >.

Definition at line 169 of file fixedValueFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

Return false: this patch field is not altered by assignment.

Reimplemented from fvPatchField< Type >.

Definition at line 175 of file fixedValueFvPatchField.H.

◆ valueInternalCoeffs()

Foam::tmp< Foam::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 in adjointZeroInletFvPatchField< Type >.

Definition at line 117 of file fixedValueFvPatchField.C.

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::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 in adjointZeroInletFvPatchField< Type >.

Definition at line 131 of file fixedValueFvPatchField.C.

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 141 of file fixedValueFvPatchField.C.

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 149 of file fixedValueFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 156 of file fixedValueFvPatchField.C.

Referenced by thermalShellFvPatchScalarField::write(), kLowReWallFunctionFvPatchScalarField::write(), epsilonWallFunctionFvPatchScalarField::write(), omegaWallFunctionFvPatchScalarField::write(), and turbulentDigitalFilterInletFvPatchVectorField::write().

Here is the caller graph for this function:

◆ operator=() [1/3]

virtual void operator= ( const UList< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 212 of file fixedValueFvPatchField.H.

◆ operator=() [2/3]

virtual void operator= ( const fvPatchField< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 214 of file fixedValueFvPatchField.H.

◆ operator+=() [1/3]

virtual void operator+= ( const fvPatchField< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 215 of file fixedValueFvPatchField.H.

◆ operator-=() [1/3]

virtual void operator-= ( const fvPatchField< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 216 of file fixedValueFvPatchField.H.

◆ operator*=() [1/3]

virtual void operator*= ( const fvPatchField< scalar > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 217 of file fixedValueFvPatchField.H.

◆ operator/=() [1/3]

virtual void operator/= ( const fvPatchField< scalar > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 218 of file fixedValueFvPatchField.H.

◆ operator+=() [2/3]

virtual void operator+= ( const Field< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 220 of file fixedValueFvPatchField.H.

◆ operator-=() [2/3]

virtual void operator-= ( const Field< Type > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file fixedValueFvPatchField.H.

◆ operator*=() [2/3]

virtual void operator*= ( const Field< scalar > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file fixedValueFvPatchField.H.

◆ operator/=() [2/3]

virtual void operator/= ( const Field< scalar > & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 224 of file fixedValueFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 226 of file fixedValueFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 227 of file fixedValueFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 228 of file fixedValueFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 229 of file fixedValueFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 230 of file fixedValueFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fixedValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ fixedValueFvPatchField() [1/6]

◆ fixedValueFvPatchField() [2/6]

◆ fixedValueFvPatchField() [3/6]

◆ fixedValueFvPatchField() [4/6]

◆ fixedValueFvPatchField() [5/6]

◆ fixedValueFvPatchField() [6/6]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fixesValue()

◆ assignable()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ write()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator+=() [1/3]

◆ operator-=() [1/3]

◆ operator*=() [1/3]

◆ operator/=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [2/3]

◆ operator*=() [2/3]

◆ operator/=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]

template<class Type>
class Foam::fixedValueFvPatchField< Type >