Base class for lagrangian averaging methods. More...

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

Public Member Functions

 TypeName ("averagingMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh))
 Declare runtime constructor selection table. More...
 
 AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size)
 Constructors. More...
 
 AveragingMethod (const AveragingMethod< Type > &am)
 Construct a copy. More...
 
virtual autoPtr
< AveragingMethod< Type > > 
clone () const =0
 Construct and return a clone. More...
 
virtual ~AveragingMethod ()
 Destructor. More...
 
virtual void add (const point position, const tetIndices &tetIs, const Type &value)=0
 Member Functions. More...
 
virtual Type interpolate (const point position, const tetIndices &tetIs) const =0
 Interpolate. More...
 
virtual TypeGrad interpolateGrad (const point position, const tetIndices &tetIs) const =0
 Interpolate gradient. More...
 
virtual void average ()
 Calculate the average. More...
 
virtual void average (const AveragingMethod< scalar > &weight)
 
virtual bool writeData (Ostream &) const
 Dummy write. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
virtual tmp< Field< Type > > internalField () const =0
 Return an internal field of the average. More...
 
void operator= (const AveragingMethod< Type > &x)
 Assign to another average. More...
 
void operator= (const Type &x)
 Assign to value. More...
 
void operator= (tmp< FieldField< Field, Type > > x)
 Assign to tmp. More...
 
void operator+= (tmp< FieldField< Field, Type > > x)
 Add-equal tmp. More...
 
void operator*= (tmp< FieldField< Field, Type > > x)
 Multiply-equal tmp. More...
 
void operator/= (tmp< FieldField< Field, scalar > > x)
 Divide-equal tmp. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
label & watchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from FieldField< Field, Type >
 FieldField ()
 Construct null. More...
 
 FieldField (const label)
 Construct given size. More...
 
 FieldField (const word &, const FieldField< Field, Type > &)
 Construct using the Field sizes from the given FieldField. More...
 
 FieldField (const FieldField< Field, Type > &)
 Construct as copy. More...
 
 FieldField (FieldField< Field, Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 FieldField (const PtrList< Field< Type > > &)
 Construct as copy of a PtrList<Field, Type> More...
 
 FieldField (Istream &)
 Construct as copy of tmp<FieldField> More...
 
tmp< FieldField< Field, Type > > clone () const
 Clone. More...
 
void negate ()
 Negate this field. More...
 
tmp< FieldField< Field,
cmptType > > 
component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const FieldField< 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< FieldField< Field, Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void operator= (const FieldField< Field, Type > &)
 
void operator= (const tmp< FieldField< Field, Type > > &)
 
void operator= (const Type &)
 
void operator+= (const FieldField< Field, Type > &)
 
void operator+= (const tmp< FieldField< Field, Type > > &)
 
void operator-= (const FieldField< Field, Type > &)
 
void operator-= (const tmp< FieldField< Field, Type > > &)
 
void operator*= (const FieldField< Field, scalar > &)
 
void operator*= (const tmp< FieldField< Field, scalar > > &)
 
void operator/= (const FieldField< Field, scalar > &)
 
void operator/= (const tmp< FieldField< Field, scalar > > &)
 
void operator+= (const Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
- Public Member Functions inherited from PtrList< T >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< T > &)
 Copy constructor. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< T > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T> More...
 
template<class INew >
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 
void append (const tmp< T > &)
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 
autoPtr< Tset (const label, const tmp< T > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
PtrList< T > & operator= (const PtrList< T > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 

Static Public Member Functions

static autoPtr
< AveragingMethod< Type > > 
New (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
 Selector. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from FieldField< Field, Type >
template<class Type2 >
static tmp< FieldField< Field,
Type > > 
NewCalculatedType (const FieldField< Field, Type2 > &ff)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 

Protected Types

typedef outerProduct< vector,
Type >::type 
TypeGrad
 Protected typedefs. More...
 

Protected Member Functions

virtual void updateGrad ()
 Protected member functions. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from PtrList< T >
template<class INew >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Protected Attributes

const dictionarydict_
 Protected data. More...
 
const fvMeshmesh_
 The mesh on which the averaging is to be done. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Public Types inherited from FieldField< Field, Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- Public Types inherited from PtrList< T >
typedef T value_type
 Type of values the PtrList contains. More...
 
typedef Treference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum
< fileCheckTypes, 4 > 
fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

template<class Type>
class Foam::AveragingMethod< Type >

Base class for lagrangian averaging methods.

Source files

Definition at line 56 of file MPPICParcel.H.

Member Typedef Documentation

typedef outerProduct<vector, Type>::type TypeGrad
protected

Protected typedefs.

Gradient type

Definition at line 63 of file AveragingMethod.H.

Constructor & Destructor Documentation

AveragingMethod ( const IOobject io,
const dictionary dict,
const fvMesh mesh,
const labelList size 
)

Constructors.

Construct from components

Definition at line 34 of file AveragingMethod.C.

References forAll.

AveragingMethod ( const AveragingMethod< Type > &  am)

Construct a copy.

Definition at line 58 of file AveragingMethod.C.

~AveragingMethod ( )
virtual

Destructor.

Definition at line 112 of file AveragingMethod.C.

Member Function Documentation

void updateGrad ( )
protectedvirtual

Protected member functions.

Update the gradient calculation

Definition at line 119 of file AveragingMethod.C.

TypeName ( "averagingMethod"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
AveragingMethod< Type >  ,
dictionary  ,
(const IOobject &io, const dictionary &dict, const fvMesh &mesh ,
(io, dict, mesh  
)

Declare runtime constructor selection table.

virtual autoPtr<AveragingMethod<Type> > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Foam::autoPtr< Foam::AveragingMethod< Type > > New ( const IOobject io,
const dictionary dict,
const fvMesh mesh 
)
static

Selector.

Definition at line 74 of file AveragingMethod.C.

References Foam::abort(), dict, FatalErrorIn, dictionary::lookup(), and mesh.

Here is the call graph for this function:

virtual void add ( const point  position,
const tetIndices tetIs,
const Type &  value 
)
pure virtual

Member Functions.

Add point value to interpolation

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel< ParcelType >::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

virtual Type interpolate ( const point  position,
const tetIndices tetIs 
) const
pure virtual

Interpolate.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate().

Here is the caller graph for this function:

virtual TypeGrad interpolateGrad ( const point  position,
const tetIndices tetIs 
) const
pure virtual

Interpolate gradient.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

void average ( )
virtual

Calculate the average.

Reimplemented in Dual< Type >.

Definition at line 128 of file AveragingMethod.C.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel< ParcelType >::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

void average ( const AveragingMethod< scalar > &  weight)
virtual

Reimplemented in Dual< Type >.

Definition at line 136 of file AveragingMethod.C.

References Foam::max().

Here is the call graph for this function:

bool writeData ( Ostream os) const
virtual

Dummy write.

Implements regIOobject.

Definition at line 147 of file AveragingMethod.C.

References IOstream::good().

Here is the call graph for this function:

bool write ( ) const
virtual
virtual tmp<Field<Type> > internalField ( ) const
pure virtual

Return an internal field of the average.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Implicit< CloudType >::cacheFields().

Here is the caller graph for this function:

void operator= ( const AveragingMethod< Type > &  x)
inline

Assign to another average.

Definition at line 30 of file AveragingMethodI.H.

References x.

void operator= ( const Type &  x)
inline

Assign to value.

Definition at line 41 of file AveragingMethodI.H.

References x.

void operator= ( tmp< FieldField< Field, Type > >  x)
inline

Assign to tmp.

Definition at line 52 of file AveragingMethodI.H.

References x.

void operator+= ( tmp< FieldField< Field, Type > >  x)
inline

Add-equal tmp.

Definition at line 63 of file AveragingMethodI.H.

References x.

void operator*= ( tmp< FieldField< Field, Type > >  x)
inline

Multiply-equal tmp.

Definition at line 74 of file AveragingMethodI.H.

References x.

void operator/= ( tmp< FieldField< Field, scalar > >  x)
inline

Divide-equal tmp.

Definition at line 85 of file AveragingMethodI.H.

References x.

Member Data Documentation

const dictionary& dict_
protected

Protected data.

Dictionary

Definition at line 69 of file AveragingMethod.H.

const fvMesh& mesh_
protected

The mesh on which the averaging is to be done.

Definition at line 72 of file AveragingMethod.H.


The documentation for this class was generated from the following files:
  • src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
  • src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
  • src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.C
  • src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethodI.H