pointPatchField< Type > Class Template Reference

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

Inheritance diagram for pointPatchField< Type >:

Collaboration diagram for pointPatchField< Type >:

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

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. More...
	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...
	pointPatchField (const pointPatchField< Type > &)
	Construct as copy. More...
	pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...
virtual autoPtr< pointPatchField< Type > >	clone () const =0
	Clone patch field with its own internal field reference. More...
virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const =0
	Clone patch field with an internal field reference. More...
virtual	~pointPatchField ()=default
	Destructor. More...
label	size () const
	Return the patch size. More...
const DimensionedField< Type, pointMesh > &	internalField () const noexcept
	Return const-reference to the dimensioned internal field. More...
const Field< Type > &	primitiveField () const noexcept
	Return const-reference to the internal field values. More...
template<class Type1 >
void	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing, UList< Type1 > &pfld) const
	Extract field using specified addressing. More...
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. More...
template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
	Return field created from appropriate internal field values given internal field reference. More...
tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...
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. More...
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. More...
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. More...
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. More...
virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...
virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given pointPatchField onto this pointPatchField. More...
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise evaluation of the patch field (do nothing) More...
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field, sets updated() to false. More...
virtual void	initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise the evaluation of the patch field after a local. More...
virtual void	evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field after a local operation (e.g. *=) More...
virtual void	write (Ostream &os) const
	Write. More...
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. More...
void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField. More...
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. 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
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. More...
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. More...
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. More...
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. More...
static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatch &p)
	Return a pointer to a new calculatedPointPatchField created on. More...
template<class AnyType >
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
	Return a pointer to a new calculatedPointPatchField created on. More...
Static Public Member Functions inherited from pointPatchFieldBase
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...

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. More...
Protected Member Functions inherited from pointPatchFieldBase
virtual void	readDict (const dictionary &dict)
	Read dictionary entries. More...

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 56 of file pointMVCWeight.H.

Member Typedef Documentation

Patch

typedef pointPatch Patch

The patch type for the patch field.

Definition at line 320 of file pointPatchField.H.

value_type

typedef Type value_type

The value_type for the patch field.

Definition at line 325 of file pointPatchField.H.

cmptType

typedef pTraits<Type>::cmptType cmptType

The component type for patch field.

Definition at line 330 of file pointPatchField.H.

Internal

typedef DimensionedField<Type, pointMesh> Internal

The internal field type associated with the patch field.

Definition at line 335 of file pointPatchField.H.

Calculated

typedef calculatedPointPatchField<Type> Calculated

Type for a calculated patch.

Definition at line 340 of file pointPatchField.H.

Constructor & Destructor Documentation

pointPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 30 of file pointPatchField.C.

pointPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 42 of file pointPatchField.C.

pointPatchField() [3/5]

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

Construct by mapping given patch field onto a new patch.

Definition at line 55 of file pointPatchField.C.

pointPatchField() [4/5]

pointPatchField

(

const pointPatchField< Type > &

ptf

)

Construct as copy.

Definition at line 69 of file pointPatchField.C.

pointPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 80 of file pointPatchField.C.

~pointPatchField()

virtual ~pointPatchField ( )

virtualdefault

Destructor.

Member Function Documentation

declareRunTimeSelectionTable() [1/3]

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

declareRunTimeSelectionTable() [2/3]

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]

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

clone() [1/2]

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

pure virtual

Clone patch field with its own internal field reference.

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

clone() [2/2]

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

pure virtual

Clone patch field with an internal field reference.

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

Clone()

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

inlinestatic

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

Definition at line 464 of file pointPatchField.H.

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

Here is the caller graph for this function:

New() [1/4]

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 87 of file pointPatchFieldNew.C.

New() [2/4]

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 26 of file pointPatchFieldNew.C.

New() [3/4]

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 166 of file pointPatchFieldNew.C.

New() [4/4]

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

NewCalculatedType() [1/3]

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 76 of file calculatedPointPatchField.C.

NewCalculatedType() [2/3]

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

static

Return a pointer to a new calculatedPointPatchField created on.

freestore without setting patchField values

size()

label size ( ) const

inline

Return the patch size.

Definition at line 565 of file pointPatchField.H.

internalField()

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

inlinenoexcept

Return const-reference to the dimensioned internal field.

Definition at line 573 of file pointPatchField.H.

primitiveField()

const Field<Type>& primitiveField ( ) const

inlinenoexcept

Return const-reference to the internal field values.

Definition at line 581 of file pointPatchField.H.

patchInternalField() [1/6]

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 107 of file pointPatchField.C.

Referenced by pointConstraints::setPatchFields(), and velocityDisplacementMotionSolver::solve().

Here is the caller graph for this function:

patchInternalField() [2/6]

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

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]

tmp<Field<Type1> > patchInternalField

(

const UList< Type1 > &

internalData

)

const

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

patchInternalField() [4/6]

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

(

)

const

Return field created from appropriate internal field values.

Definition at line 178 of file pointPatchField.C.

addToInternalField() [1/2]

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 187 of file pointPatchField.C.

addToInternalField() [2/2]

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 221 of file pointPatchField.C.

setInInternalField() [1/2]

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 257 of file pointPatchField.C.

setInInternalField() [2/2]

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 289 of file pointPatchField.C.

autoMap()

virtual void autoMap ( const pointPatchFieldMapper &  )

inlinevirtual

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

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

Definition at line 691 of file pointPatchField.H.

rmap()

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

inlinevirtual

Reverse map the given pointPatchField onto this pointPatchField.

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

Definition at line 700 of file pointPatchField.H.

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Sets Updated to true

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

Definition at line 299 of file pointPatchField.C.

initEvaluate()

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

inlinevirtual

Initialise evaluation of the patch field (do nothing)

Definition at line 720 of file pointPatchField.H.

evaluate()

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

virtual

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

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

Definition at line 306 of file pointPatchField.C.

initEvaluateLocal()

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

evaluateLocal()

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

inlinevirtual

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

Definition at line 749 of file pointPatchField.H.

write()

void write ( Ostream &  os ) const

virtual

Write.

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

Definition at line 93 of file pointPatchField.C.

Referenced by oscillatingDisplacementPointPatchVectorField::write(), waveDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), pointAttractionDisplacementPointPatchVectorField::write(), sixDoFRigidBodyDisplacementPointPatchVectorField::write(), edgeSlipDisplacementPointPatchVectorField::write(), lumpedPointDisplacementPointPatchVectorField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), and waveMakerPointPatchVectorField::write().

Here is the caller graph for this function:

operator=() [1/3]

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

inlinevirtual

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

Definition at line 766 of file pointPatchField.H.

operator+=() [1/3]

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

inlinevirtual

Definition at line 767 of file pointPatchField.H.

operator-=() [1/3]

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

inlinevirtual

Definition at line 768 of file pointPatchField.H.

operator*=() [1/3]

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

inlinevirtual

Definition at line 769 of file pointPatchField.H.

operator/=() [1/3]

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

inlinevirtual

Definition at line 770 of file pointPatchField.H.

operator=() [2/3]

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

inlinevirtual

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

Definition at line 772 of file pointPatchField.H.

operator+=() [2/3]

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

inlinevirtual

Definition at line 773 of file pointPatchField.H.

operator-=() [2/3]

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

inlinevirtual

Definition at line 774 of file pointPatchField.H.

operator*=() [2/3]

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

inlinevirtual

Definition at line 776 of file pointPatchField.H.

operator/=() [2/3]

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

inlinevirtual

Definition at line 777 of file pointPatchField.H.

operator=() [3/3]

virtual void operator= ( const Type &  )

inlinevirtual

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

Definition at line 779 of file pointPatchField.H.

operator+=() [3/3]

virtual void operator+= ( const Type &  )

inlinevirtual

Definition at line 780 of file pointPatchField.H.

operator-=() [3/3]

virtual void operator-= ( const Type &  )

inlinevirtual

Definition at line 781 of file pointPatchField.H.

operator*=() [3/3]

virtual void operator*= ( const scalar  )

inlinevirtual

Definition at line 782 of file pointPatchField.H.

operator/=() [3/3]

virtual void operator/= ( const scalar  )

inlinevirtual

Definition at line 783 of file pointPatchField.H.

operator==() [1/3]

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

inlinevirtual

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

Definition at line 790 of file pointPatchField.H.

operator==() [2/3]

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

inlinevirtual

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

Definition at line 791 of file pointPatchField.H.

operator==() [3/3]

virtual void operator== ( const Type &  )

inlinevirtual

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

Definition at line 792 of file pointPatchField.H.

operator!=() [1/3]

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

delete

operator!=() [2/3]

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

delete

operator!=() [3/3]

bool operator!= ( const Type &  ) const

delete

negate()

void negate ( )

inline

Negate the field inplace. Dummy placeholder for FieldField.

Definition at line 814 of file pointPatchField.H.

normalise()

void normalise ( )

inline

Normalise the field inplace. Dummy placeholder for FieldField.

Definition at line 819 of file pointPatchField.H.

NewCalculatedType() [3/3]

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

(

const pointPatchField< AnyType > &

pf

)

Definition at line 111 of file calculatedPointPatchField.C.

patchInternalField() [5/6]

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

Definition at line 151 of file pointPatchField.C.

patchInternalField() [6/6]

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

(

const UList< Type1 > &

internalData

)

const

Definition at line 166 of file pointPatchField.C.

Friends And Related Function Documentation

operator

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