Template invariant parts for fvPatchField. More...

Inheritance diagram for fvPatchFieldBase:

Public Member Functions
void	setUpdated (bool state) noexcept
	Set updated state. More...

void	setManipulated (bool state) noexcept
	Set matrix manipulated state. More...

	TypeName ("fvPatchField")
	Runtime type information. More...

	fvPatchFieldBase (const fvPatch &p)
	Construct from patch. More...

	fvPatchFieldBase (const fvPatch &p, const word &patchType)
	Construct from patch and patch type. More...

	fvPatchFieldBase (const fvPatch &p, const dictionary &dict)
	Construct from patch and dictionary. More...

	fvPatchFieldBase (const fvPatchFieldBase &rhs, const fvPatch &p)
	Copy construct with new patch. More...

	fvPatchFieldBase (const fvPatchFieldBase &rhs)
	Copy construct. More...

virtual	~fvPatchFieldBase ()=default
	Destructor. More...

virtual bool	assignable () const
	True if the value of the patch field is altered by assignment. More...

virtual bool	fixesValue () const
	True if the patch field fixes a value. More...

virtual bool	coupled () const
	True if the patch field is coupled. More...

const objectRegistry &	db () const
	The associated objectRegistry. More...

const fvPatch &	patch () const noexcept
	Return the patch. More...

const word &	patchType () const noexcept
	The optional patch type. More...

word &	patchType () noexcept
	The optional patch type. More...

bool	updated () const noexcept
	True if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

void	checkPatch (const fvPatchFieldBase &rhs) const
	Check that patches are identical. More...

Static Public Member Functions
static const word &	emptyType () noexcept
	The type name for `empty` patch fields. More...

static const word &	calculatedType () noexcept
	The type name for `calculated` patch fields. More...

static const word &	extrapolatedCalculatedType () noexcept
	The type name for `extrapolatedCalculated` patch fields combines `zero-gradient` and `calculated`. More...

static const word &	zeroGradientType () noexcept
	The type name for `zeroGradient` patch fields. More...

Static Public Attributes
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic fvPatchField. More...

Protected Member Functions
virtual void	readDict (const dictionary &dict)
	Read dictionary entries. More...

Detailed Description

Template invariant parts for fvPatchField.

Definition at line 77 of file fvPatchField.H.

Constructor & Destructor Documentation

◆ fvPatchFieldBase() [1/5]

fvPatchFieldBase ( const fvPatch & p )

explicit

Construct from patch.

Definition at line 39 of file fvPatchFieldBase.C.

◆ fvPatchFieldBase() [2/5]

fvPatchFieldBase	(	const fvPatch &	p,
		const word &	patchType
	)

explicit

Construct from patch and patch type.

Definition at line 50 of file fvPatchFieldBase.C.

◆ fvPatchFieldBase() [3/5]

fvPatchFieldBase	(	const fvPatch &	p,
		const dictionary &	dict
	)

Construct from patch and dictionary.

Definition at line 62 of file fvPatchFieldBase.C.

References dict, and fvPatchFieldBase::readDict().

Here is the call graph for this function:

◆ fvPatchFieldBase() [4/5]

fvPatchFieldBase	(	const fvPatchFieldBase &	rhs,
		const fvPatch &	p
	)

Copy construct with new patch.

Definition at line 74 of file fvPatchFieldBase.C.

◆ fvPatchFieldBase() [5/5]

fvPatchFieldBase ( const fvPatchFieldBase & rhs )

Copy construct.

Definition at line 87 of file fvPatchFieldBase.C.

◆ ~fvPatchFieldBase()

virtual ~fvPatchFieldBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ readDict()

void readDict ( const dictionary & dict )

protectedvirtual

Read dictionary entries.

Useful when initially constructed without a dictionary

Definition at line 99 of file fvPatchFieldBase.C.

References dict, keyType::LITERAL, and dictionary::readIfPresent().

Referenced by fvPatchFieldBase::fvPatchFieldBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state.

Definition at line 130 of file fvPatchField.H.

◆ setManipulated()

void setManipulated ( bool state )

inlinenoexcept

Set matrix manipulated state.

Definition at line 138 of file fvPatchField.H.

◆ TypeName()

TypeName ( "fvPatchField" )

Runtime type information.

◆ emptyType()

static const word& emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 196 of file fvPatchField.H.

References Foam::fieldTypes::emptyType.

◆ calculatedType()

static const word& calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 204 of file fvPatchField.H.

References Foam::fieldTypes::calculatedType.

Referenced by meshRefinement::appendPatch(), nearWallDist::correct(), Foam::createZeroBoundaryPtr(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), singleCellFvMesh::interpolate(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), writeCellVolumes::write(), writeCellCentres::write(), and electricPotential::write().

Here is the caller graph for this function:

◆ extrapolatedCalculatedType()

static const word& extrapolatedCalculatedType ( )

inlinestaticnoexcept

The type name for extrapolatedCalculated patch fields combines zero-gradient and calculated.

Definition at line 213 of file fvPatchField.H.

References Foam::fieldTypes::extrapolatedCalculatedType.

Referenced by fvMatrix< Type >::A(), greyMeanAbsorptionEmission::aCont(), cellCoBlended< Type >::blendingFactor(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), liquidFilmThermo::rho(), constantFilmThermo::rho(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), and laminar::Us().

Here is the caller graph for this function:

◆ zeroGradientType()

static const word& zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 221 of file fvPatchField.H.

References Foam::fieldTypes::zeroGradientType.

Referenced by adjointNull::accumulateGradDxDbMultiplier(), incompressibleAdjointSolver::accumulateGradDxDbMultiplier(), blendingFactor::blendingFactor(), curvatureSeparation::calcCosAngle(), ObukhovLength::calcOL(), inverseVolumeDiffusivity::correct(), motionDirectionalDiffusivity::correct(), curvatureSeparation::correct(), cellCellStencil::createField(), ATCModel::createLimiter(), meshRefinement::dumpRefinementLevel(), filmFlux::execute(), adjointSpalartAllmaras::FISensitivityTerm(), adjointkOmegaSST::FISensitivityTerm(), InterfaceCompositionModel< Thermo, OtherThermo >::getSpecieMassFraction(), segregated::K(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), Foam::makeZeroGradientField(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), InterfaceCompositionModel< Thermo, OtherThermo >::MwMixture(), objectiveNutSqr::objectiveNutSqr(), objectivePowerDissipation::objectivePowerDissipation(), objectiveUniformityCellZone::objectiveUniformityCellZone(), resolutionIndexModel::read(), eddyDissipationDiffusionModel< ReactionThermo, ThermoType >::rtDiff(), resolutionIndexModel::V(), solverInfo::write(), and oversetFvMeshBase::writeObject().

Here is the caller graph for this function:

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

True if the value of the patch field is altered by assignment.

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

Definition at line 234 of file fvPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

True if the patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented in cyclicACMIFvPatchField< Type >, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, calculatedFvPatchField< Type >, slicedFvPatchField< Type >, and directionMixedFvPatchField< Type >.

Definition at line 245 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:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

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

Definition at line 253 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(), relaxedNonOrthoGaussLaplacianScheme< 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

The associated objectRegistry.

Definition at line 106 of file fvPatchFieldBase.C.

References objectRegistry::thisDb().

Referenced by basicThermo::lookupThermo(), enthalpySorptionFvPatchScalarField::patchSource(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), prghPermeableAlphaTotalPressureFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patch()

const fvPatch& patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 269 of file fvPatchField.H.

Here is the caller graph for this function:

◆ patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 277 of file fvPatchField.H.

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

Here is the caller graph for this function:

◆ patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 285 of file fvPatchField.H.

◆ updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 296 of file fvPatchField.H.

Here is the caller graph for this function:

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

True if the matrix has already been manipulated.

Definition at line 304 of file fvPatchField.H.

◆ useImplicit() [1/2]

bool useImplicit ( ) const

inlinenoexcept

Use implicit formulation for coupled patches only.

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

◆ checkPatch()

void checkPatch ( const fvPatchFieldBase & rhs ) const

Check that patches are identical.

Definition at line 112 of file fvPatchFieldBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic fvPatchField.

Definition at line 149 of file fvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldBase.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ fvPatchFieldBase() [1/5]

◆ fvPatchFieldBase() [2/5]

◆ fvPatchFieldBase() [3/5]

◆ fvPatchFieldBase() [4/5]

◆ fvPatchFieldBase() [5/5]

◆ ~fvPatchFieldBase()

Member Function Documentation

◆ readDict()

◆ setUpdated()

◆ setManipulated()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ extrapolatedCalculatedType()

◆ zeroGradientType()

◆ assignable()

◆ fixesValue()

◆ coupled()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ updated()

◆ manipulatedMatrix()

◆ useImplicit() [1/2]

◆ useImplicit() [2/2]

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField