faPatchFieldBase Class Reference

Template invariant parts for faPatchField. More...

#include <faPatchField.H>

Inheritance diagram for faPatchFieldBase:

Public Member Functions
	TypeName ("faPatchField")
	Runtime type information.
	faPatchFieldBase (const faPatch &p)
	Construct from patch.
	faPatchFieldBase (const faPatch &p, const word &patchType)
	Construct from patch and patch type.
	faPatchFieldBase (const faPatch &p, const dictionary &dict)
	Construct from patch and dictionary.
	faPatchFieldBase (const faPatchFieldBase &rhs, const faPatch &p)
	Copy construct with new patch.
	faPatchFieldBase (const faPatchFieldBase &rhs)
	Copy construct.
virtual	~faPatchFieldBase ()=default
	Destructor.
virtual bool	fixesValue () const
	True if the patch field fixes a value.
virtual bool	coupled () const
	True if the patch field is coupled.
const objectRegistry &	db () const
	The associated objectRegistry.
const faPatch &	patch () const noexcept
	Return the patch.
const word &	patchType () const noexcept
	The optional patch type.
word &	patchType () noexcept
	The optional patch type.
virtual bool	constraintOverride () const
	True if the type does not correspond to the constraint type.
bool	updated () const noexcept
	True if the boundary condition has already been updated.
void	setUpdated (bool state) noexcept
	Set updated state.
bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently always false for faPatchField.
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for faPatchField.
void	checkPatch (const faPatchFieldBase &rhs) const
	Check that patches are identical.

Static Public Member Functions
static const word &	emptyType () noexcept
	The type name for empty patch fields.
static const word &	calculatedType () noexcept
	The type name for calculated patch fields.
static const word &	extrapolatedCalculatedType () noexcept
	The type name for extrapolatedCalculated patch fields combines zero-gradient and calculated.
static const word &	zeroGradientType () noexcept
	The type name for zeroGradient patch fields.
static const word &	zeroValueType () noexcept
	The type name for zeroValue patch fields.

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

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

Detailed Description

Template invariant parts for faPatchField.

Definition at line 77 of file faPatchField.H.

Constructor & Destructor Documentation

faPatchFieldBase() [1/5]

faPatchFieldBase ( const faPatch & p )

explicit

Construct from patch.

Definition at line 41 of file faPatchFieldBase.C.

References p.

Referenced by checkPatch(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchField< Type >::faPatchField(), faPatchFieldBase(), faPatchFieldBase(), faPatchFieldBase(), faPatchFieldBase(), and TypeName().

Here is the caller graph for this function:

faPatchFieldBase() [2/5]

faPatchFieldBase ( const faPatch & p, const word & patchType )

explicit

Construct from patch and patch type.

Definition at line 49 of file faPatchFieldBase.C.

References faPatchFieldBase(), p, and patchType().

Here is the call graph for this function:

faPatchFieldBase() [3/5]

faPatchFieldBase	(	const faPatch &	p,
		const dictionary &	dict )

Construct from patch and dictionary.

Definition at line 61 of file faPatchFieldBase.C.

References dict, faPatchFieldBase(), p, and readDict().

Here is the call graph for this function:

faPatchFieldBase() [4/5]

faPatchFieldBase	(	const faPatchFieldBase &	rhs,
		const faPatch &	p )

Copy construct with new patch.

Definition at line 73 of file faPatchFieldBase.C.

References faPatchFieldBase(), p, and Foam::rhs().

Here is the call graph for this function:

faPatchFieldBase() [5/5]

faPatchFieldBase

(

const faPatchFieldBase &

rhs

)

Copy construct.

Definition at line 85 of file faPatchFieldBase.C.

References faPatchFieldBase(), and Foam::rhs().

Here is the call graph for this function:

~faPatchFieldBase()

virtual ~faPatchFieldBase ( )

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 95 of file faPatchFieldBase.C.

References dict, and keyType::LITERAL.

Referenced by faPatchFieldBase(), outletInletFaPatchField< Type >::outletInletFaPatchField(), slicedFaPatchField< Type >::slicedFaPatchField(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), and zeroValueFaPatchField< Type >::zeroValueFaPatchField().

Here is the caller graph for this function:

TypeName()

TypeName

(

"faPatchField"

)

Runtime type information.

References dict, faPatchFieldBase(), p, patchType(), and Foam::rhs().

Here is the call graph for this function:

emptyType()

const word & emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 166 of file faPatchField.H.

References Foam::fieldTypes::emptyType, and Foam::noexcept.

calculatedType()

const word & calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 174 of file faPatchField.H.

References Foam::fieldTypes::calculatedType, and Foam::noexcept.

Referenced by EulerFaD2dt2Scheme< Type >::facD2dt2(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), and EulerFaDdtScheme< Type >::facDdt().

Here is the caller graph for this function:

extrapolatedCalculatedType()

const word & extrapolatedCalculatedType ( )

inlinestaticnoexcept

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

Definition at line 183 of file faPatchField.H.

References Foam::fieldTypes::extrapolatedCalculatedType, and Foam::noexcept.

Referenced by faMatrix< Type >::A(), faMatrix< Type >::H(), and faMatrix< scalar >::H().

Here is the caller graph for this function:

zeroGradientType()

const word & zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 191 of file faPatchField.H.

References Foam::noexcept, and Foam::fieldTypes::zeroGradientType.

Referenced by leastSquaresFaGrad< Type >::calcGrad(), thermalShell::Cp(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), surfaceCourantNumber::execute(), thermalShell::kappa(), KirchhoffShell::rho(), thermalShell::rho(), and sensitivitySurface::smoothSensitivities().

Here is the caller graph for this function:

zeroValueType()

const word & zeroValueType ( )

inlinestaticnoexcept

The type name for zeroValue patch fields.

Definition at line 199 of file faPatchField.H.

References Foam::noexcept, and Foam::fieldTypes::zeroValueType.

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 calculatedFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, mixedFaPatchField< Type >, slicedFaPatchField< Type >, and zeroValueFaPatchField< Type >.

Definition at line 215 of file faPatchField.H.

coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

Reimplemented in coupledFaPatchField< Type >, and processorFaPatchField< Type >.

Definition at line 223 of file faPatchField.H.

Referenced by faMatrix< Type >::addBoundarySource(), leastSquaresFaGrad< Type >::calcGrad(), and faMatrix< Type >::relax().

Here is the caller graph for this function:

db()

const Foam::objectRegistry & db

(

)

const

The associated objectRegistry.

Definition at line 101 of file faPatchFieldBase.C.

References objectRegistry::thisDb().

Referenced by uniformFixedGradientFaPatchField< Type >::uniformFixedGradientFaPatchField(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), timeVaryingUniformFixedValueFaPatchField< Type >::updateCoeffs(), uniformFixedGradientFaPatchField< Type >::updateCoeffs(), uniformFixedValueFaPatchField< Type >::updateCoeffs(), and uniformMixedFaPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

patch()

const faPatch & patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 239 of file faPatchField.H.

References Foam::noexcept.

Referenced by coupledFaPatchField< Type >::coupledFaPatchField(), coupledFaPatchField< Type >::coupledFaPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), faPatchField< scalar >::declareRunTimeSelectionTable(), emptyFaPatchField< Type >::emptyFaPatchField(), basicSymmetryFaPatchField< Type >::evaluate(), clampedPlateFaPatchField< Type >::evaluate(), coupledFaPatchField< Type >::evaluate(), fixedGradientFaPatchField< Type >::evaluate(), mixedFaPatchField< Type >::evaluate(), wedgeFaPatchField< Type >::evaluate(), faPatchField< Type >::extrapolateInternal(), genericFaPatchField< Type >::genericFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), calculatedFaPatchField< Type >::gradientBoundaryCoeffs(), clampedPlateFaPatchField< Type >::gradientBoundaryCoeffs(), fixedValueFaPatchField< Type >::gradientBoundaryCoeffs(), fixedValueOutflowFaPatchField< Type >::gradientBoundaryCoeffs(), genericFaPatchField< Type >::gradientBoundaryCoeffs(), mixedFaPatchField< Type >::gradientBoundaryCoeffs(), calculatedFaPatchField< Type >::gradientInternalCoeffs(), clampedPlateFaPatchField< Type >::gradientInternalCoeffs(), coupledFaPatchField< Type >::gradientInternalCoeffs(), fixedValueFaPatchField< Type >::gradientInternalCoeffs(), fixedValueOutflowFaPatchField< Type >::gradientInternalCoeffs(), genericFaPatchField< Type >::gradientInternalCoeffs(), mixedFaPatchField< Type >::gradientInternalCoeffs(), transformFaPatchField< Type >::gradientInternalCoeffs(), zeroValueFaPatchField< Type >::gradientInternalCoeffs(), processorFaPatchField< Type >::initEvaluate(), faPatchField< scalar >::NewCalculatedType(), faPatchField< Type >::patchInternalField(), faPatchField< Type >::patchInternalField(), processorFaPatchField< Type >::processorFaPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFaPatchField< Type >::processorFaPatchField(), fixedGradientFaPatchField< Type >::readGradientEntry(), mixedFaPatchField< Type >::readMixedEntries(), faPatchField< Type >::readValueEntry(), slicedFaPatchField< Type >::slicedFaPatchField(), basicSymmetryFaPatchField< Type >::snGrad(), coupledFaPatchField< Type >::snGrad(), faPatchField< Type >::snGrad(), mixedFaPatchField< Type >::snGrad(), processorFaPatchField< Type >::snGrad(), processorFaPatchField< Type >::snGrad(), wedgeFaPatchField< Type >::snGrad(), basicSymmetryFaPatchField< Type >::snGradTransformDiag(), wedgeFaPatchField< Type >::snGradTransformDiag(), symmetryFaPatchField< Type >::symmetryFaPatchField(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), emptyFaPatchField< Type >::updateCoeffs(), inletOutletFaPatchField< Type >::updateCoeffs(), outletInletFaPatchField< Type >::updateCoeffs(), processorFaPatchField< Type >::updateInterfaceMatrix(), processorFaPatchField< Type >::updateInterfaceMatrix(), calculatedFaPatchField< Type >::valueBoundaryCoeffs(), fixedGradientFaPatchField< Type >::valueBoundaryCoeffs(), genericFaPatchField< Type >::valueBoundaryCoeffs(), mixedFaPatchField< Type >::valueBoundaryCoeffs(), transformFaPatchField< Type >::valueBoundaryCoeffs(), calculatedFaPatchField< Type >::valueInternalCoeffs(), genericFaPatchField< Type >::valueInternalCoeffs(), wedgeFaPatchField< Type >::wedgeFaPatchField(), wedgeFaPatchField< Type >::wedgeFaPatchField(), and zeroValueFaPatchField< Type >::zeroValueFaPatchField().

patchType() [1/2]

const word & patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 247 of file faPatchField.H.

References Foam::noexcept.

Referenced by faPatchFieldBase(), TypeName(), and faPatchField< Type >::write().

Here is the caller graph for this function:

patchType() [2/2]

word & patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 255 of file faPatchField.H.

References Foam::noexcept.

constraintOverride()

virtual bool constraintOverride ( ) const

inlinevirtual

True if the type does not correspond to the constraint type.

Definition at line 263 of file faPatchField.H.

References Foam::type().

Here is the call graph for this function:

updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 274 of file faPatchField.H.

References Foam::noexcept.

Referenced by basicSymmetryFaPatchField< Type >::evaluate(), clampedPlateFaPatchField< Type >::evaluate(), extrapolatedCalculatedFaPatchField< Type >::evaluate(), faPatchField< Type >::evaluate(), fixedGradientFaPatchField< Type >::evaluate(), mixedFaPatchField< Type >::evaluate(), wedgeFaPatchField< Type >::evaluate(), zeroGradientFaPatchField< Type >::evaluate(), coupledFaPatchField< Type >::initEvaluate(), inletOutletFaPatchField< Type >::updateCoeffs(), outletInletFaPatchField< Type >::updateCoeffs(), timeVaryingUniformFixedValueFaPatchField< Type >::updateCoeffs(), uniformFixedGradientFaPatchField< Type >::updateCoeffs(), uniformFixedValueFaPatchField< Type >::updateCoeffs(), and uniformMixedFaPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state.

Definition at line 282 of file faPatchField.H.

Referenced by faPatchField< Type >::evaluate(), and faPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

True if the matrix has already been manipulated. Currently always false for faPatchField.

Definition at line 291 of file faPatchField.H.

References Foam::noexcept.

setManipulated()

void setManipulated ( bool state )

inlinenoexcept

Set matrix manipulated state. Currently a no-op for faPatchField.

Definition at line 299 of file faPatchField.H.

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

Here is the caller graph for this function:

checkPatch()

void checkPatch

(

const faPatchFieldBase &

rhs

)

const

Check that patches are identical.

Definition at line 107 of file faPatchFieldBase.C.

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

Referenced by faPatchField< Type >::check(), faPatchField< Type >::operator*=(), faPatchField< Type >::operator+=(), faPatchField< Type >::operator-=(), faPatchField< Type >::operator/=(), and faPatchField< Type >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic faPatchField.

Definition at line 119 of file faPatchField.H.

Referenced by faPatchField< Type >::New().

---

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

• src/finiteArea/fields/faPatchFields/faPatchField/faPatchField.H
• src/finiteArea/fields/faPatchFields/faPatchField/faPatchFieldBase.C