Template invariant parts for faPatchField. More...
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... | |
Template invariant parts for faPatchField.
Definition at line 77 of file faPatchField.H.
|
explicit |
Construct from patch.
Definition at line 41 of file faPatchFieldBase.C.
|
explicit |
Construct from patch and patch type.
Definition at line 50 of file faPatchFieldBase.C.
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().
faPatchFieldBase | ( | const faPatchFieldBase & | rhs, |
const faPatch & | p | ||
) |
Copy construct with new patch.
Definition at line 74 of file faPatchFieldBase.C.
faPatchFieldBase | ( | const faPatchFieldBase & | rhs | ) |
Copy construct.
Definition at line 85 of file faPatchFieldBase.C.
|
virtualdefault |
Destructor.
|
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().
TypeName | ( | "faPatchField" | ) |
Runtime type information.
|
inlinestaticnoexcept |
The type name for empty
patch fields.
Definition at line 166 of file faPatchField.H.
References Foam::fieldTypes::emptyType.
|
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().
|
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().
|
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().
|
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.
|
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().
const Foam::objectRegistry & db | ( | ) | const |
The associated objectRegistry.
Definition at line 101 of file faPatchFieldBase.C.
References objectRegistry::thisDb().
|
inlinenoexcept |
Return the patch.
Definition at line 231 of file faPatchField.H.
Referenced by faPatchField< Type >::NewCalculatedType().
|
inlinenoexcept |
The optional patch type.
Definition at line 239 of file faPatchField.H.
|
inlinenoexcept |
The optional patch type.
Definition at line 247 of file faPatchField.H.
|
inlinenoexcept |
True if the boundary condition has already been updated.
Definition at line 258 of file faPatchField.H.
|
inlinenoexcept |
Set updated state.
Definition at line 266 of file faPatchField.H.
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.
|
static |
Debug switch to disallow the use of generic faPatchField.
Definition at line 119 of file faPatchField.H.