pointPatchField< Type > Class Template Reference

Abstract base class for point-mesh patch fields. More...

#include <pointPatchField.H>

Inheritance diagram for pointPatchField< Type >:

Collaboration diagram for pointPatchField< Type >:

Public Types
typedef pointPatch	Patch
	The patch type for the patch field.
typedef Type	value_type
	The value_type for the patch field.
typedef pTraits< Type >::cmptType	cmptType
	The component type for patch field.
typedef DimensionedField< Type, pointMesh >	Internal
	The internal field type associated with the patch field.
typedef calculatedPointPatchField< Type >	Calculated
	Type for a calculated patch.

Public Member Functions
	declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field.
	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	pointPatchField (const pointPatchField< Type > &pfld, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const Type &value)
	Copy construct onto a new patch with (unused) value.
	pointPatchField (const pointPatchField< Type > &pfld, const DimensionedField< Type, pointMesh > &iF)
	Copy construct with internal field reference.
	pointPatchField (const pointPatchField< Type > &pfld)
	Copy construct.
virtual autoPtr< pointPatchField< Type > >	clone () const =0
	Clone patch field with its own internal field reference.
virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const =0
	Clone patch field with an internal field reference.
virtual	~pointPatchField ()=default
	Destructor.
label	size () const noexcept
	Return the patch size.
const DimensionedField< Type, pointMesh > &	internalField () const noexcept
	Return const-reference to the dimensioned internal field.
const Field< Type > &	primitiveField () const noexcept
	Return const-reference to the internal field values.
template<class Type1>
void	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing, UList< Type1 > &pfld) const
	Extract field using specified addressing.
template<class Type1>
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
	Return field created from selected internal field values given internal field reference.
template<class Type1>
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
	Return field created from appropriate internal field values given internal field reference.
tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values.
template<class Type1>
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, add the patch field to the internal field.
template<class Type1>
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
	Given the internal field and a patch field, add selected elements of the patch field to the internal field.
template<class Type1>
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
	Given the internal field and a patch field, set the patch field in the internal field.
template<class Type1>
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, set the patch field in the internal field.
virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given pointPatchField onto this pointPatchField.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise evaluation of the patch field (do nothing).
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field, sets updated() to false.
virtual void	initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise the evaluation of the patch field after a local operation.
virtual void	evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field after a local operation (e.g. *=).
virtual void	write (Ostream &os) const
	Write.
virtual void	operator= (const pointPatchField< Type > &)
virtual void	operator+= (const pointPatchField< Type > &)
virtual void	operator-= (const pointPatchField< Type > &)
virtual void	operator*= (const pointPatchField< scalar > &)
virtual void	operator/= (const pointPatchField< scalar > &)
virtual void	operator= (const Field< Type > &)
virtual void	operator+= (const Field< Type > &)
virtual void	operator-= (const Field< Type > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator= (const Type &)
virtual void	operator+= (const Type &)
virtual void	operator-= (const Type &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const scalar)
virtual void	operator== (const pointPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)
bool	operator!= (const pointPatchField< Type > &) const =delete
bool	operator!= (const Field< Type > &) const =delete
bool	operator!= (const Type &) const =delete
void	negate ()
	Negate the field inplace. Dummy placeholder for FieldField.
void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField.
template<class AnyType>
Foam::autoPtr< Foam::pointPatchField< Type > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
template<class Type1>
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
template<class Type1>
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
Public Member Functions inherited from pointPatchFieldBase
	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
template<class DerivedPatchField, class... Args>
static autoPtr< pointPatchField< Type > >	Clone (const DerivedPatchField &pf, Args &&... args)
	Clone a patch field, optionally with internal field reference etc.
static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given.
static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given.
static autoPtr< pointPatchField< Type > >	New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from.
static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore.
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatch &p)
	Return a pointer to a new calculatedPointPatchField created on.
template<class AnyType>
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
	Return a pointer to a new calculatedPointPatchField created on.
Static Public Member Functions inherited from pointPatchFieldBase
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.

Friends
Ostream &	operator<< (Ostream &, const pointPatchField< Type > &)

Additional Inherited Members
Static Public Attributes inherited from pointPatchFieldBase
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic pointPatchField.
Protected Member Functions inherited from pointPatchFieldBase
virtual void	readDict (const dictionary &dict)
	Read dictionary entries.

Detailed Description

template<class Type>
class Foam::pointPatchField< Type >

Abstract base class for point-mesh patch fields.

The base-field does not store values as they are part of the "internal field". There are derived classes to store constraint values e.g. fixedValuePointPatchField derived from the generic valuePointPatchField which ensures the values in the "internal field" are reset to the fixed-values by applying the stored values.

Source files

• pointPatchField.H
• pointPatchField.C
• pointPatchFieldNew.C

Definition at line 317 of file pointPatchField.H.

Member Typedef Documentation

Patch

template<class Type>

typedef pointPatch Patch

The patch type for the patch field.

Definition at line 328 of file pointPatchField.H.

value_type

template<class Type>

typedef Type value_type

The value_type for the patch field.

Definition at line 333 of file pointPatchField.H.

cmptType

template<class Type>

typedef pTraits<Type>::cmptType cmptType

The component type for patch field.

Definition at line 338 of file pointPatchField.H.

Internal

template<class Type>

typedef DimensionedField<Type, pointMesh> Internal

The internal field type associated with the patch field.

Definition at line 343 of file pointPatchField.H.

Calculated

template<class Type>

typedef calculatedPointPatchField<Type> Calculated

Type for a calculated patch.

Definition at line 348 of file pointPatchField.H.

Constructor & Destructor Documentation

pointPatchField() [1/6]

template<class Type>

pointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF )

Construct from patch and internal field.

Definition at line 29 of file pointPatchField.C.

References p, and pointPatchFieldBase::pointPatchFieldBase().

Referenced by basicSymmetryPointPatchField< Type >::basicSymmetryPointPatchField(), basicSymmetryPointPatchField< Type >::basicSymmetryPointPatchField(), basicSymmetryPointPatchField< Type >::basicSymmetryPointPatchField(), basicSymmetryPointPatchField< Type >::basicSymmetryPointPatchField(), calculatedPointPatchField< Type >::calculatedPointPatchField(), calculatedPointPatchField< Type >::calculatedPointPatchField(), calculatedPointPatchField< Type >::calculatedPointPatchField(), calculatedPointPatchField< Type >::calculatedPointPatchField(), coupledPointPatchField< Type >::coupledPointPatchField(), coupledPointPatchField< Type >::coupledPointPatchField(), coupledPointPatchField< Type >::coupledPointPatchField(), coupledPointPatchField< Type >::coupledPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), New(), valuePointPatchField< Type >::operator!=(), valuePointPatchField< Type >::operator=(), valuePointPatchField< Type >::operator==(), pointPatchField(), pointPatchField(), pointPatchField(), valuePointPatchField< Type >::rmap(), valuePointPatchField< Type >::valuePointPatchField(), valuePointPatchField< Type >::valuePointPatchField(), valuePointPatchField< Type >::valuePointPatchField(), valuePointPatchField< Type >::valuePointPatchField(), valuePointPatchField< Type >::valuePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), zeroGradientPointPatchField< Type >::zeroGradientPointPatchField(), zeroGradientPointPatchField< Type >::zeroGradientPointPatchField(), zeroGradientPointPatchField< Type >::zeroGradientPointPatchField(), and zeroGradientPointPatchField< Type >::zeroGradientPointPatchField().

Here is the call graph for this function:

Here is the caller graph for this function:

pointPatchField() [2/6]

template<class Type>

pointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 41 of file pointPatchField.C.

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

Here is the call graph for this function:

pointPatchField() [3/6]

template<class Type>

pointPatchField	(	const pointPatchField< Type > &	pfld,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const pointPatchFieldMapper &	)

Construct by mapping given patch field onto a new patch.

Definition at line 54 of file pointPatchField.C.

References p, pointPatchField(), and pointPatchFieldBase::pointPatchFieldBase().

Here is the call graph for this function:

pointPatchField() [4/6]

template<class Type>

pointPatchField	(	const pointPatchField< Type > &	pfld,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const Type &	value )

Copy construct onto a new patch with (unused) value.

Definition at line 68 of file pointPatchField.C.

References p, pointPatchField(), and pointPatchFieldBase::pointPatchFieldBase().

Here is the call graph for this function:

pointPatchField() [5/6]

template<class Type>

pointPatchField	(	const pointPatchField< Type > &	pfld,
		const DimensionedField< Type, pointMesh > &	iF )

Copy construct with internal field reference.

Definition at line 82 of file pointPatchField.C.

References pointPatchField(), and pointPatchFieldBase::pointPatchFieldBase().

Here is the call graph for this function:

pointPatchField() [6/6]

template<class Type>

pointPatchField ( const pointPatchField< Type > & pfld )

inline

Copy construct.

Definition at line 460 of file pointPatchField.H.

~pointPatchField()

template<class Type>

virtual ~pointPatchField ( )

virtualdefault

Destructor.

Member Function Documentation

declareRunTimeSelectionTable() [1/3]

template<class Type>

declareRunTimeSelectionTable	(	autoPtr	,
		pointPatchField< Type >	,
		patch	,
		(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)	,
		(p, iF)	)

declareRunTimeSelectionTable() [2/3]

template<class Type>

declareRunTimeSelectionTable	(	autoPtr	,
		pointPatchField< Type >	,
		patchMapper	,
		(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m)	,
		(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m)	)

declareRunTimeSelectionTable() [3/3]

template<class Type>

declareRunTimeSelectionTable	(	autoPtr	,
		pointPatchField< Type >	,
		dictionary	,
		(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict)	,
		(p, iF, dict)	)

clone() [1/2]

template<class Type>

virtual autoPtr< pointPatchField< Type > > clone ( ) const

pure virtual

Clone patch field with its own internal field reference.

Implemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, basicSymmetryPointPatchField< Type >, calculatedPointPatchField< Type >, codedFixedValuePointPatchField< Type >, coupledPointPatchField< Type >, cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, cyclicPointPatchField< Type >, cyclicSlipPointPatchField< Type >, edgeSlipDisplacementPointPatchVectorField, emptyPointPatchField< Type >, exprValuePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, fixedValuePointPatchField< Type >, fixedValuePointPatchField< vector >, genericPointPatchField< Type >, lumpedPointDisplacementPointPatchVectorField, nonuniformTransformCyclicPointPatchField< Type >, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, pointAttractionDisplacementPointPatchVectorField, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, slipPointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, symmetryPlanePointPatchField< Type >, symmetryPointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, waveDisplacementPointPatchVectorField, waveMakerPointPatchVectorField, wedgePointPatchField< Type >, zeroGradientPointPatchField< Type >, and zeroValuePointPatchField< Type >.

clone() [2/2]

template<class Type>

virtual autoPtr< pointPatchField< Type > > clone ( const DimensionedField< Type, pointMesh > & iF ) const

pure virtual

Clone patch field with an internal field reference.

Implemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, basicSymmetryPointPatchField< Type >, calculatedPointPatchField< Type >, codedFixedValuePointPatchField< Type >, coupledPointPatchField< Type >, cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, cyclicPointPatchField< Type >, cyclicSlipPointPatchField< Type >, edgeSlipDisplacementPointPatchVectorField, emptyPointPatchField< Type >, exprValuePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, fixedValuePointPatchField< Type >, genericPointPatchField< Type >, lumpedPointDisplacementPointPatchVectorField, nonuniformTransformCyclicPointPatchField< Type >, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, pointAttractionDisplacementPointPatchVectorField, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, slipPointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, symmetryPlanePointPatchField< Type >, symmetryPointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, waveDisplacementPointPatchVectorField, waveMakerPointPatchVectorField, wedgePointPatchField< Type >, zeroGradientPointPatchField< Type >, and zeroValuePointPatchField< Type >.

Clone()

template<class Type>

template<class DerivedPatchField, class... Args>

autoPtr< pointPatchField< Type > > Clone ( const DerivedPatchField & pf, Args &&... args )

inlinestatic

Clone a patch field, optionally with internal field reference etc.

Definition at line 486 of file pointPatchField.H.

Referenced by angularOscillatingDisplacementPointPatchVectorField::clone(), angularOscillatingDisplacementPointPatchVectorField::clone(), angularOscillatingVelocityPointPatchVectorField::clone(), angularOscillatingVelocityPointPatchVectorField::clone(), basicSymmetryPointPatchField< Type >::clone(), basicSymmetryPointPatchField< Type >::clone(), calculatedPointPatchField< Type >::clone(), calculatedPointPatchField< Type >::clone(), codedFixedValuePointPatchField< Type >::clone(), codedFixedValuePointPatchField< Type >::clone(), cyclicACMIPointPatchField< Type >::clone(), cyclicACMIPointPatchField< Type >::clone(), cyclicAMIPointPatchField< Type >::clone(), cyclicAMIPointPatchField< Type >::clone(), cyclicPointPatchField< Type >::clone(), cyclicPointPatchField< Type >::clone(), cyclicSlipPointPatchField< Type >::clone(), cyclicSlipPointPatchField< Type >::clone(), emptyPointPatchField< Type >::clone(), emptyPointPatchField< Type >::clone(), exprValuePointPatchField< Type >::clone(), exprValuePointPatchField< Type >::clone(), fixedNormalSlipPointPatchField< Type >::clone(), fixedNormalSlipPointPatchField< Type >::clone(), fixedValuePointPatchField< Type >::clone(), fixedValuePointPatchField< Type >::clone(), genericPointPatchField< Type >::clone(), genericPointPatchField< Type >::clone(), lumpedPointDisplacementPointPatchVectorField::clone(), lumpedPointDisplacementPointPatchVectorField::clone(), nonuniformTransformCyclicPointPatchField< Type >::clone(), nonuniformTransformCyclicPointPatchField< Type >::clone(), oscillatingDisplacementPointPatchVectorField::clone(), oscillatingDisplacementPointPatchVectorField::clone(), oscillatingVelocityPointPatchVectorField::clone(), oscillatingVelocityPointPatchVectorField::clone(), processorCyclicPointPatchField< Type >::clone(), processorCyclicPointPatchField< Type >::clone(), processorPointPatchField< Type >::clone(), processorPointPatchField< Type >::clone(), sixDoFRigidBodyDisplacementPointPatchVectorField::clone(), sixDoFRigidBodyDisplacementPointPatchVectorField::clone(), slipPointPatchField< Type >::clone(), slipPointPatchField< Type >::clone(), solidBodyMotionDisplacementPointPatchVectorField::clone(), solidBodyMotionDisplacementPointPatchVectorField::clone(), surfaceDisplacementPointPatchVectorField::clone(), surfaceDisplacementPointPatchVectorField::clone(), surfaceSlipDisplacementPointPatchVectorField::clone(), surfaceSlipDisplacementPointPatchVectorField::clone(), symmetryPlanePointPatchField< Type >::clone(), symmetryPlanePointPatchField< Type >::clone(), symmetryPointPatchField< Type >::clone(), symmetryPointPatchField< Type >::clone(), timeVaryingMappedFixedValuePointPatchField< Type >::clone(), timeVaryingMappedFixedValuePointPatchField< Type >::clone(), timeVaryingUniformFixedValuePointPatchField< Type >::clone(), timeVaryingUniformFixedValuePointPatchField< Type >::clone(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::clone(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::clone(), uniformFixedValuePointPatchField< Type >::clone(), uniformFixedValuePointPatchField< Type >::clone(), uniformInterpolatedDisplacementPointPatchVectorField::clone(), uniformInterpolatedDisplacementPointPatchVectorField::clone(), valuePointPatchField< Type >::clone(), valuePointPatchField< Type >::clone(), waveDisplacementPointPatchVectorField::clone(), waveDisplacementPointPatchVectorField::clone(), waveMakerPointPatchVectorField::clone(), waveMakerPointPatchVectorField::clone(), wedgePointPatchField< Type >::clone(), wedgePointPatchField< Type >::clone(), zeroGradientPointPatchField< Type >::clone(), zeroGradientPointPatchField< Type >::clone(), zeroValuePointPatchField< Type >::clone(), and zeroValuePointPatchField< Type >::clone().

New() [1/4]

template<class Type>

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const word & patchFieldType, const pointPatch & p, const DimensionedField< Type, pointMesh > & iF )

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

Definition at line 86 of file pointPatchFieldNew.C.

References New(), word::null, and p.

Referenced by fvMeshSubset::interpolate(), New(), and codedFixedValuePointPatchField< Type >::redirectPatchField().

Here is the call graph for this function:

Here is the caller graph for this function:

New() [2/4]

template<class Type>

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const word & patchFieldType, const word & actualPatchType, const pointPatch & p, const DimensionedField< Type, pointMesh > & iF )

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values). Allows override of constraint type

Definition at line 25 of file pointPatchFieldNew.C.

References pointPatchFieldBase::constraintType(), DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, FatalErrorInLookup, p, and autoPtr< T >::ref().

Here is the call graph for this function:

New() [3/4]

template<class Type>

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const pointPatchField< Type > & ptf, const pointPatch & p, const DimensionedField< Type, pointMesh > & iF, const pointPatchFieldMapper & pfMapper )

static

Return a pointer to a new patchField created on freestore from.

a given pointPatchField mapped onto a new patch

Definition at line 165 of file pointPatchFieldNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, p, and pointPatchField().

Here is the call graph for this function:

New() [4/4]

template<class Type>

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const pointPatch & p, const DimensionedField< Type, pointMesh > & iF, const dictionary & dict )

static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 98 of file pointPatchFieldNew.C.

References pointPatchFieldBase::constraintType(), DebugInFunction, dict, pointPatchFieldBase::disallowGenericPatchField, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, keyType::LITERAL, Foam::nl, and p.

Here is the call graph for this function:

NewCalculatedType() [1/3]

template<class Type>

Foam::autoPtr< Foam::pointPatchField< Type > > NewCalculatedType ( const pointPatch & p )

static

Return a pointer to a new calculatedPointPatchField created on.

freestore without setting patchField values

Definition at line 75 of file calculatedPointPatchField.C.

References DimensionedField< Type, GeoMesh >::null(), and p.

Here is the call graph for this function:

NewCalculatedType() [2/3]

template<class Type>

template<class AnyType>

autoPtr< pointPatchField< Type > > NewCalculatedType ( const pointPatchField< AnyType > & pf )

static

Return a pointer to a new calculatedPointPatchField created on.

freestore without setting patchField values

size()

template<class Type>

label size ( ) const

inlinenoexcept

Return the patch size.

Definition at line 588 of file pointPatchField.H.

Referenced by addToInternalField(), addToInternalField(), genericPointPatchField< Type >::genericPointPatchField(), processorCyclicPointPatchField< Type >::initSwapAddSeparated(), patchInternalField(), setInInternalField(), and processorCyclicPointPatchField< Type >::swapAddSeparated().

Here is the caller graph for this function:

internalField()

template<class Type>

const DimensionedField< Type, pointMesh > & internalField ( ) const

inlinenoexcept

Return const-reference to the dimensioned internal field.

Definition at line 596 of file pointPatchField.H.

Referenced by fixedValuePointPatchField< Type >::fixedValuePointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), codedFixedValuePointPatchField< Type >::redirectPatchField(), cyclicACMIPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), cyclicPointPatchField< Type >::swapAddSeparated(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), timeVaryingMappedFixedValuePointPatchField< Type >::write(), and zeroValuePointPatchField< Type >::zeroValuePointPatchField().

Here is the caller graph for this function:

primitiveField()

template<class Type>

const Field< Type > & primitiveField ( ) const

inlinenoexcept

Return const-reference to the internal field values.

Definition at line 604 of file pointPatchField.H.

Referenced by addToInternalField(), addToInternalField(), basicSymmetryPointPatchField< Type >::evaluate(), cyclicSlipPointPatchField< Type >::evaluate(), fixedNormalSlipPointPatchField< Type >::evaluate(), nonuniformTransformCyclicPointPatchField< Type >::evaluate(), symmetryPlanePointPatchField< Type >::evaluate(), valuePointPatchField< Type >::evaluate(), wedgePointPatchField< Type >::evaluate(), patchInternalField(), patchInternalField(), setInInternalField(), and valuePointPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

patchInternalField() [1/6]

template<class Type>

template<class Type1>

void patchInternalField	(	const UList< Type1 > &	internalData,
		const labelUList &	addressing,
		UList< Type1 > &	pfld ) const

Extract field using specified addressing.

Parameters

	internalData	The internal field to extract from
	addressing	Addressing (mesh-points) into internal field
[out]	pfld	The extracted patch field. Should normally be sized according to the patch size(), which can be smaller than the addressing size

Definition at line 109 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, Foam::nl, primitiveField(), size(), and UList< T >::size().

Referenced by basicSymmetryPointPatchField< Type >::evaluate(), cyclicSlipPointPatchField< Type >::evaluate(), fixedNormalSlipPointPatchField< Type >::evaluate(), nonuniformTransformCyclicPointPatchField< Type >::evaluate(), symmetryPlanePointPatchField< Type >::evaluate(), wedgePointPatchField< Type >::evaluate(), processorCyclicPointPatchField< Type >::initSwapAddSeparated(), patchInternalField(), pointConstraints::setPatchFields(), velocityDisplacementMotionSolver::solve(), cyclicACMIPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), and cyclicPointPatchField< Type >::swapAddSeparated().

Here is the call graph for this function:

Here is the caller graph for this function:

patchInternalField() [2/6]

template<class Type>

template<class Type1>

tmp< Field< Type1 > > patchInternalField ( const UList< Type1 > & internalData, const labelUList & addressing ) const

nodiscard

Return field created from selected internal field values given internal field reference.

Parameters

internalData	The internal field to extract from
addressing	Addressing (mesh-points) into internal field

patchInternalField() [3/6]

template<class Type>

template<class Type1>

tmp< Field< Type1 > > patchInternalField ( const UList< Type1 > & internalData ) const

nodiscard

Return field created from appropriate internal field values given internal field reference.

patchInternalField() [4/6]

template<class Type>

Foam::tmp< Foam::Field< Type > > patchInternalField

(

)

const

Return field created from appropriate internal field values.

Definition at line 181 of file pointPatchField.C.

References patchInternalField(), and primitiveField().

Here is the call graph for this function:

addToInternalField() [1/2]

template<class Type>

template<class Type1>

void addToInternalField	(	Field< Type1 > &	iF,
		const Field< Type1 > &	pF ) const

Given the internal field and a patch field, add the patch field to the internal field.

Definition at line 189 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, forAll, Foam::nl, pointPatchFieldBase::patch(), primitiveField(), size(), and UList< T >::size().

Referenced by cyclicACMIPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), cyclicPointPatchField< Type >::swapAddSeparated(), and processorCyclicPointPatchField< Type >::swapAddSeparated().

Here is the call graph for this function:

Here is the caller graph for this function:

addToInternalField() [2/2]

template<class Type>

template<class Type1>

void addToInternalField	(	Field< Type1 > &	iF,
		const Field< Type1 > &	pF,
		const labelUList &	points ) const

Given the internal field and a patch field, add selected elements of the patch field to the internal field.

Definition at line 223 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, forAll, Foam::nl, pointPatchFieldBase::patch(), points, primitiveField(), size(), and UList< T >::size().

Here is the call graph for this function:

setInInternalField() [1/2]

template<class Type>

template<class Type1>

void setInInternalField	(	Field< Type1 > &	iF,
		const Field< Type1 > &	pF,
		const labelUList &	meshPoints ) const

Given the internal field and a patch field, set the patch field in the internal field.

Definition at line 259 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, forAll, Foam::nl, primitiveField(), size(), and UList< T >::size().

Referenced by basicSymmetryPointPatchField< Type >::evaluate(), cyclicSlipPointPatchField< Type >::evaluate(), fixedNormalSlipPointPatchField< Type >::evaluate(), nonuniformTransformCyclicPointPatchField< Type >::evaluate(), symmetryPlanePointPatchField< Type >::evaluate(), valuePointPatchField< Type >::evaluate(), wedgePointPatchField< Type >::evaluate(), setInInternalField(), and valuePointPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

setInInternalField() [2/2]

template<class Type>

template<class Type1>

void setInInternalField	(	Field< Type1 > &	iF,
		const Field< Type1 > &	pF ) const

Given the internal field and a patch field, set the patch field in the internal field.

Definition at line 291 of file pointPatchField.C.

References pointPatchFieldBase::patch(), and setInInternalField().

Here is the call graph for this function:

autoMap()

template<class Type>

virtual void autoMap ( const pointPatchFieldMapper & )

inlinevirtual

Map (and resize as needed) from self given a mapping object.

Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, oscillatingVelocityPointPatchVectorField, sixDoFRigidBodyDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, valuePointPatchField< Type >, and valuePointPatchField< vector >.

Definition at line 713 of file pointPatchField.H.

rmap()

template<class Type>

virtual void rmap ( const pointPatchField< Type > & , const labelList &  )

inlinevirtual

Reverse map the given pointPatchField onto this pointPatchField.

Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, oscillatingVelocityPointPatchVectorField, sixDoFRigidBodyDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, and valuePointPatchField< Type >.

Definition at line 722 of file pointPatchField.H.

updateCoeffs()

template<class Type>

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Sets Updated to true

Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, codedFixedValuePointPatchField< Type >, edgeSlipDisplacementPointPatchVectorField, exprValuePointPatchField< Type >, lumpedPointDisplacementPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, pointAttractionDisplacementPointPatchVectorField, sixDoFRigidBodyDisplacementPointPatchVectorField, surfaceSlipDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, waveDisplacementPointPatchVectorField, and waveMakerPointPatchVectorField.

Definition at line 302 of file pointPatchField.C.

References pointPatchFieldBase::setUpdated().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initEvaluate()

template<class Type>

virtual void initEvaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::buffered )

inlinevirtual

Initialise evaluation of the patch field (do nothing).

Definition at line 742 of file pointPatchField.H.

evaluate()

template<class Type>

void evaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::buffered )

virtual

Evaluate the patch field, sets updated() to false.

Reimplemented in basicSymmetryPointPatchField< Type >, codedFixedValuePointPatchField< Type >, coupledPointPatchField< Type >, cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, cyclicPointPatchField< Type >, cyclicSlipPointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, nonuniformTransformCyclicPointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, symmetryPlanePointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, and wedgePointPatchField< Type >.

Definition at line 309 of file pointPatchField.C.

References pointPatchFieldBase::setManipulated(), pointPatchFieldBase::setUpdated(), updateCoeffs(), and pointPatchFieldBase::updated().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initEvaluateLocal()

template<class Type>

virtual void initEvaluateLocal ( const Pstream::commsTypes commsType = Pstream::commsTypes::buffered )

inlinevirtual

Initialise the evaluation of the patch field after a local operation.

Definition at line 759 of file pointPatchField.H.

evaluateLocal()

template<class Type>

virtual void evaluateLocal ( const Pstream::commsTypes commsType = Pstream::commsTypes::buffered )

inlinevirtual

Evaluate the patch field after a local operation (e.g. *=).

Definition at line 768 of file pointPatchField.H.

write()

template<class Type>

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, codedFixedValuePointPatchField< Type >, edgeSlipDisplacementPointPatchVectorField, exprValuePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, genericPointPatchField< Type >, lumpedPointDisplacementPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, pointAttractionDisplacementPointPatchVectorField, sixDoFRigidBodyDisplacementPointPatchVectorField, surfaceSlipDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, waveDisplacementPointPatchVectorField, waveMakerPointPatchVectorField, and zeroValuePointPatchField< Type >.

Definition at line 96 of file pointPatchField.C.

References os(), pointPatchFieldBase::patchType(), and Foam::type().

Referenced by angularOscillatingDisplacementPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), edgeSlipDisplacementPointPatchVectorField::write(), fixedNormalSlipPointPatchField< Type >::write(), lumpedPointDisplacementPointPatchVectorField::write(), oscillatingDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), pointAttractionDisplacementPointPatchVectorField::write(), sixDoFRigidBodyDisplacementPointPatchVectorField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), valuePointPatchField< Type >::write(), waveDisplacementPointPatchVectorField::write(), waveMakerPointPatchVectorField::write(), and zeroValuePointPatchField< Type >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/3]

template<class Type>

virtual void operator= ( const pointPatchField< Type > & )

inlinevirtual

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

Definition at line 785 of file pointPatchField.H.

operator+=() [1/3]

template<class Type>

virtual void operator+= ( const pointPatchField< Type > & )

inlinevirtual

Definition at line 786 of file pointPatchField.H.

operator-=() [1/3]

template<class Type>

virtual void operator-= ( const pointPatchField< Type > & )

inlinevirtual

Definition at line 787 of file pointPatchField.H.

operator*=() [1/3]

template<class Type>

virtual void operator*= ( const pointPatchField< scalar > & )

inlinevirtual

Definition at line 788 of file pointPatchField.H.

operator/=() [1/3]

template<class Type>

virtual void operator/= ( const pointPatchField< scalar > & )

inlinevirtual

Definition at line 789 of file pointPatchField.H.

operator=() [2/3]

template<class Type>

virtual void operator= ( const Field< Type > & )

inlinevirtual

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

Definition at line 791 of file pointPatchField.H.

operator+=() [2/3]

template<class Type>

virtual void operator+= ( const Field< Type > & )

inlinevirtual

Definition at line 792 of file pointPatchField.H.

operator-=() [2/3]

template<class Type>

virtual void operator-= ( const Field< Type > & )

inlinevirtual

Definition at line 793 of file pointPatchField.H.

operator*=() [2/3]

template<class Type>

virtual void operator*= ( const Field< scalar > & )

inlinevirtual

Definition at line 795 of file pointPatchField.H.

operator/=() [2/3]

template<class Type>

virtual void operator/= ( const Field< scalar > & )

inlinevirtual

Definition at line 796 of file pointPatchField.H.

operator=() [3/3]

template<class Type>

virtual void operator= ( const Type & )

inlinevirtual

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

Definition at line 798 of file pointPatchField.H.

operator+=() [3/3]

template<class Type>

virtual void operator+= ( const Type & )

inlinevirtual

Definition at line 799 of file pointPatchField.H.

operator-=() [3/3]

template<class Type>

virtual void operator-= ( const Type & )

inlinevirtual

Definition at line 800 of file pointPatchField.H.

operator*=() [3/3]

template<class Type>

virtual void operator*= ( const scalar )

inlinevirtual

Definition at line 801 of file pointPatchField.H.

operator/=() [3/3]

template<class Type>

virtual void operator/= ( const scalar )

inlinevirtual

Definition at line 802 of file pointPatchField.H.

operator==() [1/3]

template<class Type>

virtual void operator== ( const pointPatchField< Type > & )

inlinevirtual

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

Definition at line 809 of file pointPatchField.H.

operator==() [2/3]

template<class Type>

virtual void operator== ( const Field< Type > & )

inlinevirtual

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

Definition at line 810 of file pointPatchField.H.

operator==() [3/3]

template<class Type>

virtual void operator== ( const Type & )

inlinevirtual

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

Definition at line 811 of file pointPatchField.H.

operator!=() [1/3]

template<class Type>

bool operator!= ( const pointPatchField< Type > & ) const

delete

operator!=() [2/3]

template<class Type>

bool operator!= ( const Field< Type > & ) const

delete

operator!=() [3/3]

template<class Type>

bool operator!= ( const Type & ) const

delete

negate()

template<class Type>

void negate ( )

inline

Negate the field inplace. Dummy placeholder for FieldField.

Definition at line 833 of file pointPatchField.H.

normalise()

template<class Type>

void normalise ( )

inline

Normalise the field inplace. Dummy placeholder for FieldField.

Definition at line 838 of file pointPatchField.H.

NewCalculatedType() [3/3]

template<class Type>

template<class AnyType>

Foam::autoPtr< Foam::pointPatchField< Type > > NewCalculatedType

(

const pointPatchField< AnyType > &

pf

)

Definition at line 110 of file calculatedPointPatchField.C.

patchInternalField() [5/6]

template<class Type>

template<class Type1>

Foam::tmp< Foam::Field< Type1 > > patchInternalField	(	const UList< Type1 > &	internalData,
		const labelUList &	addressing ) const

Definition at line 153 of file pointPatchField.C.

patchInternalField() [6/6]

template<class Type>

template<class Type1>

Foam::tmp< Foam::Field< Type1 > > patchInternalField

(

const UList< Type1 > &

internalData

)

const

Definition at line 168 of file pointPatchField.C.

Friends And Related Symbol Documentation

operator<<

template<class Type>

Ostream & operator<< ( Ostream & , const pointPatchField< Type > &  )

friend

---

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

• src/finiteVolume/interpolation/interpolation/interpolationPointMVC/pointMVCWeight.H
• src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchField.H
• src/OpenFOAM/fields/pointPatchFields/basic/calculated/calculatedPointPatchField.C
• src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchField.C
• src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointPatchFieldNew.C