Public Member Functions | List of all members
fixedValueFvPatchField< Type > Class Template Reference
Boundary conditions » Generic

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 >:
Inheritance graph
[legend]
Collaboration diagram for fixedValueFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fixedValue")
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 
 fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
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
 
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")
 
 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 void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
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 void evaluate (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 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::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 76 of file fixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedValueFvPatchField() [1/6]

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

Definition at line 27 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [2/6]

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

Definition at line 38 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [3/6]

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

Definition at line 50 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [4/6]

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

Definition at line 63 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [5/6]

fixedValueFvPatchField ( const fixedValueFvPatchField< Type > &  ptf)

Definition at line 86 of file fixedValueFvPatchField.C.

◆ fixedValueFvPatchField() [6/6]

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

Definition at line 96 of file fixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue"  )

◆ clone() [1/2]

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

Reimplemented in turbulentInletFvPatchField< Type >, codedFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, fixedProfileFvPatchField< Type >, mappedFieldFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, exprFixedValueFvPatchField< Type >, fixedMeanFvPatchField< Type >, cellMotionFvPatchField< Type >, and adjointZeroInletFvPatchField< Type >.

Definition at line 130 of file fixedValueFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from fvPatchField< Type >.

Reimplemented in turbulentInletFvPatchField< Type >, codedFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, fixedProfileFvPatchField< Type >, mappedFieldFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, exprFixedValueFvPatchField< Type >, fixedMeanFvPatchField< Type >, cellMotionFvPatchField< Type >, adjointZeroInletFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, kLowReWallFunctionFvPatchScalarField, atmEpsilonWallFunctionFvPatchScalarField, atmOmegaWallFunctionFvPatchScalarField, and thermalShellFvPatchScalarField.

Definition at line 147 of file fixedValueFvPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Definition at line 165 of file fixedValueFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Definition at line 171 of file fixedValueFvPatchField.H.

◆ valueInternalCoeffs()

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

Reimplemented in adjointZeroInletFvPatchField< Type >.

Definition at line 110 of file fixedValueFvPatchField.C.

◆ valueBoundaryCoeffs()

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

Reimplemented in adjointZeroInletFvPatchField< Type >.

Definition at line 124 of file fixedValueFvPatchField.C.

◆ gradientInternalCoeffs()

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

Definition at line 134 of file fixedValueFvPatchField.C.

◆ gradientBoundaryCoeffs()

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

Definition at line 142 of file fixedValueFvPatchField.C.

◆ write()

void write ( Ostream &  os) const
virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in uniformFixedValueFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, exprFixedValueFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, turbulentInletFvPatchField< Type >, codedFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, kLowReWallFunctionFvPatchScalarField, atmEpsilonWallFunctionFvPatchScalarField, atmOmegaWallFunctionFvPatchScalarField, mappedFieldFvPatchField< Type >, fixedProfileFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, thermalShellFvPatchScalarField, fixedMeanFvPatchField< Type >, and cellMotionFvPatchField< Type >.

Definition at line 149 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 208 of file fixedValueFvPatchField.H.

◆ operator=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 210 of file fixedValueFvPatchField.H.

◆ operator+=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 211 of file fixedValueFvPatchField.H.

◆ operator-=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 212 of file fixedValueFvPatchField.H.

◆ operator*=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 213 of file fixedValueFvPatchField.H.

◆ operator/=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 214 of file fixedValueFvPatchField.H.

◆ operator+=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 216 of file fixedValueFvPatchField.H.

◆ operator-=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 217 of file fixedValueFvPatchField.H.

◆ operator*=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 219 of file fixedValueFvPatchField.H.

◆ operator/=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 220 of file fixedValueFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 222 of file fixedValueFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file fixedValueFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 224 of file fixedValueFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 225 of file fixedValueFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 226 of file fixedValueFvPatchField.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17