Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Friends
fvPatchField Class 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:
Inheritance graph
[legend]
Collaboration diagram for fvPatchField:
Collaboration graph
[legend]

Public Types

typedef fvPatch Patch
 

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 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...
 
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 ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () 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 wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 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 > > 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 write (Ostream &) const
 Write. More...
 
template<class EntryType >
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 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 Type >
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
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...
 

Private Attributes

const fvPatchpatch_
 Reference to patch. More...
 
const DimensionedField< Type, volMesh > & internalField_
 Reference to internal field. More...
 
bool updated_
 Update index used so that updateCoeffs is called only once during. More...
 
bool manipulatedMatrix_
 Update index used so that manipulateMatrix is called only once. More...
 
word patchType_
 Optional patch type, used to allow specified boundary conditions. More...
 

Friends

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

Detailed Description

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 proceedures, particularly with respect to specific fields.

Source files

Definition at line 65 of file fvPatchField.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 107 of file fvPatchField.H.

Constructor & Destructor Documentation

◆ fvPatchField() [1/7]

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

Construct from patch and internal field.

◆ fvPatchField() [2/7]

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

Construct from patch and internal field and patch type.

◆ fvPatchField() [3/7]

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

Construct from patch and internal field and patch field.

◆ fvPatchField() [4/7]

fvPatchField ( const fvPatch ,
const DimensionedField< Type, volMesh > &  ,
const dictionary ,
const bool  valueRequired = false 
)

Construct from patch, internal field and dictionary.

◆ fvPatchField() [5/7]

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

Construct by mapping the given fvPatchField onto a new patch.

◆ fvPatchField() [6/7]

fvPatchField ( const fvPatchField< Type > &  )

Construct as copy.

◆ fvPatchField() [7/7]

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

Construct as copy setting internal field reference.

◆ ~fvPatchField()

virtual ~fvPatchField ( )
inlinevirtual

Destructor.

Definition at line 288 of file fvPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "fvPatchField"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

◆ declareRunTimeSelectionTable() [2/3]

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() [3/3]

declareRunTimeSelectionTable ( tmp  ,
fvPatchField  ,
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

◆ 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 oscillatingFixedValueFvPatchField< Type >, timeVaryingMappedFixedValueFvPatchField< Type >, codedMixedFvPatchField< Type >, immersedBoundaryFvPatchField< Type >, turbulentInletFvPatchField< Type >, fixedProfileFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, codedFixedValueFvPatchField< Type >, fanFvPatchField< Type >, mappedFieldFvPatchField< Type >, mixedFvPatchField< Type >, advectiveFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, fixedGradientFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, inletOutletFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, outletInletFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, outletInletFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, fixedJumpFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, myMappedFixedInternalValueFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, processorFvPatchField< Type >, coupledFreestreamFvPatchField< Type >, fixedMeanFvPatchField< Type >, freestreamFvPatchField< Type >, immersedBoundaryWallFunctionFvPatchField< Type >, partialSlipFvPatchField< Type >, cyclicAMIFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, cyclicFvPatchField< Type >, coupledFixedValueFvPatchField< Type >, cyclicACMIFvPatchField< Type >, fixedValueFvPatchField< Type >, processorCyclicFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, fixedInternalValueFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, externalCoupledMixedFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, cyclicSlipFvPatchField< Type >, wedgeFvPatchField< Type >, calculatedFvPatchField< Type >, emptyFvPatchField< Type >, symmetryFvPatchField< Type >, genericFvPatchField< Type >, zeroGradientFvPatchField< Type >, slipFvPatchField< Type >, slicedFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, cellMotionFvPatchField< Type >, basicSymmetryFvPatchField< Type >, coupledFvPatchField< Type >, and transformFvPatchField< Type >.

Definition at line 220 of file fvPatchField.H.

◆ New() [1/4]

static tmp<fvPatchField<Type> > New ( const word ,
const fvPatch ,
const DimensionedField< Type, volMesh > &   
)
static

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

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

◆ New() [2/4]

static tmp<fvPatchField<Type> > New ( const word ,
const word actualPatchType,
const fvPatch ,
const DimensionedField< Type, volMesh > &   
)
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

◆ New() [3/4]

static tmp<fvPatchField<Type> > New ( const fvPatchField< Type > &  ,
const fvPatch ,
const DimensionedField< Type, volMesh > &  ,
const fvPatchFieldMapper  
)
static

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

a given fvPatchField mapped onto a new patch

◆ New() [4/4]

static tmp<fvPatchField<Type> > New ( const fvPatch ,
const DimensionedField< Type, volMesh > &  ,
const dictionary  
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

◆ NewCalculatedType() [1/4]

static tmp<fvPatchField<Type> > NewCalculatedType ( const fvPatch )
static

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

◆ NewCalculatedType() [2/4]

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

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 181 of file fvPatchField.C.

Referenced by basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ patch()

const fvPatch& patch ( ) const
inline

◆ dimensionedInternalField()

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

Return dimensioned internal field reference.

Definition at line 307 of file fvPatchField.H.

Referenced by basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ internalField()

const Field<Type>& internalField ( ) const
inline

Return internal field reference.

Definition at line 313 of file fvPatchField.H.

Referenced by coupledFixedValueFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

◆ patchType() [1/2]

const word& patchType ( ) const
inline

Optional patch type.

Definition at line 319 of file fvPatchField.H.

◆ patchType() [2/2]

word& patchType ( )
inline

Optional patch type.

Definition at line 325 of file fvPatchField.H.

◆ calculatedType()

const Foam::word & calculatedType ( )
static

Return the type of the calculated for of fvPatchField.

Definition at line 32 of file calculatedFvPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

◆ updated()

bool updated ( ) const
inline

Return true if the boundary condition has already been updated.

Definition at line 348 of file fvPatchField.H.

Referenced by cyclicACMIFvPatchField< Type >::initEvaluate().

Here is the caller graph for this function:

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const
inline

Return true if the matrix has already been manipulated.

Definition at line 354 of file fvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper mapper)
virtual

◆ rmap()

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

◆ snGrad() [1/2]

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

◆ 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 cyclicACMIFvPatchField< Type >, energyRegionCoupledFvPatchScalarField, processorFvPatchField< Type >, coupledFvPatchField< Type >, and coupledFvPatchField< scalar >.

Definition at line 384 of file fvPatchField.H.

◆ updateCoeffs() [1/2]

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented in immersedBoundaryFvPatchField< Type >, oscillatingFixedValueFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, timeVaryingMappedFixedValueFvPatchField< Type >, turbulentInletFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, advectiveFvPatchField< Type >, codedMixedFvPatchField< Type >, cyclicACMIFvPatchField< Type >, fixedProfileFvPatchField< Type >, codedFixedValueFvPatchField< Type >, mappedFieldFvPatchField< Type >, fanFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, kLowReWallFunctionFvPatchScalarField, v2WallFunctionFvPatchScalarField, fWallFunctionFvPatchScalarField, uniformInletOutletFvPatchField< Type >, coupledFixedValueFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, inletOutletFvPatchField< Type >, outletInletFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, outletInletFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, myMappedFixedInternalValueFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, fixedMeanFvPatchField< Type >, coupledFreestreamFvPatchField< Type >, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, emptyFvPatchField< Type >, slicedFvPatchField< Type >, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, and cellMotionFvPatchField< Type >.

Definition at line 296 of file fvPatchField.C.

Referenced by surfaceNormalFixedValueFvPatchVectorField::updateCoeffs(), coupledFixedValueFvPatchField< Type >::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), and immersedBoundaryFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

◆ updateCoeffs() [2/2]

void updateCoeffs ( const scalarField weights)
virtual

Update the coefficients associated with the patch field.

and apply weight field Sets Updated to true

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 303 of file fvPatchField.C.

◆ patchInternalField() [1/2]

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

◆ patchInternalField() [2/2]

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

Return internal field next to patch as patch field.

Reimplemented in slicedFvPatchField< Type >.

◆ patchNeighbourField()

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

◆ initEvaluate()

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

◆ evaluate()

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

Evaluate the patch field, sets Updated to false.

Reimplemented in kLowReWallFunctionFvPatchScalarField, v2WallFunctionFvPatchScalarField, fWallFunctionFvPatchScalarField, wedgeFvPatchField< Type >, basicSymmetryFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, immersedBoundaryFvPatchField< Type >, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, codedMixedFvPatchField< Type >, codedFixedValueFvPatchField< Type >, fixedGradientFvPatchField< Type >, directionMixedFvPatchField< Type >, coupledFixedValueFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, slicedFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, zeroGradientFvPatchField< Type >, wedgeFvPatchField< Type >, basicSymmetryFvPatchField< Type >, cyclicACMIFvPatchField< Type >, energyRegionCoupledFvPatchScalarField, processorFvPatchField< Type >, symmetryPlaneFvPatchField< Type >, wedgeFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and basicSymmetryFvPatchField< Type >.

Definition at line 318 of file fvPatchField.C.

Referenced by zeroGradientFvPatchField< Type >::evaluate(), immersedBoundaryEpsilonWallFunctionFvPatchScalarField::evaluate(), immersedBoundaryOmegaWallFunctionFvPatchScalarField::evaluate(), coupledFixedValueFvPatchField< Type >::evaluate(), energyRegionCoupledFvPatchScalarField::evaluate(), fixedGradientFvPatchField< Type >::evaluate(), mixedFvPatchField< scalar >::evaluate(), immersedBoundaryFvPatchField< Type >::evaluate(), cyclicACMIFvPatchField< Type >::initEvaluate(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedEnergyFvPatchScalarField::updateCoeffs(), and gradientEnergyFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ valueInternalCoeffs()

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

◆ valueBoundaryCoeffs()

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

◆ gradientInternalCoeffs() [1/2]

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented in mixedFvPatchField< scalar >, coupledFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 452 of file fvPatchField.H.

Referenced by gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected().

Here is the caller graph for this function:

◆ 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 cyclicACMIFvPatchField< Type >, coupledFvPatchField< Type >, and coupledFvPatchField< scalar >.

Definition at line 462 of file fvPatchField.H.

◆ gradientBoundaryCoeffs() [1/2]

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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented in mixedFvPatchField< scalar >, coupledFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 472 of file fvPatchField.H.

Referenced by gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected().

Here is the caller graph for this function:

◆ 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 cyclicACMIFvPatchField< Type >, coupledFvPatchField< Type >, and coupledFvPatchField< scalar >.

Definition at line 482 of file fvPatchField.H.

◆ manipulateMatrix() [1/2]

void manipulateMatrix ( fvMatrix< Type > &  matrix)
virtual

◆ manipulateMatrix() [2/2]

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

Manipulate matrix with given weights.

Definition at line 339 of file fvPatchField.C.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented in cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, surfaceSlipDisplacementFvPatchField< Type >, immersedBoundaryFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, oscillatingFixedValueFvPatchField< Type >, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, epsilonWallFunctionFvPatchScalarField, timeVaryingMappedFixedValueFvPatchField< Type >, turbulentInletFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, fixedGradientFvPatchField< Type >, advectiveFvPatchField< Type >, codedMixedFvPatchField< Type >, energyRegionCoupledFvPatchScalarField, waveTransmissiveFvPatchField< Type >, codedFixedValueFvPatchField< Type >, fixedProfileFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, mappedFieldFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, kLowReWallFunctionFvPatchScalarField, v2WallFunctionFvPatchScalarField, fWallFunctionFvPatchScalarField, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, coupledFixedValueFvPatchField< Type >, fixedJumpFvPatchField< Type >, fixedJumpFvPatchField< scalar >, fixedJumpAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< scalar >, mappedFixedPushedInternalValueFvPatchField< Type >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, outletMappedUniformInletFvPatchField< Type >, inletOutletFvPatchField< Type >, outletInletFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, outletInletFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, mappedFixedInternalValueFvPatchField< Type >, myMappedFixedInternalValueFvPatchField< Type >, coupledFreestreamFvPatchField< Type >, genericFvPatchField< Type >, uniformFixedGradientFvPatchField< Type >, freestreamFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, calculatedFvPatchField< Type >, fixedMeanFvPatchField< Type >, totalFlowRateAdvectiveDiffusiveFvPatchScalarField, kqRWallFunctionFvPatchField< Type >, energyJumpFvPatchScalarField, energyJumpAMIFvPatchScalarField, and cellMotionFvPatchField< Type >.

Definition at line 349 of file fvPatchField.C.

Referenced by wallHeatFluxFvPatchScalarField::write(), alphatPhaseChangeWallFunctionFvPatchScalarField::write(), inclinedFilmNusseltInletVelocityFvPatchVectorField::write(), improvedNoSlipFvPatchVectorField::write(), mappedInternalCoupled::write(), nutUWallFunctionFvPatchScalarField::write(), atmBoundaryLayerInletEpsilonFvPatchScalarField::write(), atmBoundaryLayerInletKFvPatchScalarField::write(), atmBoundaryLayerInletVelocityFvPatchVectorField::write(), interstitialInletVelocityFvPatchVectorField::write(), alphaFixedPressureFvPatchScalarField::write(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::write(), movingWallVelocityFvPatchVectorField::write(), translatingWallVelocityFvPatchVectorField::write(), nutkFilmWallFunctionFvPatchScalarField::write(), freestreamFvPatchField< Type >::write(), mappedVelocityFluxFixedValueFvPatchField::write(), coupledFreestreamFvPatchField< Type >::write(), nutUSpaldingWallFunctionFvPatchScalarField::write(), filmPyrolysisVelocityCoupledFvPatchVectorField::write(), filmPyrolysisTemperatureCoupledFvPatchScalarField::write(), pressureInletVelocityFvPatchVectorField::write(), ibSwirlFlowRateInletVelocityFvPatchVectorField::write(), mappedFlowRateFvPatchVectorField::write(), fixedValueFvPatchField< scalar >::write(), nutUTabulatedWallFunctionFvPatchScalarField::write(), surfaceNormalFixedValueFvPatchVectorField::write(), variableHeightFlowRateFvPatchScalarField::write(), outletPhaseMeanVelocityFvPatchVectorField::write(), nutWallFunctionFvPatchScalarField::write(), rotatingPressureInletOutletVelocityFvPatchVectorField::write(), coupledFixedValueFvPatchField< Type >::write(), slicedFvPatchField< Type >::write(), alphatWallFunctionFvPatchScalarField::write(), fixedPressureCompressibleDensityFvPatchScalarField::write(), swirlFlowRateInletVelocityFvPatchVectorField::write(), cylindricalInletVelocityFvPatchVectorField::write(), convectiveHeatTransferFvPatchScalarField::write(), fluxCorrectedVelocityFvPatchVectorField::write(), turbulentIntensityKineticEnergyInletFvPatchScalarField::write(), mappedFixedValueFvPatchField< Type >::write(), rotatingWallVelocityFvPatchVectorField::write(), wallHeatTransferFvPatchScalarField::write(), nutkRoughWallFunctionFvPatchScalarField::write(), pressureInletOutletParSlipVelocityFvPatchVectorField::write(), pressureNormalInletOutletVelocityFvPatchVectorField::write(), flowRateInletVelocityFvPatchVectorField::write(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::write(), alphatFilmWallFunctionFvPatchScalarField::write(), turbulentMixingLengthFrequencyInletFvPatchScalarField::write(), mappedFieldFvPatchField< Type >::write(), pressureInletOutletVelocityFvPatchVectorField::write(), cyclicFvPatchField< scalar >::write(), nutkAtmRoughWallFunctionFvPatchScalarField::write(), alphatJayatillekeWallFunctionFvPatchScalarField::write(), turbulentTemperatureRadFixedGradientFvPatchScalarField::write(), SRFFreestreamVelocityFvPatchVectorField::write(), totalTemperatureFvPatchScalarField::write(), waveSurfacePressureFvPatchScalarField::write(), pressureDirectedInletVelocityFvPatchVectorField::write(), waveTransmissiveFvPatchField< Type >::write(), nutURoughWallFunctionFvPatchScalarField::write(), inletOutletTotalTemperatureFvPatchScalarField::write(), energyRegionCoupledFvPatchScalarField::write(), pressureDirectedInletOutletVelocityFvPatchVectorField::write(), SRFVelocityFvPatchVectorField::write(), advectiveFvPatchField< Type >::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), fixedGradientFvPatchField< Type >::write(), prghPressureFvPatchScalarField::write(), uniformTotalPressureFvPatchScalarField::write(), uniformDensityHydrostaticPressureFvPatchScalarField::write(), filmHeightInletVelocityFvPatchVectorField::write(), prghTotalPressureFvPatchScalarField::write(), supersonicFreestreamFvPatchVectorField::write(), turbulentInletFvPatchField< Type >::write(), timeVaryingMappedFixedValueFvPatchField< Type >::write(), syringePressureFvPatchScalarField::write(), activeBaffleVelocityFvPatchVectorField::write(), phaseHydrostaticPressureFvPatchScalarField::write(), mixedFvPatchField< scalar >::write(), activePressureForceBaffleVelocityFvPatchVectorField::write(), immersedBoundaryFvPatchField< Type >::write(), and totalPressureFvPatchScalarField::write().

◆ writeEntryIfDifferent()

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.

values are not equal. The value is then output as value2

Definition at line 364 of file fvPatchField.C.

◆ check()

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

Check fvPatchField<Type> against given fvPatchField<Type>

Definition at line 188 of file fvPatchField.C.

◆ operator=() [1/3]

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

Reimplemented in mixedFvPatchField< Type >, slicedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, coupledFixedValueFvPatchField< Type >, fixedValueFvPatchField< Type >, and mixedFixedValueSlipFvPatchField< Type >.

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), boundaryRadiationPropertiesFvPatchField::boundaryRadiationPropertiesFvPatchField(), coupledFreestreamFvPatchField< Type >::coupledFreestreamFvPatchField(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), pressureInletVelocityFvPatchVectorField::operator=(), pressureInletOutletParSlipVelocityFvPatchVectorField::operator=(), pressureInletOutletVelocityFvPatchVectorField::operator=(), pressureDirectedInletVelocityFvPatchVectorField::operator=(), fixedNormalInletOutletVelocityFvPatchVectorField::operator=(), filmHeightInletVelocityFvPatchVectorField::operator=(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), turbulentBoundaryCoupledFvPatchScalarField::turbulentBoundaryCoupledFvPatchScalarField(), turbulentHeatFluxTemperatureFvPatchScalarField::turbulentHeatFluxTemperatureFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), turbulentTemperatureRadFixedGradientFvPatchScalarField::turbulentTemperatureRadFixedGradientFvPatchScalarField(), surfaceNormalFixedValueFvPatchVectorField::updateCoeffs(), wallHeatFluxFvPatchScalarField::wallHeatFluxFvPatchScalarField(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), and zeroGradientFvPatchField< Type >::zeroGradientFvPatchField().

Here is the caller graph for this function:

◆ operator=() [2/3]

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

◆ operator+=() [1/3]

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

◆ operator-=() [1/3]

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

◆ operator*=() [1/3]

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

◆ operator/=() [1/3]

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

◆ operator+=() [2/3]

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

◆ operator-=() [2/3]

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

◆ operator*=() [2/3]

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

◆ operator/=() [2/3]

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

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
virtual

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
virtual

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
virtual

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
virtual

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
virtual

◆ operator==() [1/3]

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

◆ operator==() [2/3]

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

◆ operator==() [3/3]

virtual void operator== ( const Type &  )
virtual

◆ NewCalculatedType() [3/4]

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

Definition at line 101 of file calculatedFvPatchField.C.

◆ NewCalculatedType() [4/4]

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

Definition at line 133 of file calculatedFvPatchField.C.

Friends And Related Function Documentation

◆ operator

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

Field Documentation

◆ patch_

const fvPatch& patch_
private

Reference to patch.

Definition at line 86 of file fvPatchField.H.

Referenced by fvPatchField< Type >::check(), and fvPatchField< Type >::patch().

◆ internalField_

const DimensionedField<Type, volMesh>& internalField_
private

Reference to internal field.

Definition at line 89 of file fvPatchField.H.

Referenced by fvPatchField< Type >::dimensionedInternalField(), and fvPatchField< Type >::internalField().

◆ updated_

bool updated_
private

Update index used so that updateCoeffs is called only once during.

the construction of the matrix

Definition at line 93 of file fvPatchField.H.

Referenced by fvPatchField< Type >::updated().

◆ manipulatedMatrix_

bool manipulatedMatrix_
private

Update index used so that manipulateMatrix is called only once.

during the construction of the matrix

Definition at line 97 of file fvPatchField.H.

Referenced by fvPatchField< Type >::manipulatedMatrix().

◆ patchType_

word patchType_
private

Optional patch type, used to allow specified boundary conditions.

to be applied to constraint patches by providing the constraint patch type as 'patchType'

Definition at line 102 of file fvPatchField.H.

Referenced by fvPatchField< Type >::patchType().

◆ disallowGenericFvPatchField

int disallowGenericFvPatchField
static

Debug switch to disallow the use of genericFvPatchField.

Definition at line 114 of file fvPatchField.H.


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