Template invariant parts for pointPatchField. More...

Inheritance diagram for pointPatchFieldBase:

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

	pointPatchFieldBase (const pointPatch &p)
	Construct from patch. More...

	pointPatchFieldBase (const pointPatch &p, const word &patchType)
	Construct from patch and patch type. More...

	pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
	Construct from patch and dictionary. More...

	pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
	Copy construct with new patch. More...

	pointPatchFieldBase (const pointPatchFieldBase &)
	Copy construct. More...

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

virtual const word &	constraintType () const
	The constraint type the pointPatchField implements. More...

const objectRegistry &	db () const
	The associated objectRegistry. More...

const pointPatch &	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. More...

void	setUpdated (bool state) noexcept
	Set updated state. More...

bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently always false for pointPatchField. More...

void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for pointPatchField. More...

void	checkPatch (const pointPatchFieldBase &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 &	zeroGradientType () noexcept
	The type name for `zeroGradient` patch fields. More...

static const word &	zeroValueType () noexcept
	The type name for `zeroValue` patch fields. More...

Static Public Attributes
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic pointPatchField. More...

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

Detailed Description

Template invariant parts for pointPatchField.

Definition at line 77 of file pointPatchField.H.

Constructor & Destructor Documentation

◆ pointPatchFieldBase() [1/5]

pointPatchFieldBase ( const pointPatch & p )

explicit

Construct from patch.

◆ pointPatchFieldBase() [2/5]

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

Construct from patch and patch type.

◆ pointPatchFieldBase() [3/5]

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

Construct from patch and dictionary.

◆ pointPatchFieldBase() [4/5]

pointPatchFieldBase	(	const pointPatchFieldBase &	,
		const pointPatch &	p
	)

Copy construct with new patch.

◆ pointPatchFieldBase() [5/5]

pointPatchFieldBase ( const pointPatchFieldBase & )

Copy construct.

◆ ~pointPatchFieldBase()

virtual ~pointPatchFieldBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ readDict()

virtual void readDict ( const dictionary & dict )

protectedvirtual

Read dictionary entries.

Useful when initially constructed without a dictionary

◆ TypeName()

TypeName ( "pointPatchField" )

Runtime type information.

◆ emptyType()

static const word& emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 166 of file pointPatchField.H.

References Foam::fieldTypes::emptyType.

◆ calculatedType()

static const word& calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 174 of file pointPatchField.H.

References Foam::fieldTypes::calculatedType.

◆ zeroGradientType()

static const word& zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 182 of file pointPatchField.H.

References Foam::fieldTypes::zeroGradientType.

◆ zeroValueType()

static const word& zeroValueType ( )

inlinestaticnoexcept

The type name for zeroValue patch fields.

Definition at line 190 of file pointPatchField.H.

References Foam::fieldTypes::zeroValueType.

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

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

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

Definition at line 203 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 211 of file pointPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

True if the patch field is coupled.

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

Definition at line 219 of file pointPatchField.H.

◆ constraintType()

virtual const word& constraintType ( ) const

inlinevirtual

The constraint type the pointPatchField implements.

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

Definition at line 227 of file pointPatchField.H.

References word::null.

◆ db()

const objectRegistry& db ( ) const

The associated objectRegistry.

Referenced by uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ patch()

const pointPatch& patch ( ) const

inlinenoexcept

Return the patch.

Definition at line 243 of file pointPatchField.H.

Referenced by lumpedPointDisplacementPointPatchVectorField::points0(), pointPatchField< vector >::size(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ patchType() [1/2]

const word& patchType ( ) const

inlinenoexcept

The optional patch type.

Definition at line 251 of file pointPatchField.H.

◆ patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 259 of file pointPatchField.H.

◆ constraintOverride()

virtual bool constraintOverride ( ) const

inlinevirtual

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

Definition at line 267 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 278 of file pointPatchField.H.

Referenced by uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ setUpdated()

void setUpdated ( bool state )

inlinenoexcept

Set updated state.

Definition at line 286 of file pointPatchField.H.

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

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

Definition at line 295 of file pointPatchField.H.

◆ setManipulated()

void setManipulated ( bool state )

inlinenoexcept

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

Definition at line 304 of file pointPatchField.H.

◆ checkPatch()

void checkPatch ( const pointPatchFieldBase & rhs ) const

Check that patches are identical.

Member Data Documentation

◆ disallowGenericPatchField

int disallowGenericPatchField

static

Debug switch to disallow the use of generic pointPatchField.

Definition at line 119 of file pointPatchField.H.

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

src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchField.H

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ pointPatchFieldBase() [1/5]

◆ pointPatchFieldBase() [2/5]

◆ pointPatchFieldBase() [3/5]

◆ pointPatchFieldBase() [4/5]

◆ pointPatchFieldBase() [5/5]

◆ ~pointPatchFieldBase()

Member Function Documentation

◆ readDict()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ zeroGradientType()

◆ zeroValueType()

◆ assignable()

◆ fixesValue()

◆ coupled()

◆ constraintType()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ constraintOverride()

◆ updated()

◆ setUpdated()

◆ manipulatedMatrix()

◆ setManipulated()

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField