OpenFOAM logo
Open Source CFD Toolkit

PointPatchField Class Template Reference

Inheritance diagram for PointPatchField:

Inheritance graph
[legend]
Collaboration diagram for PointPatchField:

Collaboration graph
[legend]
List of all members.

template<template< class > class PatchField, class PointPatch, class Type>
class Foam::PointPatchField< PatchField, PointPatch, Type >


Public Types

typedef PointPatch Patch
typedef PatchField< Type > pointPatchTypeField

Public Member Functions

 TypeName ("PointPatchField")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, pointPatchTypeField, PointPatch,(const PointPatch &p, const Field< Type > &iF),(p, iF))
 declareRunTimeSelectionTable (autoPtr, pointPatchTypeField, patchMapper,(const PointPatchField< PatchField, PointPatch, Type > &ptf, const PointPatch &p, const Field< Type > &iF, const PointPatchFieldMapper &m),(dynamic_cast< const pointPatchTypeFieldType & >(ptf), p, iF, m))
 declareRunTimeSelectionTable (autoPtr, pointPatchTypeField, dictionary,(const PointPatch &p, const Field< Type > &iF, const dictionary &dict),(p, iF, dict))
 PointPatchField (const PointPatch &, const Field< Type > &)
 Construct from patch and internal field.
 PointPatchField (const PointPatchField< PatchField, PointPatch, Type > &)
 Construct as copy.
virtual autoPtr< PatchField<
Type > > 
clone () const =0
 Construct and return a clone.
 PointPatchField (const PointPatchField< PatchField, PointPatch, Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual autoPtr< PatchField<
Type > > 
clone (const Field< Type > &iF) const =0
 Construct and return a clone setting internal field reference.
virtual ~PointPatchField ()
const objectRegistrydb () const
 Return local objectRegistry.
label size () const
 Return size.
const PointPatch & patch () const
 Return patch.
const Field< Type > & internalField () const
 Return internal field reference.
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate internal field values.
template<class Type1>
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) 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,.
template<class Type1>
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,.
virtual void autoMap (const PointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const PointPatchField< PatchField, PointPatch, Type > &, const labelList &)
 Reverse map the given PointPatchField onto.
virtual bool storesFieldData () const
 Does it store field data.
bool isPointField () const
 Does this patchField correspond to a pointTypeField.
void checkPointField () const
 Check that this patchField corresponds to a pointTypeField,.
virtual void initEvaluate (const bool=false)
 Initialise evaluation of the patch field (do nothing).
virtual void evaluate ()
 Evaluate the patch field.
virtual void updateBoundaryField ()
 Update boundary value.
virtual void initAddField () const
 Init add field to internal field.
virtual void addField (Field< Type > &) const
 Add field to internal field.
virtual tmp< labelFieldnbrColour (const labelField &cField) const
 Return neighbour colouring.
virtual void write (Ostream &) const
 Write.
virtual void operator= (const PointPatchField< PatchField, PointPatch, Type > &)
virtual void operator+= (const PointPatchField< PatchField, PointPatch, Type > &)
virtual void operator-= (const PointPatchField< PatchField, PointPatch, Type > &)
virtual void operator *= (const PointPatchField< PatchField, PointPatch, scalar > &)
virtual void operator/= (const PointPatchField< PatchField, PointPatch, 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< PatchField, PointPatch, Type > &)
virtual void operator== (const Field< Type > &)
virtual void operator== (const Type &)

Static Public Member Functions

autoPtr< PatchField< Type > > New (const word &, const PointPatch &, const Field< Type > &)
 Return a pointer to a new patchField created on freestore given.
autoPtr< PatchField< Type > > New (const PointPatchField< PatchField, PointPatch, Type > &, const PointPatch &, const Field< Type > &, const PointPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from.
autoPtr< PatchField< Type > > New (const PointPatch &, const Field< Type > &, const dictionary &)
 Return a pointer to a new patchField created on freestore.
template<class Type2>
autoPtr< PointPatchField<
PatchField, PointPatch, Type > > 
NewCalculatedType (const PointPatchField< PatchField, PointPatch, Type2 > &)
 Return a pointer to a new CalculatedPointPatchField created on.
const wordcalculatedType ()
 Return the type of the calculated for of PointPatchField.

Friends

Ostreamoperator (Ostream &, const PointPatchField< PatchField, PointPatch, Type > &)

Member Typedef Documentation

typedef PointPatch Patch
 

Definition at line 104 of file PointPatchField.H.

typedef PatchField<Type> pointPatchTypeField
 

Definition at line 105 of file PointPatchField.H.


Constructor & Destructor Documentation

PointPatchField const PointPatch &  ,
const Field< Type > & 
 

Construct from patch and internal field.

PointPatchField const PointPatchField< PatchField, PointPatch, Type > &   ) 
 

Construct as copy.

PointPatchField const PointPatchField< PatchField, PointPatch, Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.

virtual ~PointPatchField  )  [inline, virtual]
 


Member Function Documentation

virtual void addField Field< Type > &   )  const [inline, virtual]
 

Add field to internal field.

Definition at line 352 of file PointPatchField.H.

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

virtual void autoMap const PointPatchFieldMapper  )  [inline, virtual]
 

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

Definition at line 301 of file PointPatchField.H.

const word& calculatedType  )  [static]
 

Return the type of the calculated for of PointPatchField.

void checkPointField  )  const
 

Check that this patchField corresponds to a pointTypeField,.

if not abort!

virtual autoPtr<PatchField<Type> > clone const Field< Type > &  iF  )  const [pure virtual]
 

Construct and return a clone setting internal field reference.

Implemented in pointPatchField.

virtual autoPtr<PatchField<Type> > clone  )  const [pure virtual]
 

Construct and return a clone.

Implemented in pointPatchField.

const objectRegistry& db  )  const
 

Return local objectRegistry.

declareRunTimeSelectionTable autoPtr  ,
pointPatchTypeField  ,
dictionary  ,
(const PointPatch &p, const Field< Type > &iF, const dictionary &dict)  ,
(p, iF, dict) 
 

declareRunTimeSelectionTable autoPtr  ,
pointPatchTypeField  ,
patchMapper  ,
(const PointPatchField< PatchField, PointPatch, Type > &ptf, const PointPatch &p, const Field< Type > &iF, const PointPatchFieldMapper &m)  ,
(dynamic_cast< const pointPatchTypeFieldType & >(ptf), p, iF, m) 
 

declareRunTimeSelectionTable autoPtr  ,
pointPatchTypeField  ,
PointPatch  ,
(const PointPatch &p, const Field< Type > &iF)  ,
(p, iF) 
 

virtual void evaluate  )  [inline, virtual]
 

Evaluate the patch field.

Definition at line 340 of file PointPatchField.H.

virtual void initAddField  )  const [inline, virtual]
 

Init add field to internal field.

Definition at line 348 of file PointPatchField.H.

virtual void initEvaluate const   bool = false  )  [inline, virtual]
 

Initialise evaluation of the patch field (do nothing).

Definition at line 336 of file PointPatchField.H.

const Field<Type>& internalField  )  const [inline]
 

Return internal field reference.

Definition at line 255 of file PointPatchField.H.

bool isPointField  )  const
 

Does this patchField correspond to a pointTypeField.

virtual tmp<labelField> nbrColour const labelField cField  )  const [inline, virtual]
 

Return neighbour colouring.

Implements lduCoupledInterface.

Definition at line 358 of file PointPatchField.H.

autoPtr<PatchField<Type> > New const PointPatch &  ,
const Field< Type > &  ,
const dictionary
[static]
 

Return a pointer to a new patchField created on freestore.

from dictionary

autoPtr<PatchField<Type> > New const PointPatchField< PatchField, PointPatch, Type > &  ,
const PointPatch &  ,
const Field< Type > &  ,
const PointPatchFieldMapper
[static]
 

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

a given PointPatchField mapped onto a new patch

autoPtr<PatchField<Type> > New const word ,
const PointPatch &  ,
const Field< Type > & 
[static]
 

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

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

autoPtr<PointPatchField<PatchField, PointPatch, Type> > NewCalculatedType const PointPatchField< PatchField, PointPatch, Type2 > &   )  [static]
 

Return a pointer to a new CalculatedPointPatchField created on.

freestore without setting patchField values

virtual void operator *= const   scalar  )  [inline, virtual]
 

Definition at line 412 of file PointPatchField.H.

virtual void operator *= const Field< scalar > &   )  [inline, virtual]
 

Definition at line 406 of file PointPatchField.H.

virtual void operator *= const PointPatchField< PatchField, PointPatch, scalar > &   )  [inline, virtual]
 

Definition at line 391 of file PointPatchField.H.

virtual void operator+= const Type &   )  [inline, virtual]
 

Definition at line 410 of file PointPatchField.H.

virtual void operator+= const Field< Type > &   )  [inline, virtual]
 

Definition at line 403 of file PointPatchField.H.

virtual void operator+= const PointPatchField< PatchField, PointPatch, Type > &   )  [inline, virtual]
 

Definition at line 379 of file PointPatchField.H.

virtual void operator-= const Type &   )  [inline, virtual]
 

Definition at line 411 of file PointPatchField.H.

virtual void operator-= const Field< Type > &   )  [inline, virtual]
 

Definition at line 404 of file PointPatchField.H.

virtual void operator-= const PointPatchField< PatchField, PointPatch, Type > &   )  [inline, virtual]
 

Definition at line 385 of file PointPatchField.H.

virtual void operator/= const   scalar  )  [inline, virtual]
 

Definition at line 413 of file PointPatchField.H.

virtual void operator/= const Field< scalar > &   )  [inline, virtual]
 

Definition at line 407 of file PointPatchField.H.

virtual void operator/= const PointPatchField< PatchField, PointPatch, scalar > &   )  [inline, virtual]
 

Definition at line 397 of file PointPatchField.H.

virtual void operator= const Type &   )  [inline, virtual]
 

Reimplemented in pointPatchField.

Definition at line 409 of file PointPatchField.H.

virtual void operator= const Field< Type > &   )  [inline, virtual]
 

Definition at line 402 of file PointPatchField.H.

virtual void operator= const PointPatchField< PatchField, PointPatch, Type > &   )  [inline, virtual]
 

Definition at line 373 of file PointPatchField.H.

virtual void operator== const Type &   )  [inline, virtual]
 

Definition at line 425 of file PointPatchField.H.

virtual void operator== const Field< Type > &   )  [inline, virtual]
 

Definition at line 424 of file PointPatchField.H.

virtual void operator== const PointPatchField< PatchField, PointPatch, Type > &   )  [inline, virtual]
 

Definition at line 419 of file PointPatchField.H.

const PointPatch& patch  )  const [inline]
 

Return patch.

Definition at line 249 of file PointPatchField.H.

tmp<Field<Type1> > patchInternalField const Field< Type1 > &  iF  )  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.

virtual void rmap const PointPatchField< PatchField, PointPatch, Type > &  ,
const labelList
[inline, virtual]
 

Reverse map the given PointPatchField onto.

this PointPatchField

Definition at line 311 of file PointPatchField.H.

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

label size  )  const [inline]
 

Return size.

Definition at line 243 of file PointPatchField.H.

virtual bool storesFieldData  )  const [inline, virtual]
 

Does it store field data.

Definition at line 321 of file PointPatchField.H.

TypeName "PointPatchField< PatchField, PointPatch, Type >"   ) 
 

Runtime type information.

virtual void updateBoundaryField  )  [inline, virtual]
 

Update boundary value.

Definition at line 344 of file PointPatchField.H.

virtual void write Ostream  )  const [virtual]
 

Write.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const PointPatchField< PatchField, PointPatch, Type > & 
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org