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...

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 objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () 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 word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	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	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 word &	calculatedType ()
	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
Ostream &	operator (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 50 of file volSurfaceMapping.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 115 of file fvPatchField.H.

◆ Calculated

typedef calculatedFvPatchField<Type> Calculated

Definition at line 116 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 55 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 72 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 89 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 106 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 141 of file fvPatchField.C.

◆ fvPatchField() [7/8]

fvPatchField ( const fvPatchField< Type > & ptf )

Construct as copy.

Definition at line 166 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 181 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.

Definition at line 223 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.

Definition at line 237 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 156 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 103 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

◆ calculatedType()

const Foam::word & calculatedType ( )

static

Return the type of the calculated for of fvPatchField.

Definition at line 34 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 >, cyclicACMIFvPatchField< Type >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, calculatedFvPatchField< Type >, slicedFvPatchField< Type >, and directionMixedFvPatchField< Type >.

Definition at line 318 of file fvPatchField.H.

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

Here is the caller graph for this function:

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

Return true if the value of the patch field.

is altered by assignment (the default)

Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, uniformInletOutletFvPatchField< Type >, inletOutletFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, fixedNormalSlipFvPatchField< Type >, slicedFvPatchField< Type >, directionMixedFvPatchField< Type >, slipFvPatchField< Type >, and transformFvPatchField< Type >.

Definition at line 325 of file fvPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

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

Definition at line 331 of file fvPatchField.H.

Referenced by fvMatrix< Type >::addBoundarySource(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), directionalPressureGradientExplicitSource::correct(), fvMatrix< Type >::DD(), blackBodyEmission::EbDeltaLambdaT(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvMatrix< Type >::H1(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), fvMatrix< Type >::relax(), snGradScheme< Type >::snGrad(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 198 of file fvPatchField.C.

Referenced by basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ patch()

const fvPatch& patch ( ) const

inline

Return patch.

Definition at line 343 of file fvPatchField.H.

Referenced by fieldExtents::calcFieldExtents(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), ReynoldsAnalogy::Cf(), extendedCellToFaceStencil::collectData(), reconstructedDistanceFunction::constructRDF(), contactAngleForce::correct(), Foam::evaluateConstraintTypes(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvPatchField< vector >::NewCalculatedType(), fvPatchField< vector >::operator*=(), fvPatchField< vector >::operator/=(), Foam::oversetAdjustPhi(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ internalField()

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

inline

Return dimensioned internal field reference.

Definition at line 349 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 355 of file fvPatchField.H.

◆ patchType() [1/2]

const word& patchType ( ) const

inline

Optional patch type.

Definition at line 361 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 367 of file fvPatchField.H.

◆ updated()

bool updated ( ) const

inline

Return true if the boundary condition has already been updated.

Definition at line 373 of file fvPatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inline

Return true if the matrix has already been manipulated.

Definition at line 379 of file fvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & mapper )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 240 of file fvPatchField.C.

Referenced by turbulentDFSEMInletFvPatchVectorField::autoMap(), and turbulentDigitalFilterInletFvPatchVectorField::autoMap().

Here is the caller graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 303 of file fvPatchField.C.

Referenced by meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), turbulentDFSEMInletFvPatchVectorField::rmap(), and turbulentDigitalFilterInletFvPatchVectorField::rmap().

Here is the caller graph for this function:

◆ snGrad() [1/2]

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

virtual

Return patch-normal gradient.

Definition at line 217 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(), 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 409 of file fvPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Sets Updated to true

Definition at line 313 of file fvPatchField.C.

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 320 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 225 of file fvPatchField.C.

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

◆ patchNeighbourField()

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

inlinevirtual

Return patchField on the opposite patch of a coupled patch.

Definition at line 434 of file fvPatchField.H.

Referenced by isoSurfacePoint::adaptPatchFields(), fvMatrix< Type >::addBoundarySource(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), directionalPressureGradientExplicitSource::correct(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), and regionSizeDistribution::write().

Here is the caller graph for this function:

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

Evaluate the patch field, sets Updated to false.

Definition at line 333 of file fvPatchField.C.

Referenced by zeroGradientFvPatchField< Type >::evaluate(), Foam::evaluateConstraintTypes(), 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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 459 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 470 of file fvPatchField.H.

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

Here is the caller graph for this function:

◆ 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

Definition at line 480 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 coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.

Definition at line 490 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< Type >, mixedFvPatchField< scalar >, fixedGradientFvPatchField< Type >, slicedFvPatchField< Type >, coupledFvPatchField< Type >, fixedValueFvPatchField< Type >, coupledFvPatchField< scalar >, coupledFvPatchField< vector >, fixedValueFvPatchField< scalar >, emptyFvPatchField< Type >, genericFvPatchField< Type >, zeroGradientFvPatchField< Type >, calculatedFvPatchField< Type >, and transformFvPatchField< Type >.

Definition at line 500 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 coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.

Definition at line 510 of file fvPatchField.H.

◆ manipulateMatrix() [1/2]

void manipulateMatrix ( fvMatrix< Type > & matrix )

virtual

Manipulate matrix.

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

Definition at line 346 of file fvPatchField.C.

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

Here is the caller graph for this function:

◆ manipulateMatrix() [2/2]

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

virtual

Manipulate matrix with given weights.

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 354 of file fvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 364 of file fvPatchField.C.

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

◆ operator=() [1/3]

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

virtual

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

Definition at line 379 of file fvPatchField.C.

Here is the caller graph for this function:

◆ operator=() [2/3]

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

virtual

Reimplemented in uniformInletOutletFvPatchField< Type >, inletOutletFvPatchField< Type >, mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, transformFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 389 of file fvPatchField.C.

◆ operator+=() [1/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 400 of file fvPatchField.C.

◆ operator-=() [1/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 411 of file fvPatchField.C.

◆ operator*=() [1/3]

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

virtual

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

Definition at line 422 of file fvPatchField.C.

◆ operator/=() [1/3]

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

virtual

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

Definition at line 439 of file fvPatchField.C.

◆ operator+=() [2/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 455 of file fvPatchField.C.

◆ operator-=() [2/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 465 of file fvPatchField.C.

◆ operator*=() [2/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, and fixedValueFvPatchField< scalar >.

Definition at line 475 of file fvPatchField.C.

◆ operator/=() [2/3]

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

virtual

Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, and fixedValueFvPatchField< scalar >.

Definition at line 485 of file fvPatchField.C.

◆ operator=() [3/3]

void operator= ( const Type & t )

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 495 of file fvPatchField.C.

◆ operator+=() [3/3]

void operator+= ( const Type & t )

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 505 of file fvPatchField.C.

◆ operator-=() [3/3]

void operator-= ( const Type & t )

virtual

Reimplemented in mixedFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, mixedFvPatchField< scalar >, and fixedValueFvPatchField< scalar >.

Definition at line 515 of file fvPatchField.C.

◆ operator*=() [3/3]

void operator*= ( const scalar s )

virtual

Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, and fixedValueFvPatchField< scalar >.

Definition at line 525 of file fvPatchField.C.

◆ operator/=() [3/3]

void operator/= ( const scalar s )

virtual

Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, partialSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, fixedValueFvPatchField< Type >, and fixedValueFvPatchField< scalar >.

Definition at line 535 of file fvPatchField.C.

◆ operator==() [1/3]

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

virtual

Reimplemented in scaledFixedValueFvPatchField< Type >.

Definition at line 545 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 555 of file fvPatchField.C.

◆ operator==() [3/3]

void operator== ( const Type & t )

virtual

Reimplemented in scaledFixedValueFvPatchField< Type >.

Definition at line 565 of file fvPatchField.C.

◆ NewCalculatedType() [3/3]

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

Definition at line 134 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 123 of file fvPatchField.H.

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

src/finiteArea/interpolation/volSurfaceMapping/volSurfaceMapping.H
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.C
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.C
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldNew.C
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFields.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

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

Member Typedef Documentation

◆ Patch

◆ Calculated

Constructor & Destructor Documentation

◆ fvPatchField() [1/8]

◆ fvPatchField() [2/8]

◆ fvPatchField() [3/8]

◆ fvPatchField() [4/8]

◆ fvPatchField() [5/8]

◆ fvPatchField() [6/8]

◆ fvPatchField() [7/8]

◆ fvPatchField() [8/8]

◆ ~fvPatchField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ NewCalculatedType() [1/3]

◆ NewCalculatedType() [2/3]

◆ calculatedType()

◆ fixesValue()

◆ assignable()

◆ coupled()

◆ db()

◆ patch()

◆ internalField()

◆ primitiveField()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ updated()

◆ manipulatedMatrix()

◆ autoMap()

◆ rmap()

◆ snGrad() [1/2]

◆ snGrad() [2/2]

◆ updateCoeffs()

◆ updateWeightedCoeffs()

◆ patchInternalField() [1/2]

◆ patchInternalField() [2/2]

◆ patchNeighbourField()

◆ initEvaluate()

◆ evaluate()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs() [1/2]

◆ gradientInternalCoeffs() [2/2]

◆ gradientBoundaryCoeffs() [1/2]

◆ gradientBoundaryCoeffs() [2/2]

◆ manipulateMatrix() [1/2]

◆ manipulateMatrix() [2/2]

◆ write()

◆ check()

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

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