Template invariant parts for pointPatchField. More...
Public Member Functions | |
TypeName ("pointPatchField") | |
Runtime type information. More... | |
pointPatchFieldBase (const pointPatch &p) | |
Construct from patch. More... | |
pointPatchFieldBase (const pointPatch &p, const word &patchType) | |
Construct from patch and patch type. More... | |
pointPatchFieldBase (const pointPatch &p, const dictionary &dict) | |
Construct from patch and dictionary. More... | |
pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p) | |
Copy construct with new patch. More... | |
pointPatchFieldBase (const pointPatchFieldBase &) | |
Copy construct. More... | |
virtual | ~pointPatchFieldBase ()=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... | |
virtual const word & | constraintType () const |
The constraint type the pointPatchField implements. More... | |
const objectRegistry & | db () const |
The associated objectRegistry. More... | |
const pointPatch & | 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. Currently ignored (always false) for pointPatchField. More... | |
void | checkPatch (const pointPatchFieldBase &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 & | zeroGradientType () noexcept |
The type name for zeroGradient patch fields. More... | |
Static Public Attributes | |
static int | disallowGenericPatchField |
Debug switch to disallow the use of generic pointPatchField. More... | |
Protected Member Functions | |
virtual void | readDict (const dictionary &dict) |
Read dictionary entries. More... | |
void | setUpdated (bool state) noexcept |
Set updated state. More... | |
void | setManipulated (bool state) noexcept |
Set matrix manipulated state. Currently a no-op for pointPatchField. More... | |
Template invariant parts for pointPatchField.
Definition at line 72 of file pointPatchField.H.
|
explicit |
Construct from patch.
Definition at line 39 of file pointPatchFieldBase.C.
pointPatchFieldBase | ( | const pointPatch & | p, |
const word & | patchType | ||
) |
Construct from patch and patch type.
Definition at line 48 of file pointPatchFieldBase.C.
pointPatchFieldBase | ( | const pointPatch & | p, |
const dictionary & | dict | ||
) |
Construct from patch and dictionary.
Definition at line 60 of file pointPatchFieldBase.C.
References dict, and pointPatchFieldBase::readDict().
pointPatchFieldBase | ( | const pointPatchFieldBase & | rhs, |
const pointPatch & | p | ||
) |
Copy construct with new patch.
Definition at line 72 of file pointPatchFieldBase.C.
pointPatchFieldBase | ( | const pointPatchFieldBase & | rhs | ) |
Copy construct.
Definition at line 83 of file pointPatchFieldBase.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Read dictionary entries.
Useful when initially constructed without a dictionary
Definition at line 93 of file pointPatchFieldBase.C.
References dict, keyType::LITERAL, and dictionary::readIfPresent().
Referenced by pointPatchFieldBase::pointPatchFieldBase().
|
inlineprotectednoexcept |
Set updated state.
Definition at line 111 of file pointPatchField.H.
|
inlineprotectednoexcept |
Set matrix manipulated state. Currently a no-op for pointPatchField.
Definition at line 119 of file pointPatchField.H.
TypeName | ( | "pointPatchField" | ) |
Runtime type information.
|
inlinestaticnoexcept |
The type name for empty
patch fields.
Definition at line 175 of file pointPatchField.H.
References Foam::fieldTypes::emptyType.
|
inlinestaticnoexcept |
The type name for calculated
patch fields.
Definition at line 183 of file pointPatchField.H.
References Foam::fieldTypes::calculatedType.
|
inlinestaticnoexcept |
The type name for zeroGradient
patch fields.
Definition at line 191 of file pointPatchField.H.
References Foam::fieldTypes::zeroGradientType.
|
inlinevirtual |
True if the patch field fixes a value.
Reimplemented in fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.
Definition at line 204 of file pointPatchField.H.
|
inlinevirtual |
True if the patch field is coupled.
Reimplemented in cyclicAMIPointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and coupledPointPatchField< Type >.
Definition at line 212 of file pointPatchField.H.
|
inlinevirtual |
The constraint type the pointPatchField implements.
Reimplemented in cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, processorPointPatchField< Type >, cyclicPointPatchField< Type >, symmetryPlanePointPatchField< Type >, emptyPointPatchField< Type >, symmetryPointPatchField< Type >, and wedgePointPatchField< Type >.
Definition at line 220 of file pointPatchField.H.
References word::null.
const Foam::objectRegistry & db | ( | ) | const |
The associated objectRegistry.
Definition at line 99 of file pointPatchFieldBase.C.
References objectRegistry::thisDb().
Referenced by waveMakerPointPatchVectorField::g(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().
|
inlinenoexcept |
Return the patch.
Definition at line 236 of file pointPatchField.H.
Referenced by pointPatchField< vector >::NewCalculatedType(), lumpedPointDisplacementPointPatchVectorField::points0(), pointPatchField< vector >::size(), waveDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().
|
inlinenoexcept |
The optional patch type.
Definition at line 244 of file pointPatchField.H.
|
inlinenoexcept |
The optional patch type.
Definition at line 252 of file pointPatchField.H.
|
inlinenoexcept |
True if the boundary condition has already been updated.
Definition at line 263 of file pointPatchField.H.
Referenced by oscillatingDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().
|
inlinenoexcept |
True if the matrix has already been manipulated. Currently ignored (always false) for pointPatchField.
Definition at line 272 of file pointPatchField.H.
void checkPatch | ( | const pointPatchFieldBase & | rhs | ) | const |
Check that patches are identical.
Definition at line 105 of file pointPatchFieldBase.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
static |
Debug switch to disallow the use of generic pointPatchField.
Definition at line 128 of file pointPatchField.H.