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

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. Currently ignored (always false) 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 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...

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

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

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.

◆ pointPatchFieldBase() [2/5]

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

Construct from patch and patch type.

Definition at line 48 of file pointPatchFieldBase.C.

◆ pointPatchFieldBase() [3/5]

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

Construct from patch and dictionary.

Definition at line 60 of file pointPatchFieldBase.C.

References dict, and pointPatchFieldBase::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 72 of file pointPatchFieldBase.C.

◆ pointPatchFieldBase() [5/5]

pointPatchFieldBase ( const pointPatchFieldBase & rhs )

Copy construct.

Definition at line 83 of file pointPatchFieldBase.C.

◆ ~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, keyType::LITERAL, and dictionary::readIfPresent().

Referenced by pointPatchFieldBase::pointPatchFieldBase().

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 111 of file pointPatchField.H.

◆ setManipulated()

void setManipulated ( bool state )

inlineprotectednoexcept

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

Definition at line 119 of file pointPatchField.H.

◆ TypeName()

TypeName ( "pointPatchField" )

Runtime type information.

◆ emptyType()

static const word& emptyType ( )

inlinestaticnoexcept

The type name for empty patch fields.

Definition at line 175 of file pointPatchField.H.

References Foam::fieldTypes::emptyType.

◆ calculatedType()

static const word& calculatedType ( )

inlinestaticnoexcept

The type name for calculated patch fields.

Definition at line 183 of file pointPatchField.H.

References Foam::fieldTypes::calculatedType.

◆ zeroGradientType()

static const word& zeroGradientType ( )

inlinestaticnoexcept

The type name for zeroGradient patch fields.

Definition at line 191 of file pointPatchField.H.

References Foam::fieldTypes::zeroGradientType.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

True if the patch field fixes a value.

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

Definition at line 204 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 212 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 220 of file pointPatchField.H.

References word::null.

◆ db()

const Foam::objectRegistry & db ( ) const

The associated objectRegistry.

Definition at line 99 of file pointPatchFieldBase.C.

References objectRegistry::thisDb().

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

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 236 of file pointPatchField.H.

Referenced by pointPatchField< vector >::NewCalculatedType(), lumpedPointDisplacementPointPatchVectorField::points0(), pointPatchField< vector >::size(), waveDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), 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 244 of file pointPatchField.H.

◆ patchType() [2/2]

word& patchType ( )

inlinenoexcept

The optional patch type.

Definition at line 252 of file pointPatchField.H.

◆ updated()

bool updated ( ) const

inlinenoexcept

True if the boundary condition has already been updated.

Definition at line 263 of file pointPatchField.H.

Here is the caller graph for this function:

◆ manipulatedMatrix()

bool manipulatedMatrix ( ) const

inlinenoexcept

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

Definition at line 272 of file pointPatchField.H.

◆ 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, 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 pointPatchField.

Definition at line 128 of file pointPatchField.H.

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

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

◆ setUpdated()

◆ setManipulated()

◆ TypeName()

◆ emptyType()

◆ calculatedType()

◆ zeroGradientType()

◆ fixesValue()

◆ coupled()

◆ constraintType()

◆ db()

◆ patch()

◆ patchType() [1/2]

◆ patchType() [2/2]

◆ updated()

◆ manipulatedMatrix()

◆ checkPatch()

Member Data Documentation

◆ disallowGenericPatchField