Public Member Functions | List of all members
uniformFixedValueFvPatchField< Type > Class Template Reference

This boundary condition provides a uniform fixed value condition. More...

Inheritance diagram for uniformFixedValueFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for uniformFixedValueFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("uniformFixedValue")
 
 uniformFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 uniformFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &fld)
 
 uniformFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 uniformFixedValueFvPatchField (const uniformFixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 uniformFixedValueFvPatchField (const uniformFixedValueFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 uniformFixedValueFvPatchField (const uniformFixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &os) const
 
- Public Member Functions inherited from fixedValueFvPatchField< Type >
 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 > &)
 
 fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
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 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 objectRegistrydb () const
 
const fvPatchpatch () const
 
const DimensionedField< Type, volMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const wordpatchType () const
 
wordpatchType ()
 
bool updated () const
 
bool manipulatedMatrix () const
 
virtual tmp< Field< Type > > snGrad () const
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
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 wordcalculatedType ()
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 

Detailed Description

template<class Type>
class Foam::uniformFixedValueFvPatchField< Type >

This boundary condition provides a uniform fixed value condition.

Usage
Property Description Required Default
uniformValue uniform value yes

Example of the boundary condition specification:

    <patchName>
    {
        type            uniformFixedValue;
        uniformValue    constant 0.2;
    }
Note
The uniformValue entry is a PatchFunction1 type, able to describe time and spatial varying functions. The example above gives the usage for supplying a constant value.
See also
Foam::Function1Types Foam::fixedValueFvPatchField
Source files

Definition at line 86 of file uniformFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ uniformFixedValueFvPatchField() [1/6]

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

Definition at line 28 of file uniformFixedValueFvPatchField.C.

◆ uniformFixedValueFvPatchField() [2/6]

uniformFixedValueFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const Field< Type > &  fld 
)

Definition at line 40 of file uniformFixedValueFvPatchField.C.

◆ uniformFixedValueFvPatchField() [3/6]

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

Definition at line 53 of file uniformFixedValueFvPatchField.C.

References dict, Foam::stringOps::evaluate(), and p.

Here is the call graph for this function:

◆ uniformFixedValueFvPatchField() [4/6]

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

Definition at line 78 of file uniformFixedValueFvPatchField.C.

References FieldMapper::direct(), Foam::stringOps::evaluate(), and FieldMapper::hasUnmapped().

Here is the call graph for this function:

◆ uniformFixedValueFvPatchField() [5/6]

Definition at line 103 of file uniformFixedValueFvPatchField.C.

◆ uniformFixedValueFvPatchField() [6/6]

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

Definition at line 114 of file uniformFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformFixedValue"  )

◆ clone() [1/2]

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

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 143 of file uniformFixedValueFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 160 of file uniformFixedValueFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper mapper)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 128 of file uniformFixedValueFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ rmap()

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

Reimplemented from fvPatchField< Type >.

Definition at line 145 of file uniformFixedValueFvPatchField.C.

◆ updateCoeffs()

void updateCoeffs
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 160 of file uniformFixedValueFvPatchField.C.

References Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 174 of file uniformFixedValueFvPatchField.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: