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 dictionary &)
	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 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 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 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	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 void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field, sets Updated to false. 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 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

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

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

Patch usage

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

Example of the boundary condition specification:

    myPatch
    {
        type            fixedValue;
        value           uniform 0;  // example for scalar field usage
    }

Source files

Definition at line 79 of file fixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedValueFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 37 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 48 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [3/5]

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 60 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [4/5]

fixedValueFvPatchField ( const fixedValueFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 83 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 93 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.

Definition at line 124 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 141 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.

Definition at line 159 of file fixedValueFvPatchField.H.

◆ 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 106 of file fixedValueFvPatchField.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 119 of file fixedValueFvPatchField.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 128 of file fixedValueFvPatchField.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 135 of file fixedValueFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 142 of file fixedValueFvPatchField.C.

Referenced by fWallFunctionFvPatchScalarField::write(), v2WallFunctionFvPatchScalarField::write(), kLowReWallFunctionFvPatchScalarField::write(), epsilonWallFunctionFvPatchScalarField::write(), oscillatingFixedValueFvPatchField< Type >::write(), and omegaWallFunctionFvPatchScalarField::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 196 of file fixedValueFvPatchField.H.

◆ operator=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 198 of file fixedValueFvPatchField.H.

◆ operator+=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 199 of file fixedValueFvPatchField.H.

◆ operator-=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 200 of file fixedValueFvPatchField.H.

◆ operator*=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 201 of file fixedValueFvPatchField.H.

◆ operator/=() [1/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 202 of file fixedValueFvPatchField.H.

◆ operator+=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 204 of file fixedValueFvPatchField.H.

◆ operator-=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 205 of file fixedValueFvPatchField.H.

◆ operator*=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 207 of file fixedValueFvPatchField.H.

◆ operator/=() [2/3]

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

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 208 of file fixedValueFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 210 of file fixedValueFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 211 of file fixedValueFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type & )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 212 of file fixedValueFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 213 of file fixedValueFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 214 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/5]

◆ fixedValueFvPatchField() [2/5]

◆ fixedValueFvPatchField() [3/5]

◆ fixedValueFvPatchField() [4/5]

◆ fixedValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fixesValue()

◆ 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 >