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

This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified, optionally time-varying, mean value. This extrapolated field is applied as a fixedValue for outflow faces but zeroGradient is applied to inflow faces. More...

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

Public Member Functions

 TypeName ("fixedMeanOutletInlet")
 
 fixedMeanOutletInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 fixedMeanOutletInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 fixedMeanOutletInletFvPatchField (const fixedMeanOutletInletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fixedMeanOutletInletFvPatchField (const fixedMeanOutletInletFvPatchField< Type > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 fixedMeanOutletInletFvPatchField (const fixedMeanOutletInletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from outletInletFvPatchField< Type >
 TypeName ("outletInlet")
 
 outletInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 outletInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 outletInletFvPatchField (const outletInletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 outletInletFvPatchField (const outletInletFvPatchField< Type > &)
 
 outletInletFvPatchField (const outletInletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
- Public Member Functions inherited from mixedFvPatchField< Type >
 TypeName ("mixed")
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &)
 
 mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
virtual Field< Type > & refValue ()
 
virtual const Field< Type > & refValue () const
 
virtual Field< Type > & refGrad ()
 
virtual const Field< Type > & refGrad () const
 
virtual scalarFieldvalueFraction ()
 
virtual const scalarFieldvalueFraction () const
 
virtual Field< Type > & source ()
 
virtual const Field< Type > & source () const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual tmp< Field< Type > > snGrad () const
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
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 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
 
- Protected Attributes inherited from outletInletFvPatchField< Type >
word phiName_
 

Detailed Description

template<class Type>
class Foam::fixedMeanOutletInletFvPatchField< Type >

This boundary condition extrapolates field to the patch using the near-cell values and adjusts the distribution to match the specified, optionally time-varying, mean value. This extrapolated field is applied as a fixedValue for outflow faces but zeroGradient is applied to inflow faces.

This boundary condition can be applied to pressure when inletOutlet is applied to the velocity so that a zeroGradient condition is applied to the pressure at inflow faces where the velocity is specified to avoid an unphysical over-specification of the set of boundary conditions.

Usage
Property Description Required Default value
meanValue mean value Function1 yes
phi Flux field name no phi

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedMeanOutletInlet;
        meanValue       1.0;
    }
See also
Foam::fixedMeanFvPatchField Foam::outletInletFvPatchField Foam::Function1Types
Source files

Definition at line 95 of file fixedMeanOutletInletFvPatchField.H.

Constructor & Destructor Documentation

◆ fixedMeanOutletInletFvPatchField() [1/5]

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

Definition at line 30 of file fixedMeanOutletInletFvPatchField.C.

◆ fixedMeanOutletInletFvPatchField() [2/5]

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

Definition at line 42 of file fixedMeanOutletInletFvPatchField.C.

References dict, p, and Foam::Zero.

◆ fixedMeanOutletInletFvPatchField() [3/5]

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

Definition at line 66 of file fixedMeanOutletInletFvPatchField.C.

◆ fixedMeanOutletInletFvPatchField() [4/5]

Definition at line 80 of file fixedMeanOutletInletFvPatchField.C.

◆ fixedMeanOutletInletFvPatchField() [5/5]

Definition at line 91 of file fixedMeanOutletInletFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedMeanOutletInlet"  )

◆ clone() [1/2]

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

Reimplemented from outletInletFvPatchField< Type >.

Definition at line 145 of file fixedMeanOutletInletFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from outletInletFvPatchField< Type >.

Definition at line 162 of file fixedMeanOutletInletFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs
virtual

Reimplemented from outletInletFvPatchField< Type >.

Definition at line 104 of file fixedMeanOutletInletFvPatchField.C.

References Foam::gSum(), Foam::mag(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from outletInletFvPatchField< Type >.

Definition at line 136 of file fixedMeanOutletInletFvPatchField.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: