Template invariant parts for fvsPatchField. More...

Inheritance diagram for fvsPatchFieldBase:

Public Member Functions
	TypeName ("fvsPatchField")
	Runtime type information. More...

	fvsPatchFieldBase (const fvPatch &p)
	Construct from patch. More...

	fvsPatchFieldBase (const fvPatch &p, const dictionary &dict)
	Construct from patch and dictionary (unused) More...

	fvsPatchFieldBase (const fvsPatchFieldBase &rhs, const fvPatch &p)
	Copy construct with new patch. More...

	fvsPatchFieldBase (const fvsPatchFieldBase &rhs)
	Copy construct. More...

virtual	~fvsPatchFieldBase ()=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...

virtual bool	constraintOverride () const
	True if the type does not correspond to the constraint type. More...

bool	updated () const noexcept
	True if the boundary condition has already been updated. This is always true for fvsPatchField. More...

void	setUpdated (bool state) noexcept
	Set updated state. This is a no-op for fvsPatchField. More...

bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated Always false for fvsPatchField. More...

void	setManipulated (bool state) noexcept
	Set matrix manipulated state. This is a no-op for fvsPatchField. More...

void	checkPatch (const fvsPatchFieldBase &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 Public Attributes
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic fvsPatchField. More...

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

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.

◆ fvsPatchFieldBase() [2/4]

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

Construct from patch and dictionary (unused)

Definition at line 47 of file fvsPatchFieldBase.C.

◆ fvsPatchFieldBase() [3/4]

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

Copy construct with new patch.

Definition at line 58 of file fvsPatchFieldBase.C.

◆ fvsPatchFieldBase() [4/4]

fvsPatchFieldBase ( const fvsPatchFieldBase & rhs )

Copy construct.

Definition at line 68 of file fvsPatchFieldBase.C.

◆ ~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.

◆ TypeName()

TypeName ( "fvsPatchField" )

Runtime type information.

◆ emptyType()

static const word& emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 152 of file fvsPatchField.H.

References Foam::fieldTypes::emptyType.

◆ calculatedType()

static const word& calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 160 of file fvsPatchField.H.

References Foam::fieldTypes::calculatedType.

Referenced by meshRefinement::appendPatch().

Here is the caller graph for this function:

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

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

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

Definition at line 173 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 fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, and calculatedFvsPatchField< Type >.

Definition at line 184 of file fvsPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

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

Definition at line 192 of file fvsPatchField.H.

Referenced by Foam::adjustPhi(), CentredFitSnGradData< Polynomial >::calcFit(), phaseModel::correctInflowOutflow(), pointLinear< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), weightedFlux< Type >::interpolate(), Foam::MULES::limit(), basicFvGeometryScheme::nonOrthCorrectionVectors(), multiphaseSystem::solveAlphas(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::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 208 of file fvsPatchField.H.

Referenced by curvatureSeparation::calcCosAngle(), CentredFitSnGradData< Polynomial >::calcFit(), extendedFaceToCellStencil::collectData(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), dynamicRefineFvMesh::mapFields(), fvMeshAdder::MapSurfaceField(), fvsPatchField< Type >::NewCalculatedType(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), fvMeshDistribute::testField(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 216 of file fvsPatchField.H.

◆ patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 224 of file fvsPatchField.H.

◆ constraintOverride()

virtual bool constraintOverride ( ) const

inlinevirtual

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

Definition at line 232 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 244 of file fvsPatchField.H.

◆ setUpdated()

void setUpdated ( bool state )

inlinenoexcept

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

Definition at line 252 of file fvsPatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

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

Definition at line 259 of file fvsPatchField.H.

◆ setManipulated()

void setManipulated ( bool state )

inlinenoexcept

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

Definition at line 268 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, and FatalErrorInFunction.

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.

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

src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchField.H
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchFieldBase.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ fvsPatchFieldBase() [1/4]

◆ fvsPatchFieldBase() [2/4]

◆ fvsPatchFieldBase() [3/4]

◆ fvsPatchFieldBase() [4/4]

◆ ~fvsPatchFieldBase()

Member Function Documentation

◆ readDict()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ assignable()

◆ fixesValue()

◆ coupled()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ constraintOverride()

◆ updated()

◆ setUpdated()

◆ manipulatedMatrix()

◆ setManipulated()

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField