Public Member Functions | Protected Attributes | List of all members
CloudFunctionObjectList< CloudType > Class Template Reference

List of cloud function objects. More...

Inheritance diagram for CloudFunctionObjectList< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for CloudFunctionObjectList< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 CloudFunctionObjectList (CloudType &owner)
 Null constructor. More...
 
 CloudFunctionObjectList (CloudType &owner, const dictionary &dict, const bool readFields)
 Construct from mesh. More...
 
 CloudFunctionObjectList (const CloudFunctionObjectList &ppml)
 Construct copy. More...
 
virtual ~CloudFunctionObjectList ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the cloud owner. More...
 
CloudTypeowner ()
 Return refernce to the cloud owner. More...
 
const dictionarydict () const
 Return the forces dictionary. More...
 
virtual void preEvolve ()
 Pre-evolve hook. More...
 
virtual void postEvolve ()
 Post-evolve hook. More...
 
virtual void postMove (typename CloudType::parcelType &p, const label cellI, const scalar dt, const point &position0, bool &keepParticle)
 Post-move hook. More...
 
virtual void postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &tetIs, bool &keepParticle)
 Post-patch hook. More...
 
virtual void postFace (const typename CloudType::parcelType &p, const label faceI, bool &keepParticle)
 Post-face hook. More...
 
- Public Member Functions inherited from PtrList< CloudFunctionObject< CloudType > >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< CloudFunctionObject< CloudType > > &)
 Copy constructor. More...
 
 PtrList (const PtrList< CloudFunctionObject< CloudType > > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< CloudFunctionObject< CloudType > > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< CloudFunctionObject< CloudType > > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< CloudFunctionObject< CloudType > > &)
 Construct as copy of SLPtrList<T> More...
 
 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...
 
CloudFunctionObject< CloudType > & first ()
 Return reference to the first element of the list. More...
 
const CloudFunctionObject< CloudType > & first () const
 Return reference to first element of the list. More...
 
CloudFunctionObject< CloudType > & last ()
 Return reference to the last element of the list. More...
 
const CloudFunctionObject< CloudType > & last () 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 (CloudFunctionObject< CloudType > *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< CloudFunctionObject< CloudType > > &)
 
void append (const tmp< CloudFunctionObject< CloudType > > &)
 
void transfer (PtrList< CloudFunctionObject< CloudType > > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< CloudFunctionObject< CloudType > > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< CloudFunctionObject< CloudType > > set (const label, CloudFunctionObject< CloudType > *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< CloudFunctionObject< CloudType > > set (const label, const autoPtr< CloudFunctionObject< CloudType > > &)
 
autoPtr< CloudFunctionObject< CloudType > > set (const label, const tmp< CloudFunctionObject< CloudType > > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const CloudFunctionObject< CloudType > & operator[] (const label) const
 Return element const reference. More...
 
CloudFunctionObject< CloudType > & operator[] (const label)
 Return element reference. More...
 
const CloudFunctionObject< CloudType > * operator() (const label) const
 Return element const pointer. More...
 
PtrList< CloudFunctionObject< CloudType > > & operator= (const PtrList< CloudFunctionObject< CloudType > > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 

Protected Attributes

const CloudTypeowner_
 Reference to the owner cloud. More...
 
const dictionary dict_
 Dictionary. More...
 

Additional Inherited Members

- Public Types inherited from PtrList< CloudFunctionObject< CloudType > >
typedef CloudFunctionObject< CloudTypevalue_type
 Type of values the PtrList contains. More...
 
typedef CloudFunctionObject< CloudType > & reference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const CloudFunctionObject< CloudType > & const_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< CloudFunctionObject< CloudType > >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

template<class CloudType>
class Foam::CloudFunctionObjectList< CloudType >

List of cloud function objects.

Source files

Definition at line 51 of file CloudFunctionObjectList.H.

Constructor & Destructor Documentation

Null constructor.

Definition at line 33 of file CloudFunctionObjectList.C.

Referenced by CloudFunctionObjectList< CloudType >::CloudFunctionObjectList().

Here is the caller graph for this function:

CloudFunctionObjectList ( CloudType owner,
const dictionary dict,
const bool  readFields 
)

Construct copy.

Definition at line 97 of file CloudFunctionObjectList.C.

Destructor.

Definition at line 110 of file CloudFunctionObjectList.C.

Member Function Documentation

const CloudType & owner ( ) const
inline

Return const access to the cloud owner.

Definition at line 27 of file CloudFunctionObjectListI.H.

CloudType & owner ( )
inline

Return refernce to the cloud owner.

Definition at line 34 of file CloudFunctionObjectListI.H.

const Foam::dictionary & dict ( ) const
inline

Return the forces dictionary.

Definition at line 42 of file CloudFunctionObjectListI.H.

void preEvolve ( )
virtual

Pre-evolve hook.

Definition at line 117 of file CloudFunctionObjectList.C.

References forAll.

void postEvolve ( )
virtual

Post-evolve hook.

Definition at line 127 of file CloudFunctionObjectList.C.

References forAll, and CloudFunctionObjectList< CloudType >::postMove().

Here is the call graph for this function:

void postMove ( typename CloudType::parcelType p,
const label  cellI,
const scalar  dt,
const point position0,
bool &  keepParticle 
)
virtual

Post-move hook.

Definition at line 138 of file CloudFunctionObjectList.C.

References forAll, and CloudFunctionObjectList< CloudType >::postPatch().

Referenced by CloudFunctionObjectList< CloudType >::postEvolve().

Here is the call graph for this function:

Here is the caller graph for this function:

void postPatch ( const typename CloudType::parcelType p,
const polyPatch pp,
const scalar  trackFraction,
const tetIndices tetIs,
bool &  keepParticle 
)
virtual

Post-patch hook.

Definition at line 160 of file CloudFunctionObjectList.C.

References forAll, and CloudFunctionObjectList< CloudType >::postFace().

Referenced by CloudFunctionObjectList< CloudType >::postMove().

Here is the call graph for this function:

Here is the caller graph for this function:

void postFace ( const typename CloudType::parcelType p,
const label  faceI,
bool &  keepParticle 
)
virtual

Post-face hook.

Definition at line 189 of file CloudFunctionObjectList.C.

References forAll.

Referenced by CloudFunctionObjectList< CloudType >::postPatch().

Here is the caller graph for this function:

Member Data Documentation

const CloudType& owner_
protected

Reference to the owner cloud.

Definition at line 60 of file CloudFunctionObjectList.H.

const dictionary dict_
protected

Dictionary.

Definition at line 63 of file CloudFunctionObjectList.H.


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