fvPatchField< Type > Class Template Reference

Abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used. More...

Inheritance diagram for fvPatchField< Type >:
[legend]

Public Types

typedef fvPatch Patch
 
typedef calculatedFvPatchField< Type > Calculated
 

Public Member Functions

 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...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 fvPatchField (const fvPatchField< 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 ~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 fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool assignable () const
 Return true if the value of the patch field. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () 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 wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 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
 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...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> 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)
 
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)
 

Static Public Member Functions

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 wordcalculatedType ()
 Return the type of the calculated for of fvPatchField. More...
 

Static Public Attributes

static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Friends

Ostreamoperator (Ostream &, const fvPatchField< Type > &)
 

Detailed Description

template<class Type>
class Foam::fvPatchField< Type >

Abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used.

The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions.

The next level of derivation covers all the specialised types with specific evaluation procedures, particularly with respect to specific fields.

Source files

Definition at line 51 of file volSurfaceMapping.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 111 of file fvPatchField.H.

◆ Calculated

Definition at line 112 of file fvPatchField.H.

Constructor & Destructor Documentation

◆ fvPatchField() [1/8]

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

Construct from patch and internal field.

Definition at line 39 of file fvPatchField.C.

◆ fvPatchField() [2/8]

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

Construct from patch, internal field and value.

Definition at line 56 of file fvPatchField.C.

◆ fvPatchField() [3/8]

fvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const word patchType 
)

Construct from patch and internal field and patch type.

Definition at line 74 of file fvPatchField.C.

◆ fvPatchField() [4/8]

fvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const Field< Type > &  f 
)

Construct from patch and internal field and patch field.

Definition at line 92 of file fvPatchField.C.

◆ fvPatchField() [5/8]

fvPatchField ( 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 110 of file fvPatchField.C.

◆ fvPatchField() [6/8]

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

Construct by mapping the given fvPatchField onto a new patch.

Definition at line 146 of file fvPatchField.C.

◆ fvPatchField() [7/8]

fvPatchField ( const fvPatchField< Type > &  ptf)

Construct as copy.

Definition at line 172 of file fvPatchField.C.

◆ fvPatchField() [8/8]

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

Construct as copy setting internal field reference.

Definition at line 188 of file fvPatchField.C.

◆ ~fvPatchField()

virtual ~fvPatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "fvPatchField< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable ( tmp  ,
fvPatchField< Type >  ,
patch  ,
(const fvPatch &p, const DimensionedField< Type, volMesh > &iF)  ,
(p, iF)   
)

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable ( tmp  ,
fvPatchField< Type >  ,
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() [3/3]

declareRunTimeSelectionTable ( tmp  ,
fvPatchField< Type >  ,
dictionary  ,
(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict ,
(p, iF, dict  
)

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented in coupledFvPatchField< scalar >, coupledFvPatchField< vector >, coupledFvPatchField< Type >, transformFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, velocityFilmShellFvPatchVectorField, swirlFanVelocityFvPatchField, fanFvPatchField< Type >, codedMixedFvPatchField< Type >, turbulentInletFvPatchField< Type >, codedFixedValueFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, externalCoupledTemperatureMixedFvPatchScalarField, kLowReWallFunctionFvPatchScalarField, outletMappedUniformInletFvPatchField< Type >, prghPermeableAlphaTotalPressureFvPatchScalarField, fixedProfileFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, atmEpsilonWallFunctionFvPatchScalarField, atmOmegaWallFunctionFvPatchScalarField, advectiveFvPatchField< Type >, mappedFieldFvPatchField< Type >, mixedFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, mappedMixedFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, fixedJumpFvPatchField< vector >, mappedFixedValueFvPatchField< Type >, freestreamFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedGradientFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, exprMixedFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, inletOutletFvPatchField< Type >, outletInletFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, acousticWaveTransmissiveFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, mappedFixedInternalValueFvPatchField< Type >, fixedMeanOutletInletFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, thermalShellFvPatchScalarField, exprFixedValueFvPatchField< Type >, processorFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, cyclicACMIFvPatchField< Type >, fixedMeanFvPatchField< Type >, vibrationShellFvPatchScalarField, fixedValueFvPatchField< Type >, cyclicFvPatchField< Type >, fixedValueFvPatchField< scalar >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorCyclicFvPatchField< Type >, externalCoupledMixedFvPatchField< Type >, externalCoupledMixedFvPatchField< scalar >, fixedInternalValueFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, slicedFvPatchField< Type >, cyclicSlipFvPatchField< Type >, wedgeFvPatchField< Type >, calculatedFvPatchField< Type >, emptyFvPatchField< Type >, symmetryFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, extrapolatedCalculatedFvPatchField< Type >, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, zeroGradientFvPatchField< Type >, slipFvPatchField< Type >, oversetFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, directionMixedFvPatchField< Type >, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, genericFvPatchField< Type >, cellMotionFvPatchField< Type >, basicSymmetryFvPatchField< Type >, and adjointZeroInletFvPatchField< Type >.

Definition at line 219 of file fvPatchField.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 in velocityFilmShellFvPatchVectorField, swirlFanVelocityFvPatchField, mixedFvPatchField< vector >, fixedJumpFvPatchField< vector >, cyclicFvPatchField< vector >, coupledFvPatchField< vector >, fanFvPatchField< Type >, codedMixedFvPatchField< Type >, turbulentInletFvPatchField< Type >, codedFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, fixedProfileFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, mappedFieldFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, advectiveFvPatchField< Type >, mappedMixedFvPatchField< Type >, mixedFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, fixedJumpFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, freestreamFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedGradientFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, exprMixedFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, inletOutletFvPatchField< Type >, outletInletFvPatchField< Type >, acousticWaveTransmissiveFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, fixedMeanOutletInletFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, exprFixedValueFvPatchField< Type >, processorFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, cyclicACMIFvPatchField< Type >, fixedMeanFvPatchField< Type >, fixedValueFvPatchField< Type >, cyclicFvPatchField< Type >, calculatedProcessorFvPatchField< Type >, processorCyclicFvPatchField< Type >, externalCoupledMixedFvPatchField< Type >, fixedInternalValueFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, cyclicSlipFvPatchField< Type >, wedgeFvPatchField< Type >, calculatedFvPatchField< Type >, emptyFvPatchField< Type >, symmetryFvPatchField< Type >, extrapolatedCalculatedFvPatchField< Type >, zeroGradientFvPatchField< Type >, slicedFvPatchField< Type >, slipFvPatchField< Type >, oversetFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, directionMixedFvPatchField< Type >, genericFvPatchField< Type >, cellMotionFvPatchField< Type >, basicSymmetryFvPatchField< Type >, adjointZeroInletFvPatchField< Type >, coupledFvPatchField< Type >, transformFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, porousBafflePressureFvPatchField< Type >, externalCoupledTemperatureMixedFvPatchScalarField, kLowReWallFunctionFvPatchScalarField, prghPermeableAlphaTotalPressureFvPatchScalarField, atmEpsilonWallFunctionFvPatchScalarField, atmOmegaWallFunctionFvPatchScalarField, mixedFvPatchField< scalar >, fixedJumpFvPatchField< scalar >, cyclicAMIFvPatchField< scalar >, fixedJumpAMIFvPatchField< scalar >, thermalShellFvPatchScalarField, vibrationShellFvPatchScalarField, fixedValueFvPatchField< scalar >, cyclicFvPatchField< scalar >, externalCoupledMixedFvPatchField< scalar >, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, and coupledFvPatchField< scalar >.

Definition at line 233 of file fvPatchField.H.

◆ New() [1/4]

Foam::tmp< Foam::fvPatchField< Type > > New ( const word patchFieldType,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)
static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

Definition at line 88 of file fvPatchFieldNew.C.

Referenced by fvPatchField< vector >::clone(), emptyFvPatchField< Type >::valueBoundaryCoeffs(), and emptyFvPatchField< Type >::valueInternalCoeffs().

Here is the caller graph for this function:

◆ New() [2/4]

Foam::tmp< Foam::fvPatchField< Type > > New ( const word patchFieldType,
const word actualPatchType,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)
static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values). Allows override of constraint type

Definition at line 33 of file fvPatchFieldNew.C.

◆ New() [3/4]

Foam::tmp< Foam::fvPatchField< Type > > New ( const fvPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper pfMapper 
)
static

Return a pointer to a new patchField created on freestore from.

a given fvPatchField mapped onto a new patch

Definition at line 155 of file fvPatchFieldNew.C.

◆ New() [4/4]

Foam::tmp< Foam::fvPatchField< Type > > New ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary dict 
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 100 of file fvPatchFieldNew.C.

◆ NewCalculatedType() [1/3]

Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType ( const fvPatch p)
static

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

Definition at line 104 of file calculatedFvPatchField.C.

◆ NewCalculatedType() [2/3]

static tmp<fvPatchField<Type> > NewCalculatedType ( const fvPatchField< Type2 > &  )
static

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

◆ useImplicit() [1/2]

bool useImplicit ( ) const
inlinenoexcept

Use implicit formulation for coupled patches only.

Definition at line 309 of file fvPatchField.H.

Referenced by lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

◆ useImplicit() [2/2]

bool useImplicit ( bool  on)
inlinenoexcept

Set useImplicit on/off.

Returns
old value

Definition at line 316 of file fvPatchField.H.

◆ calculatedType()

const Foam::word & calculatedType ( )
static

Return the type of the calculated for of fvPatchField.

Definition at line 35 of file calculatedFvPatchField.C.

◆ 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 in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, cyclicACMIFvPatchField< Type >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, calculatedFvPatchField< Type >, slicedFvPatchField< Type >, and directionMixedFvPatchField< Type >.

Definition at line 332 of file fvPatchField.H.

Referenced by Foam::adjustPhi(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), limitTemperature::correct(), Foam::MULES::limiter(), and Foam::MULES::limiterCorr().

Here is the caller graph for this function:

◆ assignable()

◆ coupled()

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 206 of file fvPatchField.C.

Referenced by basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ patch()

◆ internalField()

const DimensionedField<Type, volMesh>& internalField ( ) const
inline

Return dimensioned internal field reference.

Definition at line 363 of file fvPatchField.H.

Referenced by basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ primitiveField()

const Field<Type>& primitiveField ( ) const
inline

Return internal field reference.

Definition at line 369 of file fvPatchField.H.

◆ patchType() [1/2]

const word& patchType ( ) const
inline

Optional patch type.

Definition at line 375 of file fvPatchField.H.

Referenced by uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField().

Here is the caller graph for this function:

◆ patchType() [2/2]

word& patchType ( )
inline

Optional patch type.

Definition at line 381 of file fvPatchField.H.

◆ updated()

bool updated ( ) const
inline

Return true if the boundary condition has already been updated.

Definition at line 387 of file fvPatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const
inline

Return true if the matrix has already been manipulated.

Definition at line 393 of file fvPatchField.H.

◆ autoMap()

◆ rmap()

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

◆ snGrad() [1/2]

Foam::tmp< Foam::Field< Type > > snGrad ( ) const
virtual

Return patch-normal gradient.

Reimplemented in transformFvPatchField< Type >, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, fixedNormalSlipFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedGradientFvPatchField< Type >, directionMixedFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, wedgeFvPatchField< Type >, slicedFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, coupledFvPatchField< vector >, symmetryPlaneFvPatchField< Type >, wedgeFvPatchField< Type >, basicSymmetryFvPatchField< Type >, zeroGradientFvPatchField< Type >, basicSymmetryFvPatchField< Type >, wedgeFvPatchField< Type >, basicSymmetryFvPatchField< Type >, and symmetryPlaneFvPatchField< Type >.

Definition at line 225 of file fvPatchField.C.

Referenced by alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), atmOmegaWallFunctionFvPatchScalarField::calculate(), atmEpsilonWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), adjointSpalartAllmaras::distanceSensitivities(), thermalBaffle::info(), adjointWallVelocityFvPatchVectorField::manipulateMatrix(), snGradScheme< Type >::snGrad(), adjointOutletPressureFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), externalCoupledTemperatureMixedFvPatchScalarField::writeData(), alphatJayatillekeWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUBlendedWallFunctionFvPatchScalarField::yPlus(), and nutUSpaldingWallFunctionFvPatchScalarField::yPlus().

Here is the caller graph for this function:

◆ snGrad() [2/2]

virtual tmp<Field<Type> > snGrad ( const scalarField deltaCoeffs) const
inlinevirtual

Return patch-normal gradient for coupled-patches.

using the deltaCoeffs provided

Reimplemented in processorFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.

Definition at line 423 of file fvPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented in omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, turbulentInletFvPatchField< Type >, velocityFilmShellFvPatchVectorField, swirlFanVelocityFvPatchField, codedMixedFvPatchField< Type >, fanFvPatchField< Type >, prghPermeableAlphaTotalPressureFvPatchScalarField, codedFixedValueFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, kLowReWallFunctionFvPatchScalarField, cyclicACMIFvPatchField< Type >, advectiveFvPatchField< Type >, mappedFieldFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, mappedMixedFvPatchField< Type >, fixedProfileFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, freestreamFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, inletOutletFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, exprMixedFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, outletInletFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, fixedMeanOutletInletFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, thermalShellFvPatchScalarField, exprFixedValueFvPatchField< Type >, fixedMeanFvPatchField< Type >, vibrationShellFvPatchScalarField, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, emptyFvPatchField< Type >, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, and cellMotionFvPatchField< Type >.

Definition at line 321 of file fvPatchField.C.

Referenced by energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), waveAlphaFvPatchScalarField::updateCoeffs(), waveVelocityFvPatchVectorField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), freestreamVelocityFvPatchVectorField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), freestreamPressureFvPatchScalarField::updateCoeffs(), outletPhaseMeanVelocityFvPatchVectorField::updateCoeffs(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), swirlInletVelocityFvPatchVectorField::updateCoeffs(), cylindricalInletVelocityFvPatchVectorField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs(), SRFFreestreamVelocityFvPatchVectorField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), pressurePIDControlInletVelocityFvPatchVectorField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), and omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs().

Here is the caller graph for this function:

◆ updateWeightedCoeffs()

void updateWeightedCoeffs ( const scalarField weights)
virtual

Update the coefficients associated with the patch field.

with a weight field (0..1). This weight field is usually provided as the amount of geometric overlap for 'duplicate' patches. Sets Updated to true

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 328 of file fvPatchField.C.

◆ patchInternalField() [1/2]

Foam::tmp< Foam::Field< Type > > patchInternalField ( ) const
virtual

Return internal field next to patch as patch field.

Reimplemented in slicedFvPatchField< Type >.

Definition at line 233 of file fvPatchField.C.

Referenced by isoSurfacePoint::adaptPatchFields(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), adjointSpalartAllmaras::distanceSensitivities(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), adjointWallVelocityFvPatchVectorField::manipulateMatrix(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), dynamicAlphaContactAngleFvPatchScalarField::theta(), adjointWallVelocityFvPatchVectorField::updateCoeffs(), adjointFarFieldPressureFvPatchScalarField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), regionSizeDistribution::write(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), and wallLubricationModel::zeroGradWalls().

Here is the caller graph for this function:

◆ patchInternalField() [2/2]

void patchInternalField ( Field< Type > &  pif) const
virtual

Return internal field next to patch as patch field.

Reimplemented in slicedFvPatchField< Type >.

Definition at line 240 of file fvPatchField.C.

◆ patchNeighbourField()

◆ initEvaluate()

virtual void initEvaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
inlinevirtual

Initialise the evaluation of the patch field.

Reimplemented in slicedFvPatchField< Type >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, coupledFvPatchField< vector >, and oversetFvPatchField< Type >.

Definition at line 456 of file fvPatchField.H.

Referenced by Foam::evaluateConstraintTypes().

Here is the caller graph for this function:

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
virtual

◆ valueInternalCoeffs()

virtual tmp<Field<Type> > valueInternalCoeffs ( const tmp< Field< scalar >> &  ) const
inlinevirtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 473 of file fvPatchField.H.

Referenced by gaussConvectionScheme< Type >::fvmDiv().

Here is the caller graph for this function:

◆ valueBoundaryCoeffs()

virtual tmp<Field<Type> > valueBoundaryCoeffs ( const tmp< Field< scalar >> &  ) const
inlinevirtual

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 484 of file fvPatchField.H.

Referenced by gaussConvectionScheme< Type >::fvmDiv().

Here is the caller graph for this function:

◆ gradientInternalCoeffs() [1/2]

◆ gradientInternalCoeffs() [2/2]

virtual tmp<Field<Type> > gradientInternalCoeffs ( const scalarField deltaCoeffs) const
inlinevirtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this coupled patchField using the deltaCoeffs provided

Reimplemented in coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.

Definition at line 504 of file fvPatchField.H.

◆ gradientBoundaryCoeffs() [1/2]

virtual tmp<Field<Type> > gradientBoundaryCoeffs ( ) const
inlinevirtual

◆ gradientBoundaryCoeffs() [2/2]

virtual tmp<Field<Type> > gradientBoundaryCoeffs ( const scalarField deltaCoeffs) const
inlinevirtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this coupled patchField using the deltaCoeffs provided

Reimplemented in coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.

Definition at line 524 of file fvPatchField.H.

◆ manipulateMatrix() [1/3]

void manipulateMatrix ( fvMatrix< Type > &  matrix)
virtual

Manipulate matrix.

Reimplemented in cyclicACMIFvPatchField< Type >, fixedInternalValueFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 354 of file fvPatchField.C.

Referenced by epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), and omegaWallFunctionFvPatchScalarField::manipulateMatrix().

Here is the caller graph for this function:

◆ manipulateMatrix() [2/3]

void manipulateMatrix ( fvMatrix< Type > &  matrix,
const scalarField weights 
)
virtual

Manipulate matrix with given weights.

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 362 of file fvPatchField.C.

◆ manipulateMatrix() [3/3]

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

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented in swirlFanVelocityFvPatchField, cyclicACMIFvPatchField< Type >, fanFvPatchField< Type >, externalCoupledTemperatureMixedFvPatchScalarField, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, uniformFixedValueFvPatchField< Type >, exprMixedFvPatchField< Type >, uniformJumpFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, exprFixedValueFvPatchField< Type >, oversetFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, turbulentInletFvPatchField< Type >, velocityFilmShellFvPatchVectorField, codedMixedFvPatchField< Type >, prghPermeableAlphaTotalPressureFvPatchScalarField, codedFixedValueFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, kLowReWallFunctionFvPatchScalarField, fixedNormalSlipFvPatchField< Type >, fixedGradientFvPatchField< Type >, partialSlipFvPatchField< Type >, advectiveFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, fixedJumpFvPatchField< vector >, atmEpsilonWallFunctionFvPatchScalarField, atmOmegaWallFunctionFvPatchScalarField, mappedFieldFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, mappedMixedFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, coupledFvPatchField< vector >, fixedProfileFvPatchField< Type >, freestreamFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, directionMixedFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, slicedFvPatchField< Type >, scaledFixedValueFvPatchField< Type >, fixedValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, inletOutletFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, acousticWaveTransmissiveFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, outletInletFvPatchField< Type >, fixedMeanOutletInletFvPatchField< Type >, thermalShellFvPatchScalarField, calculatedFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, fixedMeanFvPatchField< Type >, vibrationShellFvPatchScalarField, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, genericFvPatchField< Type >, and cellMotionFvPatchField< Type >.

Definition at line 384 of file fvPatchField.C.

Referenced by surfaceSlipDisplacementFvPatchField< Type >::write(), interstitialInletVelocityFvPatchVectorField::write(), waveAlphaFvPatchScalarField::write(), waveVelocityFvPatchVectorField::write(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::write(), nutkFilmWallFunctionFvPatchScalarField::write(), copiedFixedValueFvPatchScalarField::write(), acousticWaveTransmissiveFvPatchField< Type >::write(), mappedFlowRateFvPatchVectorField::write(), nutUWallFunctionFvPatchScalarField::write(), matchedFlowRateOutletVelocityFvPatchVectorField::write(), outletPhaseMeanVelocityFvPatchVectorField::write(), alphatWallFunctionFvPatchScalarField::write(), fixedPressureCompressibleDensityFvPatchScalarField::write(), nutUTabulatedWallFunctionFvPatchScalarField::write(), swirlInletVelocityFvPatchVectorField::write(), cylindricalInletVelocityFvPatchVectorField::write(), convectiveHeatTransferFvPatchScalarField::write(), alphatPhaseChangeWallFunctionFvPatchScalarField::write(), alphatFilmWallFunctionFvPatchScalarField::write(), swirlFlowRateInletVelocityFvPatchVectorField::write(), fixedMultiPhaseHeatFluxFvPatchScalarField::write(), alphatJayatillekeWallFunctionFvPatchScalarField::write(), flowRateOutletVelocityFvPatchVectorField::write(), nutkRoughWallFunctionFvPatchScalarField::write(), waveTransmissiveFvPatchField< Type >::write(), nutUBlendedWallFunctionFvPatchScalarField::write(), flowRateInletVelocityFvPatchVectorField::write(), advectiveFvPatchField< Type >::write(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::write(), atmNutUWallFunctionFvPatchScalarField::write(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::write(), nutUSpaldingWallFunctionFvPatchScalarField::write(), atmAlphatkWallFunctionFvPatchScalarField::write(), atmNutkWallFunctionFvPatchScalarField::write(), nutURoughWallFunctionFvPatchScalarField::write(), atmNutWallFunctionFvPatchScalarField::write(), pressurePIDControlInletVelocityFvPatchVectorField::write(), nutWallFunctionFvPatchScalarField::write(), turbulentDFSEMInletFvPatchVectorField::write(), and alphatWallBoilingWallFunctionFvPatchScalarField::write().

Here is the caller graph for this function:

◆ check()

void check ( const fvPatchField< Type > &  ptf) const

Check fvPatchField<Type> against given fvPatchField<Type>

Definition at line 213 of file fvPatchField.C.

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

◆ operator==() [1/3]

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

Reimplemented in scaledFixedValueFvPatchField< Type >.

Definition at line 570 of file fvPatchField.C.

Referenced by zeroGradientFvPatchField< Type >::evaluate().

Here is the caller graph for this function:

◆ operator==() [2/3]

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

Reimplemented in scaledFixedValueFvPatchField< Type >.

Definition at line 580 of file fvPatchField.C.

◆ operator==() [3/3]

void operator== ( const Type &  t)
virtual

Reimplemented in scaledFixedValueFvPatchField< Type >.

Definition at line 590 of file fvPatchField.C.

◆ NewCalculatedType() [3/3]

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

Definition at line 135 of file calculatedFvPatchField.C.

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream ,
const fvPatchField< Type > &   
)
friend

Member Data Documentation

◆ disallowGenericFvPatchField

int disallowGenericFvPatchField
static

Debug switch to disallow the use of genericFvPatchField.

Definition at line 119 of file fvPatchField.H.


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