genericPointPatchField< Type > Class Template Reference

A generic version of calculatedPointPatchField, useful as a fallback for handling unknown patch types. 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 > &)
 Construct from patch and internal field. 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 pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> 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 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 reset (const pointPatchField< Type > &)
 Reset the pointPatchField to the given pointPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from genericPatchField
 TypeName ("generic")
 Runtime type information. More...
 
 genericPatchField ()
 
 genericPatchField (const word &atn)
 
virtual ~genericPatchField ()
 Destructor. More...
 
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 pointPatchFieldMapper &)
 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 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 > &)=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 objectRegistrydb () const
 Return local objectRegistry. More...
 
const pointPatchpatch () 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 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...
 
template<class Type2 >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
static const wordcalculatedType ()
 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 >

A generic version of calculatedPointPatchField, useful as a fallback for handling unknown patch types.

Source files

Definition at line 52 of file genericPointPatchField.H.

Constructor & Destructor Documentation

◆ genericPointPatchField() [1/4]

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

Construct from patch and internal field.

Definition at line 33 of file genericPointPatchField.C.

References NotImplemented.

Referenced by genericPointPatchField< Type >::genericPointPatchField().

Here is the caller graph for this function:

◆ genericPointPatchField() [2/4]

◆ genericPointPatchField() [3/4]

genericPointPatchField ( const genericPointPatchField< 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 307 of file genericPointPatchField.C.

References forAllConstIter, and genericPointPatchField< Type >::genericPointPatchField().

Here is the call graph for this function:

◆ genericPointPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 392 of file genericPointPatchField.C.

References genericPointPatchField< Type >::autoMap().

Here is the call graph for this function:

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 109 of file genericPointPatchField.H.

References genericPointPatchField< Type >::autoMap(), genericPointPatchField< Type >::reset(), genericPointPatchField< Type >::rmap(), and genericPointPatchField< Type >::write().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const pointPatchFieldMapper m)
virtual

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

Used to update fields following mesh topology change

Reimplemented from pointPatchField< Type >.

Definition at line 412 of file genericPointPatchField.C.

References forAllIter, and genericPointPatchField< Type >::rmap().

Referenced by genericPointPatchField< Type >::clone(), and genericPointPatchField< Type >::genericPointPatchField().

Here is the call graph for this function:
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.

Used to reconstruct fields

Reimplemented from pointPatchField< Type >.

Definition at line 470 of file genericPointPatchField.C.

References forAllIter, and genericPointPatchField< Type >::reset().

Referenced by genericPointPatchField< Type >::autoMap(), and genericPointPatchField< Type >::clone().

Here is the call graph for this function:
Here is the caller 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 562 of file genericPointPatchField.C.

References forAllIter.

Referenced by genericPointPatchField< Type >::clone(), and genericPointPatchField< Type >::rmap().

Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from pointPatchField< Type >.

Definition at line 652 of file genericPointPatchField.C.

References forAllConstIter, and Foam::writeEntry().

Referenced by genericPointPatchField< Type >::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

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