genericPointPatchField< Type > Class Template Reference

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition. More...

Inheritance diagram for genericPointPatchField< Type >:
Collaboration diagram for genericPointPatchField< Type >:

Public Member Functions

 TypeName ("generic")
 Runtime type information. More...
 
 genericPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 genericPointPatchField (const genericPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const fieldMapper &)
 Construct by mapping given genericPointPatchField onto a new patch. More...
 
 genericPointPatchField (const genericPointPatchField< 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...
 
virtual void map (const pointPatchField< Type > &, const fieldMapper &)
 Map the given pointPatchField onto this pointPatchField. More...
 
virtual void reset (const pointPatchField< Type > &)
 Reset the pointPatchField to the given pointPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from genericFieldBase
 TypeName ("generic")
 Runtime type information. More...
 
 genericFieldBase ()
 Construct null. More...
 
 genericFieldBase (const word &actualTypeName)
 Construct from actual type name. More...
 
virtual ~genericFieldBase ()
 Destructor. More...
 
const word & actualTypeName () const
 Return the actual type name. More...
 
- Public Member Functions inherited from calculatedPointPatchField< Type >
 TypeName ("calculated")
 Runtime type information. More...
 
 calculatedPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 calculatedPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 calculatedPointPatchField (const calculatedPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const fieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 calculatedPointPatchField (const calculatedPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
- 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 fieldMapper &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 fieldMapper &)
 Construct by mapping given pointPatchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)=delete
 Disallow copy without setting internal field reference. More...
 
autoPtr< pointPatchField< Type > > clone () const
 Disallow clone without setting internal field reference. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const pointPatch &patch, const DimensionedField< Type, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~pointPatchField ()
 Destructor. More...
 
label size () const
 Return size. 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 overridesConstraint () const
 Return true if this overrides the underlying constraint type. More...
 
const objectRegistry & db () const
 Return local objectRegistry. More...
 
const pointPatch & patch () const
 Return patch. More...
 
const DimensionedField< Type, pointMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const
 Return internal field reference. 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...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected 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,. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Evaluate the patch field. More...
 
virtual void operator= (const pointPatchField< Type > &)
 
virtual void operator= (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 &)
 
template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &pf)
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef Type value_type
 
typedef pointPatch Patch
 
typedef calculatedPointPatchField< Type > Calculated
 
- 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 fieldMapper &)
 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...
 
template<class Type2 >
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 Attributes inherited from pointPatchField< Type >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. More...
 

Detailed Description

template<class Type>
class Foam::genericPointPatchField< Type >

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition.

See also
Foam::calculatedPointPatchField
Source files

Definition at line 57 of file genericPointPatchField.H.

Constructor & Destructor Documentation

◆ genericPointPatchField() [1/3]

◆ genericPointPatchField() [2/3]

genericPointPatchField ( const genericPointPatchField< Type > &  ptf,
const pointPatch &  p,
const DimensionedField< Type, pointMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given genericPointPatchField onto a new patch.

Definition at line 139 of file genericPointPatchField.C.

References MapTypeFields.

◆ genericPointPatchField() [3/3]

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

Construct as copy setting internal field reference.

Definition at line 166 of file genericPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Reimplemented from calculatedPointPatchField< Type >.

Definition at line 107 of file genericPointPatchField.H.

◆ map()

void map ( const pointPatchField< Type > &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given pointPatchField onto this pointPatchField.

Reimplemented from pointPatchField< Type >.

Definition at line 186 of file genericPointPatchField.C.

References Foam::FOR_ALL_FIELD_TYPES(), and MapTypeFields.

Here is the call graph for this function:

◆ reset()

void reset ( const pointPatchField< Type > &  ptf)
virtual

Reset the pointPatchField to the given pointPatchField.

Used for mesh to mesh mapping

Reimplemented from pointPatchField< Type >.

Definition at line 212 of file genericPointPatchField.C.

References Foam::FOR_ALL_FIELD_TYPES(), and ResetTypeFields.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented from pointPatchField< Type >.

Definition at line 237 of file genericPointPatchField.C.

References Foam::FOR_ALL_FIELD_TYPES(), forAllConstIter, Foam::writeEntry(), and WriteTypeFieldEntry.

Here is the call graph for this function:

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