fvPatchFieldBase Class Reference

Template invariant parts for fvPatchField. More...

Inheritance diagram for fvPatchFieldBase:

Public Member Functions
	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...
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 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...
void	setUpdated (bool state) noexcept
	Set updated state. More...
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. More...

Detailed Description

Template invariant parts for fvPatchField.

Definition at line 77 of file fvPatchField.H.

Constructor & Destructor Documentation

fvPatchFieldBase() [1/5]

fvPatchFieldBase ( const fvPatch &  p )

explicit

Construct from patch.

Definition at line 39 of file fvPatchFieldBase.C.

fvPatchFieldBase() [2/5]

fvPatchFieldBase ( const fvPatch &  p, const word &  patchType  )

explicit

Construct from patch and patch type.

Definition at line 50 of file fvPatchFieldBase.C.

fvPatchFieldBase() [3/5]

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().

Here is the call graph for this function:

fvPatchFieldBase() [4/5]

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

Copy construct with new patch.

Definition at line 74 of file fvPatchFieldBase.C.

fvPatchFieldBase() [5/5]

fvPatchFieldBase

(

const fvPatchFieldBase &

rhs

)

Copy construct.

Definition at line 87 of file fvPatchFieldBase.C.

~fvPatchFieldBase()

virtual ~fvPatchFieldBase ( )

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 99 of file fvPatchFieldBase.C.

References dict, keyType::LITERAL, and dictionary::readIfPresent().

Referenced by fvPatchFieldBase::fvPatchFieldBase().

Here is the call graph for this function:

Here is the caller graph for this function:

setUpdated()

void setUpdated ( bool  state )

inlineprotectednoexcept

Set updated state.

Definition at line 127 of file fvPatchField.H.

setManipulated()

void setManipulated ( bool  state )

inlineprotectednoexcept

Set matrix manipulated state.

Definition at line 135 of file fvPatchField.H.

TypeName()

TypeName

(

"fvPatchField"

)

Runtime type information.

db()

const Foam::objectRegistry & db

(

)

const

The associated objectRegistry.

Definition at line 106 of file fvPatchFieldBase.C.

Referenced by basicThermo::lookupThermo(), enthalpySorptionFvPatchScalarField::patchSource(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), prghPermeableAlphaTotalPressureFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

patch()

const fvPatch& patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 199 of file fvPatchField.H.

Referenced by fieldExtents::calcFieldExtents(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), ReynoldsAnalogy::Cf(), extendedCellToFaceStencil::collectData(), reconstructedDistanceFunction::constructRDF(), contactAngleForce::correct(), Foam::evaluateConstraintTypes(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvPatchField< scalar >::NewCalculatedType(), Foam::oversetAdjustPhi(), enthalpySorptionFvPatchScalarField::patchSource(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), waWallFunctionFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), and regionSizeDistribution::write().

Here is the caller graph for this function:

patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 207 of file fvPatchField.H.

Referenced by uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField().

Here is the caller graph for this function:

patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 215 of file fvPatchField.H.

updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 226 of file fvPatchField.H.

Referenced by energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), waWallFunctionFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), prghPermeableAlphaTotalPressureFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), and porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

True if the matrix has already been manipulated.

Definition at line 234 of file fvPatchField.H.

useImplicit() [1/2]

bool useImplicit ( ) const

inlinenoexcept

Use implicit formulation for coupled patches only.

Definition at line 242 of file fvPatchField.H.

Referenced by lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

useImplicit() [2/2]

bool useImplicit ( bool  on )

inlinenoexcept

Set useImplicit on/off.

Returns

old value

Definition at line 252 of file fvPatchField.H.

checkPatch()

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.

Here is the call graph for this function:

Member Data Documentation

disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic fvPatchField.

Definition at line 145 of file fvPatchField.H.

---

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

• src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
• src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchFieldBase.C