Template invariant parts for fvPatchField. More...
Public Member Functions | |
void | setUpdated (bool state) noexcept |
Set updated state. More... | |
void | setManipulated (bool state) noexcept |
Set matrix manipulated state. More... | |
TypeName ("fvPatchField") | |
Runtime type information. More... | |
fvPatchFieldBase (const fvPatch &p) | |
Construct from patch. More... | |
fvPatchFieldBase (const fvPatch &p, const word &patchType) | |
Construct from patch and patch type. More... | |
fvPatchFieldBase (const fvPatch &p, const dictionary &dict) | |
Construct from patch and dictionary. More... | |
fvPatchFieldBase (const fvPatchFieldBase &rhs, const fvPatch &p) | |
Copy construct with new patch. More... | |
fvPatchFieldBase (const fvPatchFieldBase &rhs) | |
Copy construct. More... | |
virtual | ~fvPatchFieldBase ()=default |
Destructor. More... | |
virtual bool | assignable () const |
True if the value of the patch field is altered by assignment. 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 fvPatch & | 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. More... | |
bool | useImplicit () const noexcept |
Use implicit formulation for coupled patches only. More... | |
bool | useImplicit (bool on) noexcept |
Set useImplicit on/off. More... | |
void | checkPatch (const fvPatchFieldBase &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 fvPatchField. More... | |
Protected Member Functions | |
virtual void | readDict (const dictionary &dict) |
Read dictionary entries. More... | |
Template invariant parts for fvPatchField.
Definition at line 77 of file fvPatchField.H.
|
explicit |
Construct from patch.
Definition at line 39 of file fvPatchFieldBase.C.
|
explicit |
Construct from patch and patch type.
Definition at line 50 of file fvPatchFieldBase.C.
fvPatchFieldBase | ( | const fvPatch & | p, |
const dictionary & | dict | ||
) |
Construct from patch and dictionary.
Definition at line 62 of file fvPatchFieldBase.C.
References dict, and fvPatchFieldBase::readDict().
fvPatchFieldBase | ( | const fvPatchFieldBase & | rhs, |
const fvPatch & | p | ||
) |
Copy construct with new patch.
Definition at line 74 of file fvPatchFieldBase.C.
fvPatchFieldBase | ( | const fvPatchFieldBase & | rhs | ) |
Copy construct.
Definition at line 87 of file fvPatchFieldBase.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Read dictionary entries.
Useful when initially constructed without a dictionary
Definition at line 99 of file fvPatchFieldBase.C.
References dict, keyType::LITERAL, and dictionary::readIfPresent().
Referenced by fvPatchFieldBase::fvPatchFieldBase().
|
inlinenoexcept |
Set updated state.
Definition at line 130 of file fvPatchField.H.
|
inlinenoexcept |
Set matrix manipulated state.
Definition at line 138 of file fvPatchField.H.
TypeName | ( | "fvPatchField" | ) |
Runtime type information.
|
inlinestaticnoexcept |
The type name for empty
patch fields.
Definition at line 196 of file fvPatchField.H.
References Foam::fieldTypes::emptyType.
|
inlinestaticnoexcept |
The type name for calculated
patch fields.
Definition at line 204 of file fvPatchField.H.
References Foam::fieldTypes::calculatedType.
Referenced by meshRefinement::appendPatch(), nearWallDist::correct(), Foam::createZeroBoundaryPtr(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), writeCellVolumes::write(), writeCellCentres::write(), and electricPotential::write().
|
inlinestaticnoexcept |
The type name for extrapolatedCalculated
patch fields combines zero-gradient
and calculated
.
Definition at line 213 of file fvPatchField.H.
References Foam::fieldTypes::extrapolatedCalculatedType.
Referenced by fvMatrix< Type >::A(), greyMeanAbsorptionEmission::aCont(), cellCoBlended< Type >::blendingFactor(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), liquidFilmThermo::rho(), constantFilmThermo::rho(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), and laminar::Us().
|
inlinestaticnoexcept |
The type name for zeroGradient
patch fields.
Definition at line 221 of file fvPatchField.H.
References Foam::fieldTypes::zeroGradientType.
Referenced by adjointNull::accumulateGradDxDbMultiplier(), incompressibleAdjointSolver::accumulateGradDxDbMultiplier(), blendingFactor::blendingFactor(), curvatureSeparation::calcCosAngle(), ObukhovLength::calcOL(), inverseVolumeDiffusivity::correct(), motionDirectionalDiffusivity::correct(), curvatureSeparation::correct(), cellCellStencil::createField(), ATCModel::createLimiter(), meshRefinement::dumpRefinementLevel(), filmFlux::execute(), adjointSpalartAllmaras::FISensitivityTerm(), adjointkOmegaSST::FISensitivityTerm(), adjointEikonalSolver::getFISensitivityTerm(), InterfaceCompositionModel< Thermo, OtherThermo >::getSpecieMassFraction(), segregated::K(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), Foam::makeZeroGradientField(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), InterfaceCompositionModel< Thermo, OtherThermo >::MwMixture(), objectiveNutSqr::objectiveNutSqr(), objectivePowerDissipation::objectivePowerDissipation(), objectiveUniformityCellZone::objectiveUniformityCellZone(), adjointEikonalSolver::patchTypes(), resolutionIndexModel::read(), eddyDissipationDiffusionModel< ReactionThermo, ThermoType >::rtDiff(), levelSetDesignVariables::updateSignedDistances(), resolutionIndexModel::V(), solverInfo::write(), and oversetFvMeshBase::writeObject().
|
inlinevirtual |
True if the value of the patch field is altered by assignment.
Reimplemented in mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, fixedNormalSlipFvPatchField< Type >, partialSlipFvPatchField< Type >, uniformInletOutletFvPatchField< Type >, inletOutletFvPatchField< Type >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, slicedFvPatchField< Type >, directionMixedFvPatchField< Type >, slipFvPatchField< Type >, and transformFvPatchField< Type >.
Definition at line 234 of file fvPatchField.H.
|
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 cyclicACMIFvPatchField< Type >, mixedFvPatchField< Type >, mixedFvPatchField< scalar >, mixedFvPatchField< vector >, fixedValueFvPatchField< Type >, fixedValueFvPatchField< scalar >, calculatedFvPatchField< Type >, slicedFvPatchField< Type >, and directionMixedFvPatchField< Type >.
Definition at line 245 of file fvPatchField.H.
Referenced by Foam::adjustPhi(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), limitTemperature::correct(), Foam::MULES::limiter(), and Foam::MULES::limiterCorr().
|
inlinevirtual |
True if the patch field is coupled.
Reimplemented in cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicACMIFvPatchField< Type >, processorFvPatchField< Type >, calculatedProcessorFvPatchField< Type >, coupledFvPatchField< Type >, coupledFvPatchField< scalar >, and coupledFvPatchField< vector >.
Definition at line 253 of file fvPatchField.H.
Referenced by fvMatrix< Type >::addBoundarySource(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), directionalPressureGradientExplicitSource::correct(), fvMatrix< Type >::DD(), blackBodyEmission::EbDeltaLambdaT(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvMatrix< Type >::H1(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), fvMatrix< Type >::relax(), snGradScheme< Type >::snGrad(), and regionSizeDistribution::write().
const Foam::objectRegistry & db | ( | ) | const |
The associated objectRegistry.
Definition at line 106 of file fvPatchFieldBase.C.
References objectRegistry::thisDb().
Referenced by basicThermo::lookupThermo(), enthalpySorptionFvPatchScalarField::patchSource(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), prghPermeableAlphaTotalPressureFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField::updateCoeffs().
|
inlinenoexcept |
Return the patch.
Definition at line 269 of file fvPatchField.H.
Referenced by fieldExtents::calcFieldExtents(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), ReynoldsAnalogy::Cf(), extendedCellToFaceStencil::collectData(), reconstructedDistanceFunction::constructRDF(), contactAngleForce::correct(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvPatchField< vector >::NewCalculatedType(), Foam::oversetAdjustPhi(), enthalpySorptionFvPatchScalarField::patchSource(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), waWallFunctionFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField::updateCoeffs(), and regionSizeDistribution::write().
|
inlinenoexcept |
The optional patch type.
Definition at line 277 of file fvPatchField.H.
Referenced by uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField().
|
inlinenoexcept |
The optional patch type.
Definition at line 285 of file fvPatchField.H.
|
inlinenoexcept |
True if the boundary condition has already been updated.
Definition at line 296 of file fvPatchField.H.
Referenced by energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), waWallFunctionFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), prghPermeableAlphaTotalPressureFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField::updateCoeffs().
|
inlinenoexcept |
True if the matrix has already been manipulated.
Definition at line 304 of file fvPatchField.H.
|
inlinenoexcept |
Use implicit formulation for coupled patches only.
Definition at line 312 of file fvPatchField.H.
Referenced by lduPrimitiveMeshAssembly::update().
|
inlinenoexcept |
void checkPatch | ( | const fvPatchFieldBase & | rhs | ) | const |
Check that patches are identical.
Definition at line 112 of file fvPatchFieldBase.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
static |
Debug switch to disallow the use of generic fvPatchField.
Definition at line 149 of file fvPatchField.H.