Public Member Functions | List of all members
ParticleForceList< CloudType > Class Template Reference

List of particle forces. More...

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

Public Member Functions

 ParticleForceList (CloudType &owner, const fvMesh &mesh)
 Null constructor. More...
 
 ParticleForceList (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const bool readFields)
 Construct from mesh. More...
 
 ParticleForceList (const ParticleForceList &pfl)
 Construct copy. More...
 
virtual ~ParticleForceList ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the cloud owner. More...
 
CloudTypeowner ()
 Return refernce to the cloud owner. More...
 
const fvMeshmesh () const
 Return the mesh database. More...
 
const dictionarydict () const
 Return the forces dictionary. More...
 
void setCalcCoupled (bool flag)
 Set the calcCoupled flag. More...
 
void setCalcNonCoupled (bool flag)
 Set the calcNonCoupled flag. More...
 
virtual void cacheFields (const bool store)
 Cache fields. More...
 
virtual forceSuSp calcCoupled (const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
 Calculate the coupled force. More...
 
virtual forceSuSp calcNonCoupled (const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
 Calculate the non-coupled force. More...
 
virtual scalar massEff (const typename CloudType::parcelType &p, const scalar mass) const
 Return the effective mass. More...
 
- Public Member Functions inherited from PtrList< ParticleForce< CloudType > >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< ParticleForce< CloudType > > &)
 Copy constructor. More...
 
 PtrList (const PtrList< ParticleForce< CloudType > > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< ParticleForce< CloudType > > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< ParticleForce< CloudType > > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< ParticleForce< 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...
 
ParticleForce< CloudType > & first ()
 Return reference to the first element of the list. More...
 
const ParticleForce< CloudType > & first () const
 Return reference to first element of the list. More...
 
ParticleForce< CloudType > & last ()
 Return reference to the last element of the list. More...
 
const ParticleForce< 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 (ParticleForce< CloudType > *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< ParticleForce< CloudType > > &)
 
void append (const tmp< ParticleForce< CloudType > > &)
 
void transfer (PtrList< ParticleForce< CloudType > > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< ParticleForce< CloudType > > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< ParticleForce< CloudType > > set (const label, ParticleForce< CloudType > *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< ParticleForce< CloudType > > set (const label, const autoPtr< ParticleForce< CloudType > > &)
 
autoPtr< ParticleForce< CloudType > > set (const label, const tmp< ParticleForce< CloudType > > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const ParticleForce< CloudType > & operator[] (const label) const
 Return element const reference. More...
 
ParticleForce< CloudType > & operator[] (const label)
 Return element reference. More...
 
const ParticleForce< CloudType > * operator() (const label) const
 Return element const pointer. More...
 
PtrList< ParticleForce< CloudType > > & operator= (const PtrList< ParticleForce< 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...
 

Additional Inherited Members

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

Detailed Description

template<class CloudType>
class Foam::ParticleForceList< CloudType >

List of particle forces.

Source files

Definition at line 51 of file ParticleForceList.H.

Constructor & Destructor Documentation

ParticleForceList ( CloudType owner,
const fvMesh mesh 
)

Null constructor.

Definition at line 33 of file ParticleForceList.C.

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

Here is the caller graph for this function:

ParticleForceList ( CloudType owner,
const fvMesh mesh,
const dictionary dict,
const bool  readFields 
)

Construct from mesh.

Definition at line 49 of file ParticleForceList.C.

References dict, Foam::endl(), forAllConstIter(), Foam::Info, Foam::compressible::New(), ParticleForceList< CloudType >::ParticleForceList(), setSize(), and dictionary::toc().

Here is the call graph for this function:

Construct copy.

Definition at line 117 of file ParticleForceList.C.

~ParticleForceList ( )
virtual

Destructor.

Definition at line 131 of file ParticleForceList.C.

Member Function Documentation

const CloudType & owner ( ) const
inline

Return const access to the cloud owner.

Definition at line 29 of file ParticleForceListI.H.

CloudType & owner ( )
inline

Return refernce to the cloud owner.

Definition at line 36 of file ParticleForceListI.H.

const Foam::fvMesh & mesh ( ) const
inline

Return the mesh database.

Definition at line 43 of file ParticleForceListI.H.

const Foam::dictionary & dict ( ) const
inline

Return the forces dictionary.

Definition at line 50 of file ParticleForceListI.H.

void setCalcCoupled ( bool  flag)
inline

Set the calcCoupled flag.

Definition at line 57 of file ParticleForceListI.H.

void setCalcNonCoupled ( bool  flag)
inline

Set the calcNonCoupled flag.

Definition at line 64 of file ParticleForceListI.H.

void cacheFields ( const bool  store)
virtual

Cache fields.

Definition at line 138 of file ParticleForceList.C.

References ParticleForceList< CloudType >::calcCoupled(), and forAll.

Here is the call graph for this function:

Foam::forceSuSp calcCoupled ( const typename CloudType::parcelType p,
const scalar  dt,
const scalar  mass,
const scalar  Re,
const scalar  muc 
) const
virtual

Calculate the coupled force.

Definition at line 149 of file ParticleForceList.C.

References ParticleForceList< CloudType >::calcNonCoupled(), and forAll.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::forceSuSp calcNonCoupled ( const typename CloudType::parcelType p,
const scalar  dt,
const scalar  mass,
const scalar  Re,
const scalar  muc 
) const
virtual

Calculate the non-coupled force.

Definition at line 173 of file ParticleForceList.C.

References forAll, and ParticleForceList< CloudType >::massEff().

Referenced by ParticleForceList< CloudType >::calcCoupled().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar massEff ( const typename CloudType::parcelType p,
const scalar  mass 
) const
virtual

Return the effective mass.

Definition at line 197 of file ParticleForceList.C.

References forAll.

Referenced by ParticleForceList< CloudType >::calcNonCoupled().

Here is the caller graph for this function:


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