Template invariant parts for faPatchField. More...

Inheritance diagram for faPatchFieldBase:

Public Member Functions
	TypeName ("faPatchField")
	Runtime type information. More...

	faPatchFieldBase (const faPatch &p)
	Construct from patch. More...

	faPatchFieldBase (const faPatch &p, const word &patchType)
	Construct from patch and patch type. More...

	faPatchFieldBase (const faPatch &p, const dictionary &dict)
	Construct from patch and dictionary. More...

	faPatchFieldBase (const faPatchFieldBase &rhs, const faPatch &p)
	Copy construct with new patch. More...

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

virtual	~faPatchFieldBase ()=default
	Destructor. 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 faPatch &	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...

void	setUpdated (bool state) noexcept
	Set updated state. More...

void	checkPatch (const faPatchFieldBase &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 faPatchField. More...

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

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.

◆ faPatchFieldBase() [2/5]

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

explicit

Construct from patch and patch type.

Definition at line 50 of file faPatchFieldBase.C.

◆ faPatchFieldBase() [3/5]

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

Construct from patch and dictionary.

Definition at line 62 of file faPatchFieldBase.C.

References dict, and faPatchFieldBase::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 74 of file faPatchFieldBase.C.

◆ faPatchFieldBase() [5/5]

faPatchFieldBase ( const faPatchFieldBase & rhs )

Copy construct.

Definition at line 85 of file faPatchFieldBase.C.

◆ ~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, keyType::LITERAL, and dictionary::readIfPresent().

Referenced by faPatchFieldBase::faPatchFieldBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "faPatchField" )

Runtime type information.

◆ emptyType()

static const word& emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 166 of file faPatchField.H.

References Foam::fieldTypes::emptyType.

◆ calculatedType()

static const word& calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 174 of file faPatchField.H.

References Foam::fieldTypes::calculatedType.

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

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 183 of file faPatchField.H.

References Foam::fieldTypes::extrapolatedCalculatedType.

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

Here is the caller graph for this function:

◆ zeroGradientType()

static const word& zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 191 of file faPatchField.H.

References Foam::fieldTypes::zeroGradientType.

Referenced by thermalShell::Cp(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), thermalShell::kappa(), thermalShell::rho(), KirchhoffShell::rho(), and sensitivitySurface::smoothSensitivities().

Here is the caller graph for this function:

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

Definition at line 207 of file faPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

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

Definition at line 215 of file faPatchField.H.

Referenced by faMatrix< Type >::addBoundarySource(), 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().

Here is the call graph for this function:

◆ patch()

const faPatch& patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 231 of file faPatchField.H.

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

Here is the caller graph for this function:

◆ patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 239 of file faPatchField.H.

◆ patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 247 of file faPatchField.H.

◆ updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 258 of file faPatchField.H.

◆ setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state.

Definition at line 266 of file faPatchField.H.

◆ checkPatch()

void checkPatch ( const faPatchFieldBase & rhs ) const

Check that patches are identical.

Definition at line 107 of file faPatchFieldBase.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 faPatchField.

Definition at line 119 of file faPatchField.H.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ faPatchFieldBase() [1/5]

◆ faPatchFieldBase() [2/5]

◆ faPatchFieldBase() [3/5]

◆ faPatchFieldBase() [4/5]

◆ faPatchFieldBase() [5/5]

◆ ~faPatchFieldBase()

Member Function Documentation

◆ readDict()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ extrapolatedCalculatedType()

◆ zeroGradientType()

◆ fixesValue()

◆ coupled()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ updated()

◆ setUpdated()

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField