Loading...
Searching...
No Matches
fvsPatchFieldBase Class Reference

Template invariant parts for fvsPatchField. More...

#include <fvsPatchField.H>

Inheritance diagram for fvsPatchFieldBase:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("fvsPatchField")
 Runtime type information.
 fvsPatchFieldBase (const fvPatch &p)
 Construct from patch.
 fvsPatchFieldBase (const fvPatch &p, const dictionary &dict)
 Construct from patch and dictionary (unused).
 fvsPatchFieldBase (const fvsPatchFieldBase &rhs, const fvPatch &p)
 Copy construct with new patch.
 fvsPatchFieldBase (const fvsPatchFieldBase &rhs)
 Copy construct.
virtual ~fvsPatchFieldBase ()=default
 Destructor.
virtual bool assignable () const
 True if the value of the patch field is altered by assignment.
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 fvPatch & 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 fvsPatchField.
void setUpdated (bool state) noexcept
 Set updated state. This is a no-op for fvsPatchField.
bool manipulatedMatrix () const noexcept
 True if the matrix has already been manipulated Always false for fvsPatchField.
void setManipulated (bool state) noexcept
 Set matrix manipulated state. This is a no-op for fvsPatchField.
void checkPatch (const fvsPatchFieldBase &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 fvsPatchField.

Protected Member Functions

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

Detailed Description

Template invariant parts for fvsPatchField.

Definition at line 74 of file fvsPatchField.H.

Constructor & Destructor Documentation

◆ fvsPatchFieldBase() [1/4]

fvsPatchFieldBase ( const fvPatch & p)
explicit

Construct from patch.

Definition at line 39 of file fvsPatchFieldBase.C.

References p.

Referenced by checkPatch(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchField< Type >::fvsPatchField(), fvsPatchFieldBase(), fvsPatchFieldBase(), and TypeName().

Here is the caller graph for this function:

◆ fvsPatchFieldBase() [2/4]

fvsPatchFieldBase ( const fvPatch & p,
const dictionary & dict )

Construct from patch and dictionary (unused).

Definition at line 46 of file fvsPatchFieldBase.C.

References dict, and p.

◆ fvsPatchFieldBase() [3/4]

fvsPatchFieldBase ( const fvsPatchFieldBase & rhs,
const fvPatch & p )

Copy construct with new patch.

Definition at line 57 of file fvsPatchFieldBase.C.

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

Here is the call graph for this function:

◆ fvsPatchFieldBase() [4/4]

fvsPatchFieldBase ( const fvsPatchFieldBase & rhs)

Copy construct.

Definition at line 68 of file fvsPatchFieldBase.C.

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

Here is the call graph for this function:

◆ ~fvsPatchFieldBase()

virtual ~fvsPatchFieldBase ( )
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 77 of file fvsPatchFieldBase.C.

References dict.

Referenced by slicedFvsPatchField< Type >::slicedFvsPatchField(), and zeroValueFvsPatchField< Type >::zeroValueFvsPatchField().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "fvsPatchField" )

Runtime type information.

References dict, fvsPatchFieldBase(), p, 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 152 of file fvsPatchField.H.

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

◆ calculatedType()

const word & calculatedType ( )
inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 160 of file fvsPatchField.H.

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

Referenced by meshRefinement::appendPatch(), fvMeshSubset::interpolate(), phaseModel::phaseModel(), and phaseModel::phaseModel().

Here is the caller graph for this function:

◆ zeroValueType()

const word & zeroValueType ( )
inlinestaticnoexcept

The type name for zeroValue patch fields.

Definition at line 168 of file fvsPatchField.H.

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

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

True if the value of the patch field is altered by assignment.

Reimplemented in fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, and zeroValueFvsPatchField< Type >.

Definition at line 181 of file fvsPatchField.H.

◆ 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 calculatedFvsPatchField< Type >, fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, and zeroValueFvsPatchField< Type >.

Definition at line 192 of file fvsPatchField.H.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

True if the patch field is coupled.

Reimplemented in coupledFvsPatchField< Type >, cyclicACMIFvsPatchField< Type >, cyclicAMIFvsPatchField< Type >, processorCyclicFvsPatchField< Type >, and processorFvsPatchField< Type >.

Definition at line 200 of file fvsPatchField.H.

Referenced by Foam::adjustPhi(), CentredFitSnGradData< Polynomial >::calcFit(), phaseModel::correctInflowOutflow(), linearUpwind< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindNormal< Type >::correction(), linearUpwindV< Type >::correction(), pointLinear< Type >::correction(), weightedFlux< Type >::interpolate(), Foam::MULES::limit(), basicFvGeometryScheme::nonOrthCorrectionVectors(), multiphaseSystem::solveAlphas(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), extendedCellToFaceStencil::weightedSum(), and extendedUpwindCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

The associated objectRegistry.

Definition at line 81 of file fvsPatchFieldBase.C.

References objectRegistry::thisDb().

Here is the call graph for this function:

◆ patch()

const fvPatch & patch ( ) const
inlinenoexcept

Return the patch.

Definition at line 216 of file fvsPatchField.H.

References Foam::noexcept.

Referenced by curvatureSeparation::calcCosAngle(), CentredFitSnGradData< Polynomial >::calcFit(), extendedFaceToCellStencil::collectData(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), cyclicACMIFvsPatchField< Type >::cyclicACMIFvsPatchField(), cyclicACMIFvsPatchField< Type >::cyclicACMIFvsPatchField(), cyclicAMIFvsPatchField< Type >::cyclicAMIFvsPatchField(), cyclicAMIFvsPatchField< Type >::cyclicAMIFvsPatchField(), cyclicFvsPatchField< Type >::cyclicFvsPatchField(), cyclicFvsPatchField< Type >::cyclicFvsPatchField(), fvsPatchField< scalar >::declareRunTimeSelectionTable(), emptyFvsPatchField< Type >::emptyFvsPatchField(), emptyFvsPatchField< Type >::emptyFvsPatchField(), emptyFvsPatchField< Type >::emptyFvsPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), fixedValueFvsPatchField< Type >::gradientBoundaryCoeffs(), genericFvsPatchField< Type >::gradientBoundaryCoeffs(), fixedValueFvsPatchField< Type >::gradientInternalCoeffs(), genericFvsPatchField< Type >::gradientInternalCoeffs(), zeroValueFvsPatchField< Type >::gradientInternalCoeffs(), dynamicRefineFvMesh::mapFields(), fvMeshAdder::MapSurfaceField(), fvsPatchField< scalar >::NewCalculatedType(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), processorCyclicFvsPatchField< Type >::processorCyclicFvsPatchField(), processorCyclicFvsPatchField< Type >::processorCyclicFvsPatchField(), processorCyclicFvsPatchField< Type >::processorCyclicFvsPatchField(), processorCyclicFvsPatchField< Type >::processorCyclicFvsPatchField(), processorFvsPatchField< Type >::processorFvsPatchField(), processorFvsPatchField< Type >::processorFvsPatchField(), processorFvsPatchField< Type >::processorFvsPatchField(), processorFvsPatchField< Type >::processorFvsPatchField(), fvsPatchField< Type >::readValueEntry(), slicedFvsPatchField< Type >::slicedFvsPatchField(), symmetryFvsPatchField< Type >::symmetryFvsPatchField(), symmetryFvsPatchField< Type >::symmetryFvsPatchField(), symmetryPlaneFvsPatchField< Type >::symmetryPlaneFvsPatchField(), symmetryPlaneFvsPatchField< Type >::symmetryPlaneFvsPatchField(), fvMeshDistribute::testField(), genericFvsPatchField< Type >::valueBoundaryCoeffs(), genericFvsPatchField< Type >::valueInternalCoeffs(), wedgeFvsPatchField< Type >::wedgeFvsPatchField(), wedgeFvsPatchField< Type >::wedgeFvsPatchField(), extendedCellToFaceStencil::weightedSum(), extendedUpwindCellToFaceStencil::weightedSum(), and zeroValueFvsPatchField< Type >::zeroValueFvsPatchField().

Here is the caller graph for this function:

◆ patchType() [1/2]

const word & patchType ( ) const
inlinenoexcept

The optional patch type.

Definition at line 224 of file fvsPatchField.H.

References Foam::noexcept.

◆ patchType() [2/2]

word & patchType ( )
inlinenoexcept

The optional patch type.

Definition at line 232 of file fvsPatchField.H.

References Foam::noexcept.

◆ constraintOverride()

virtual bool constraintOverride ( ) const
inlinevirtual

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

Definition at line 240 of file fvsPatchField.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 fvsPatchField.

Definition at line 252 of file fvsPatchField.H.

References Foam::noexcept.

◆ setUpdated()

void setUpdated ( bool state)
inlinenoexcept

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

Definition at line 260 of file fvsPatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const
inlinenoexcept

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

Definition at line 267 of file fvsPatchField.H.

References Foam::noexcept.

◆ setManipulated()

void setManipulated ( bool state)
inlinenoexcept

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

Definition at line 276 of file fvsPatchField.H.

◆ checkPatch()

void checkPatch ( const fvsPatchFieldBase & rhs) const

Check that patches are identical.

Definition at line 87 of file fvsPatchFieldBase.C.

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

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

Definition at line 110 of file fvsPatchField.H.

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

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