pointPatchFieldBase Class Reference

Template invariant parts for pointPatchField. More...

#include <pointPatchField.H>

Inheritance diagram for pointPatchFieldBase:

Public Member Functions
	TypeName ("pointPatchField")
	Runtime type information.
	pointPatchFieldBase (const pointPatch &p)
	Construct from patch.
	pointPatchFieldBase (const pointPatch &p, const word &patchType)
	Construct from patch and patch type.
	pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
	Construct from patch and dictionary.
	pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
	Copy construct with new patch.
	pointPatchFieldBase (const pointPatchFieldBase &)
	Copy construct.
virtual	~pointPatchFieldBase ()=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.
virtual const word &	constraintType () const
	The constraint type the pointPatchField implements.
const objectRegistry &	db () const
	The associated objectRegistry.
const pointPatch &	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.
void	setUpdated (bool state) noexcept
	Set updated state.
bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently always false for pointPatchField.
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for pointPatchField.
void	checkPatch (const pointPatchFieldBase &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 &	zeroGradientType () noexcept
	The type name for zeroGradient 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 pointPatchField.

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

Detailed Description

Template invariant parts for pointPatchField.

Definition at line 72 of file pointPatchField.H.

Constructor & Destructor Documentation

pointPatchFieldBase() [1/5]

pointPatchFieldBase ( const pointPatch & p )

explicit

Construct from patch.

Definition at line 39 of file pointPatchFieldBase.C.

References p.

Referenced by checkPatch(), pointPatchField< Type >::pointPatchField(), pointPatchField< Type >::pointPatchField(), pointPatchField< Type >::pointPatchField(), pointPatchField< Type >::pointPatchField(), pointPatchField< Type >::pointPatchField(), pointPatchFieldBase(), pointPatchFieldBase(), pointPatchFieldBase(), pointPatchFieldBase(), and TypeName().

Here is the caller graph for this function:

pointPatchFieldBase() [2/5]

pointPatchFieldBase	(	const pointPatch &	p,
		const word &	patchType )

Construct from patch and patch type.

Definition at line 47 of file pointPatchFieldBase.C.

References p, patchType(), and pointPatchFieldBase().

Here is the call graph for this function:

pointPatchFieldBase() [3/5]

pointPatchFieldBase	(	const pointPatch &	p,
		const dictionary &	dict )

Construct from patch and dictionary.

Definition at line 59 of file pointPatchFieldBase.C.

References dict, p, pointPatchFieldBase(), and readDict().

Here is the call graph for this function:

pointPatchFieldBase() [4/5]

pointPatchFieldBase	(	const pointPatchFieldBase &	rhs,
		const pointPatch &	p )

Copy construct with new patch.

Definition at line 71 of file pointPatchFieldBase.C.

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

Here is the call graph for this function:

pointPatchFieldBase() [5/5]

pointPatchFieldBase

(

const pointPatchFieldBase &

rhs

)

Copy construct.

Definition at line 83 of file pointPatchFieldBase.C.

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

Here is the call graph for this function:

~pointPatchFieldBase()

virtual ~pointPatchFieldBase ( )

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 93 of file pointPatchFieldBase.C.

References dict, and keyType::LITERAL.

Referenced by pointPatchFieldBase(), and zeroValuePointPatchField< Type >::zeroValuePointPatchField().

Here is the caller graph for this function:

TypeName()

TypeName

(

"pointPatchField"

)

Runtime type information.

References dict, p, patchType(), and pointPatchFieldBase().

Here is the call graph for this function:

emptyType()

const word & emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 161 of file pointPatchField.H.

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

calculatedType()

const word & calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 169 of file pointPatchField.H.

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

Referenced by fvMeshSubset::interpolate().

Here is the caller graph for this function:

zeroGradientType()

const word & zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 177 of file pointPatchField.H.

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

zeroValueType()

const word & zeroValueType ( )

inlinestaticnoexcept

The type name for zeroValue patch fields.

Definition at line 185 of file pointPatchField.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 fixedValuePointPatchField< Type >, fixedValuePointPatchField< vector >, valuePointPatchField< Type >, valuePointPatchField< vector >, and zeroValuePointPatchField< Type >.

Definition at line 198 of file pointPatchField.H.

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

True if the patch field fixes a value.

Reimplemented in fixedValuePointPatchField< Type >, fixedValuePointPatchField< vector >, and zeroValuePointPatchField< Type >.

Definition at line 206 of file pointPatchField.H.

coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

Reimplemented in coupledPointPatchField< Type >, cyclicAMIPointPatchField< Type >, processorCyclicPointPatchField< Type >, and processorPointPatchField< Type >.

Definition at line 214 of file pointPatchField.H.

constraintType()

virtual const word & constraintType ( ) const

inlinevirtual

The constraint type the pointPatchField implements.

Reimplemented in cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, cyclicPointPatchField< Type >, emptyPointPatchField< Type >, processorPointPatchField< Type >, symmetryPlanePointPatchField< Type >, symmetryPointPatchField< Type >, and wedgePointPatchField< Type >.

Definition at line 222 of file pointPatchField.H.

References word::null.

Referenced by pointPatchField< Type >::New(), and pointPatchField< Type >::New().

Here is the caller graph for this function:

db()

const Foam::objectRegistry & db

(

)

const

The associated objectRegistry.

Definition at line 99 of file pointPatchFieldBase.C.

References objectRegistry::thisDb().

Referenced by waveMakerPointPatchVectorField::g(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), surfaceSlipDisplacementPointPatchVectorField::surfaces(), timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField(), timeVaryingUniformFixedValuePointPatchField< Type >::timeVaryingUniformFixedValuePointPatchField(), timeVaryingUniformFixedValuePointPatchField< Type >::timeVaryingUniformFixedValuePointPatchField(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), timeVaryingUniformFixedValuePointPatchField< Type >::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), uniformFixedValuePointPatchField< Type >::updateCoeffs(), waveMakerPointPatchVectorField::updateCoeffs(), waveMakerPointPatchVectorField::waveMakerPointPatchVectorField(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

patch()

const pointPatch & patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 238 of file pointPatchField.H.

References Foam::noexcept.

Referenced by pointPatchField< Type >::addToInternalField(), pointPatchField< Type >::addToInternalField(), cyclicACMIPointPatchField< Type >::cyclicACMIPointPatchField(), cyclicACMIPointPatchField< Type >::cyclicACMIPointPatchField(), cyclicAMIPointPatchField< Type >::cyclicAMIPointPatchField(), cyclicAMIPointPatchField< Type >::cyclicAMIPointPatchField(), cyclicPointPatchField< Type >::cyclicPointPatchField(), cyclicPointPatchField< Type >::cyclicPointPatchField(), pointPatchField< scalar >::declareRunTimeSelectionTable(), edgeSlipDisplacementPointPatchVectorField::edgeSlipDisplacementPointPatchVectorField(), edgeSlipDisplacementPointPatchVectorField::edgeTree(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), basicSymmetryPointPatchField< Type >::evaluate(), cyclicSlipPointPatchField< Type >::evaluate(), nonuniformTransformCyclicPointPatchField< Type >::evaluate(), wedgePointPatchField< Type >::evaluate(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), valuePointPatchField< Type >::extrapolateInternal(), genericPointPatchField< Type >::genericPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), waveMakerPointPatchVectorField::initialiseGeometry(), lumpedPointDisplacementPointPatchVectorField::movement(), pointPatchField< scalar >::NewCalculatedType(), pointPatchField< scalar >::patchInternalField(), pointAttractionDisplacementPointPatchVectorField::pointAttractionDisplacementPointPatchVectorField(), lumpedPointDisplacementPointPatchVectorField::points0(), pointAttractionDisplacementPointPatchVectorField::pointTree(), processorCyclicPointPatchField< Type >::processorCyclicPointPatchField(), processorCyclicPointPatchField< Type >::processorCyclicPointPatchField(), processorPointPatchField< Type >::processorPointPatchField(), processorPointPatchField< Type >::processorPointPatchField(), valuePointPatchField< Type >::readValueEntry(), codedFixedValuePointPatchField< Type >::redirectPatchField(), pointPatchField< Type >::setInInternalField(), pointPatchField< scalar >::size(), surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField(), surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField(), surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField(), symmetryPlanePointPatchField< Type >::symmetryPlanePointPatchField(), symmetryPlanePointPatchField< Type >::symmetryPlanePointPatchField(), symmetryPointPatchField< Type >::symmetryPointPatchField(), symmetryPointPatchField< Type >::symmetryPointPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), edgeSlipDisplacementPointPatchVectorField::updateCoeffs(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), pointAttractionDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), surfaceSlipDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), waveMakerPointPatchVectorField::updateCoeffs(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), lumpedPointDisplacementPointPatchVectorField::write(), zeroValuePointPatchField< Type >::zeroValuePointPatchField(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().

patchType() [1/2]

const word & patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 246 of file pointPatchField.H.

References Foam::noexcept.

Referenced by pointPatchFieldBase(), TypeName(), and pointPatchField< Type >::write().

Here is the caller graph for this function:

patchType() [2/2]

word & patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 254 of file pointPatchField.H.

References Foam::noexcept.

constraintOverride()

virtual bool constraintOverride ( ) const

inlinevirtual

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

Definition at line 262 of file pointPatchField.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.

Definition at line 273 of file pointPatchField.H.

References Foam::noexcept.

Referenced by pointPatchField< Type >::evaluate(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), codedFixedValuePointPatchField< Type >::updateCoeffs(), edgeSlipDisplacementPointPatchVectorField::updateCoeffs(), exprValuePointPatchField< Type >::updateCoeffs(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), pointAttractionDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), surfaceSlipDisplacementPointPatchVectorField::updateCoeffs(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), timeVaryingUniformFixedValuePointPatchField< Type >::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), uniformFixedValuePointPatchField< Type >::updateCoeffs(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), valuePointPatchField< Type >::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), and waveMakerPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state.

Definition at line 281 of file pointPatchField.H.

Referenced by pointPatchField< Type >::evaluate(), and pointPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

True if the matrix has already been manipulated. Currently always false for pointPatchField.

Definition at line 290 of file pointPatchField.H.

References Foam::noexcept.

setManipulated()

void setManipulated ( bool state )

inlinenoexcept

Set matrix manipulated state. Currently a no-op for pointPatchField.

Definition at line 299 of file pointPatchField.H.

Referenced by pointPatchField< Type >::evaluate().

Here is the caller graph for this function:

checkPatch()

void checkPatch

(

const pointPatchFieldBase &

rhs

)

const

Check that patches are identical.

Definition at line 105 of file pointPatchFieldBase.C.

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

Here is the call graph for this function:

Member Data Documentation

disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic pointPatchField.

Definition at line 114 of file pointPatchField.H.

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

---

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

• src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchField.H
• src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchFieldBase.C