valuePointPatchField< Type > Class Template Reference

Foam::valuePointPatchField. More...

Inheritance diagram for valuePointPatchField< Type >:

Collaboration diagram for valuePointPatchField< Type >:

Public Member Functions
	TypeName ("value")
	Runtime type information. More...
	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...
	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...
	valuePointPatchField (const valuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...
virtual autoPtr< pointPatchField< Type > >	clone () const
	Construct and return a clone. More...
	valuePointPatchField (const valuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...
virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference. More...
label	size () const
	Return size. 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. More...
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...
virtual void	write (Ostream &) const
	Write. More...
virtual void	operator= (const valuePointPatchField< Type > &)
virtual void	operator= (const pointPatchField< Type > &)
virtual void	operator= (const Field< Type > &)
virtual void	operator= (const Type &)
virtual void	operator== (const valuePointPatchField< Type > &)
virtual void	operator== (const pointPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)
Public Member Functions inherited from pointPatchField< Type >
	TypeName ("pointPatchField")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(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 patchField<Type> 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
	Construct and return a clone. More...
virtual	~pointPatchField ()
	Destructor. More...
const objectRegistry &	db () const
	Return local objectRegistry. More...
label	size () const
	Return size. More...
const pointPatch &	patch () const
	Return patch. More...
const DimensionedField< Type, pointMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...
const Field< Type > &	internalField () const
	Return internal field reference. More...
const word &	patchType () const
	Optional patch type. More...
word &	patchType ()
	Optional patch type. More...
virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...
virtual bool	coupled () const
	Return true if this patch field is coupled. More...
bool	updated () const
	Return true if the boundary condition has already been updated. More...
tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const
	Return field created from appropriate internal field values. More...
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
	Return field created from selected internal field values. More...
tmp< Field< Type > >	patchInternalField () const
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
	Given the internal field and a patch field,. More...
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
	Given the internal field and a patch field,. More...
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...
virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements. More...
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise evaluation of the patch field (do nothing) More...
virtual void	operator+= (const pointPatchField< Type > &)
virtual void	operator+= (const Field< Type > &)
virtual void	operator+= (const Type &)
virtual void	operator-= (const pointPatchField< Type > &)
virtual void	operator-= (const Field< Type > &)
virtual void	operator-= (const Type &)
virtual void	operator*= (const pointPatchField< scalar > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const pointPatchField< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator/= (const scalar)
Public Member Functions inherited from Field< Type >
	Field ()
	Construct null. More...
	Field (const label)
	Construct given size. More...
	Field (const label, const Type &)
	Construct given size and initial value. More...
	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...
	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. More...
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...
	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...
	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...
	Field (const Field< Type > &)
	Construct as copy. More...
	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...
	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...
	Field (const tmp< Field< Type > > &)
	Construct as copy of tmp<Field> More...
	Field (Istream &)
	Construct from Istream. More...
	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...
tmp< Field< Type > >	clone () const
	Clone. More...
void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...
void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...
void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...
void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...
void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...
void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...
void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...
void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...
void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...
void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...
void	negate ()
	Negate this field. More...
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...
void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...
void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...
void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...
tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...
void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...
void	operator= (const Field< Type > &)
void	operator= (const UList< Type > &)
void	operator= (const SubField< Type > &)
void	operator= (const tmp< Field< Type > > &)
void	operator= (const Type &)
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator= (const Field< Type > &rhs)
void	operator= (const SubField< Type > &rhs)
void	operator= (const UList< Type > &rhs)
void	operator= (const tmp< Field > &rhs)
void	operator= (const Type &t)
void	operator+= (const UList< Type > &)
void	operator+= (const tmp< Field< Type > > &)
void	operator+= (const Type &)
void	operator-= (const UList< Type > &)
void	operator-= (const tmp< Field< Type > > &)
void	operator-= (const Type &)
void	operator*= (const UList< scalar > &)
void	operator*= (const tmp< Field< scalar > > &)
void	operator*= (const scalar &)
void	operator/= (const UList< scalar > &)
void	operator/= (const tmp< Field< scalar > > &)
void	operator/= (const scalar &)

Private Member Functions
void	checkFieldSize () const

Additional Inherited Members
Public Types inherited from pointPatchField< Type >
typedef pointPatch	Patch
Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...
typedef SubField< Type >	subField
	Declare type of subField. More...
Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > >	New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...
static autoPtr< pointPatchField< Type > >	New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	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 pointPatchField< Type2 > &)
	Return a pointer to a new CalculatedpointPatchField created on. More...
static const word &	calculatedType ()
	Return the type of the calculated form of pointPatchField. More...
Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return a null field. More...
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...
Static Public Attributes inherited from pointPatchField< Type >
static int	disallowGenericPointPatchField
	Debug switch to disallow the use of genericPointPatchField. More...
Static Public Attributes inherited from Field< Type >
static const char *const	typeName

Detailed Description

template<class Type>
class Foam::valuePointPatchField< Type >

Foam::valuePointPatchField.

Source files

• valuePointPatchField.H
• valuePointPatchField.C

Definition at line 49 of file valuePointPatchField.H.

Constructor & Destructor Documentation

valuePointPatchField() [1/4]

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

Construct from patch and internal field.

Definition at line 49 of file valuePointPatchField.C.

valuePointPatchField() [2/4]

valuePointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict,
		const bool	valueRequired = true
	)

Construct from patch, internal field and dictionary.

Definition at line 61 of file valuePointPatchField.C.

valuePointPatchField() [3/4]

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

Construct by mapping given patchField<Type> onto a new patch.

Definition at line 95 of file valuePointPatchField.C.

valuePointPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 109 of file valuePointPatchField.C.

Member Function Documentation

checkFieldSize()

void checkFieldSize

private

Definition at line 32 of file valuePointPatchField.C.

TypeName()

TypeName

(

"value"

)

Runtime type information.

clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented in codedFixedValuePointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, zeroFixedValuePointPatchField< Type >, fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.

Definition at line 93 of file valuePointPatchField.H.

clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Implements pointPatchField< Type >.

Reimplemented in uniformInterpolatedDisplacementPointPatchVectorField, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, waveDisplacementPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, fixedValuePointPatchField< vector >, codedFixedValuePointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, zeroFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, and fixedValuePointPatchField< Type >.

Definition at line 113 of file valuePointPatchField.H.

size()

label size ( ) const

inline

Return size.

Definition at line 133 of file valuePointPatchField.H.

autoMap()

void autoMap ( const pointPatchFieldMapper &  m )

virtual

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

Reimplemented from pointPatchField< Type >.

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

Definition at line 123 of file valuePointPatchField.C.

Referenced by oscillatingVelocityPointPatchVectorField::autoMap(), angularOscillatingVelocityPointPatchVectorField::autoMap(), angularOscillatingDisplacementPointPatchVectorField::autoMap(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::autoMap(), and sixDoFRigidBodyDisplacementPointPatchVectorField::autoMap().

Here is the caller graph for this function:

rmap()

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

virtual

Reverse map the given PointPatchField onto.

this PointPatchField

Reimplemented from pointPatchField< Type >.

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

Definition at line 133 of file valuePointPatchField.C.

Referenced by oscillatingVelocityPointPatchVectorField::rmap(), angularOscillatingVelocityPointPatchVectorField::rmap(), angularOscillatingDisplacementPointPatchVectorField::rmap(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::rmap(), and sixDoFRigidBodyDisplacementPointPatchVectorField::rmap().

Here is the caller graph for this function:

updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from pointPatchField< Type >.

Reimplemented in codedFixedValuePointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uniformInterpolatedDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, timeVaryingUniformFixedValuePointPatchField< Type >, waveDisplacementPointPatchVectorField, and oscillatingDisplacementPointPatchVectorField.

Definition at line 150 of file valuePointPatchField.C.

Referenced by oscillatingDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), uniformFixedValuePointPatchField< Type >::updateCoeffs(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

evaluate()

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

virtual

Evaluate the patch field.

Reimplemented from pointPatchField< Type >.

Reimplemented in codedFixedValuePointPatchField< Type >.

Definition at line 167 of file valuePointPatchField.C.

write()

void write ( Ostream &  os ) const

virtual

Write.

Reimplemented from pointPatchField< Type >.

Reimplemented in codedFixedValuePointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uniformInterpolatedDisplacementPointPatchVectorField, uniformFixedValuePointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, timeVaryingUniformFixedValuePointPatchField< Type >, waveDisplacementPointPatchVectorField, and oscillatingDisplacementPointPatchVectorField.

Definition at line 179 of file valuePointPatchField.C.

Referenced by uniformFixedValuePointPatchField< Type >::write().

Here is the caller graph for this function:

operator=() [1/4]

void operator= ( const valuePointPatchField< Type > &  ptf )

virtual

Definition at line 190 of file valuePointPatchField.C.

operator=() [2/4]

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

virtual

Reimplemented from pointPatchField< Type >.

Definition at line 200 of file valuePointPatchField.C.

operator=() [3/4]

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

virtual

Reimplemented from pointPatchField< Type >.

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

Definition at line 210 of file valuePointPatchField.C.

operator=() [4/4]

void operator= ( const Type &  t )

virtual

Reimplemented from pointPatchField< Type >.

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

Definition at line 220 of file valuePointPatchField.C.

operator==() [1/4]

void operator== ( const valuePointPatchField< Type > &  ptf )

virtual

Definition at line 231 of file valuePointPatchField.C.

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

Here is the caller graph for this function:

operator==() [2/4]

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

virtual

Reimplemented from pointPatchField< Type >.

Definition at line 241 of file valuePointPatchField.C.

operator==() [3/4]

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

virtual

Reimplemented from pointPatchField< Type >.

Definition at line 251 of file valuePointPatchField.C.

operator==() [4/4]

void operator== ( const Type &  t )

virtual

Reimplemented from pointPatchField< Type >.

Definition at line 261 of file valuePointPatchField.C.

---

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

• src/OpenFOAM/fields/pointPatchFields/basic/value/valuePointPatchField.H
• src/OpenFOAM/fields/pointPatchFields/basic/value/valuePointPatchField.C