Template invariant parts for faePatchField. More...

#include <faePatchField.H>

Inheritance diagram for faePatchFieldBase:

[legend]

Public Member Functions
	TypeName ("faePatchField")
	Runtime type information.
	faePatchFieldBase (const faPatch &p)
	Construct from patch.
	faePatchFieldBase (const faPatch &p, const word &patchType)
	Construct from patch and patch type.
	faePatchFieldBase (const faPatch &p, const dictionary &dict)
	Construct from patch and dictionary.
	faePatchFieldBase (const faePatchFieldBase &rhs, const faPatch &p)
	Copy construct with new patch.
	faePatchFieldBase (const faePatchFieldBase &rhs)
	Copy construct.
virtual	~faePatchFieldBase ()=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. This is always true for faePatchField.
void	setUpdated (bool state) noexcept
	Set updated state. This is a no-op for faePatchField.
bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Always false for faePatchField.
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. This is a no-op for faePatchField.
void	checkPatch (const faePatchFieldBase &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 &	zeroValueType () noexcept
	The type name for `zeroValue` patch fields.

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

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

Detailed Description

Template invariant parts for faePatchField.

Definition at line 76 of file faePatchField.H.

Constructor & Destructor Documentation

◆ faePatchFieldBase() [1/5]

faePatchFieldBase ( const faPatch & p )

explicit

Construct from patch.

Definition at line 41 of file faePatchFieldBase.C.

References p.

Referenced by checkPatch(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchField< Type >::faePatchField(), faePatchFieldBase(), faePatchFieldBase(), faePatchFieldBase(), and TypeName().

Here is the caller graph for this function:

◆ faePatchFieldBase() [2/5]

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

explicit

Construct from patch and patch type.

Definition at line 48 of file faePatchFieldBase.C.

References p, and patchType().

Here is the call graph for this function:

◆ faePatchFieldBase() [3/5]

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

Construct from patch and dictionary.

Definition at line 59 of file faePatchFieldBase.C.

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

Here is the call graph for this function:

◆ faePatchFieldBase() [4/5]

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

Copy construct with new patch.

Definition at line 71 of file faePatchFieldBase.C.

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

Here is the call graph for this function:

◆ faePatchFieldBase() [5/5]

faePatchFieldBase ( const faePatchFieldBase & rhs )

Copy construct.

Definition at line 82 of file faePatchFieldBase.C.

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

Here is the call graph for this function:

◆ ~faePatchFieldBase()

virtual ~faePatchFieldBase ( )

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 91 of file faePatchFieldBase.C.

References dict.

Referenced by faePatchFieldBase(), slicedFaePatchField< Type >::slicedFaePatchField(), and zeroValueFaePatchField< Type >::zeroValueFaePatchField().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "faePatchField" )

Runtime type information.

References dict, faePatchFieldBase(), 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 159 of file faePatchField.H.

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

◆ calculatedType()

const word & calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 167 of file faePatchField.H.

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

◆ zeroValueType()

const word & zeroValueType ( )

inlinestaticnoexcept

The type name for zeroValue patch fields.

Definition at line 175 of file faePatchField.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 calculatedFaePatchField< Type >, fixedValueFaePatchField< Type >, slicedFaePatchField< Type >, and zeroValueFaePatchField< Type >.

Definition at line 191 of file faePatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

Reimplemented in coupledFaePatchField< Type >, and processorFaePatchField< Type >.

Definition at line 199 of file faePatchField.H.

◆ db()

const Foam::objectRegistry & db ( ) const

The associated objectRegistry.

Definition at line 97 of file faePatchFieldBase.C.

References objectRegistry::thisDb().

Here is the call graph for this function:

◆ patch()

const faPatch & patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 215 of file faePatchField.H.

References Foam::noexcept.

Here is the caller graph for this function:

◆ patchType() [1/2]

const word & patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 223 of file faePatchField.H.

References Foam::noexcept.

Referenced by faePatchFieldBase(), and TypeName().

Here is the caller graph for this function:

◆ patchType() [2/2]

word & patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 231 of file faePatchField.H.

References Foam::noexcept.

◆ constraintOverride()

virtual bool constraintOverride ( ) const

inlinevirtual

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

Definition at line 239 of file faePatchField.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. This is always true for faePatchField.

Definition at line 251 of file faePatchField.H.

References Foam::noexcept.

◆ setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state. This is a no-op for faePatchField.

Definition at line 259 of file faePatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

True if the matrix has already been manipulated. Always false for faePatchField.

Definition at line 266 of file faePatchField.H.

References Foam::noexcept.

◆ setManipulated()

void setManipulated ( bool state )

inlinenoexcept

Set matrix manipulated state. This is a no-op for faePatchField.

Definition at line 275 of file faePatchField.H.

◆ checkPatch()

void checkPatch ( const faePatchFieldBase & rhs ) const

Check that patches are identical.

Definition at line 103 of file faePatchFieldBase.C.

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

Referenced by faePatchField< Type >::check(), faePatchField< Type >::operator*=(), faePatchField< Type >::operator+=(), faePatchField< Type >::operator-=(), faePatchField< Type >::operator/=(), and faePatchField< 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 faePatchField.

Definition at line 112 of file faePatchField.H.

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

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

src/finiteArea/fields/faePatchFields/faePatchField/faePatchField.H
src/finiteArea/fields/faePatchFields/faePatchField/faePatchFieldBase.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ faePatchFieldBase() [1/5]

◆ faePatchFieldBase() [2/5]

◆ faePatchFieldBase() [3/5]

◆ faePatchFieldBase() [4/5]

◆ faePatchFieldBase() [5/5]

◆ ~faePatchFieldBase()

Member Function Documentation

◆ readDict()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ zeroValueType()

◆ fixesValue()

◆ coupled()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ constraintOverride()

◆ updated()

◆ setUpdated()

◆ manipulatedMatrix()

◆ setManipulated()

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField