coalCloudList Class Reference
Inheritance diagram for coalCloudList:
Collaboration diagram for coalCloudList:

Public Member Functions

 coalCloudList (const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &slgThermo)
 
void evolve ()
 Evolve the cloud collection. More...
 
tmp< volVectorField::InternalUTrans () const
 Return const reference to momentum source. More...
 
tmp< fvVectorMatrixSU (volVectorField &U) const
 Return tmp momentum source term. More...
 
tmp< volScalarField::InternalhsTrans () const
 Sensible enthalpy transfer [J/kg]. More...
 
tmp< fvScalarMatrixSh (volScalarField &hs) const
 Return sensible enthalpy source term [J/kg/m^3/s]. More...
 
tmp< fvScalarMatrixSYi (const label i, volScalarField &Yi) const
 Return mass source term for specie i - specie eqn. More...
 
tmp< volScalarField::InternalrhoTrans () const
 Return total mass transfer [kg/m^3]. More...
 
tmp< volScalarField::InternalSrho () const
 Return tmp total mass source for carrier phase. More...
 
tmp< volScalarField::InternalSrho (const label i) const
 Return tmp total mass source for carrier phase specie i. More...
 
tmp< fvScalarMatrixSrho (volScalarField &rho) const
 Return total mass source term [kg/m^3/s]. More...
 
- Public Member Functions inherited from PtrList< coalCloud >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< coalCloud > &)
 Copy constructor. More...
 
 PtrList (const PtrList< coalCloud > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (PtrList< coalCloud > &&)
 Move constructor. More...
 
 PtrList (PtrList< coalCloud > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< coalCloud > &)
 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...
 
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 (coalCloud *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< coalCloud > &)
 
void append (const tmp< coalCloud > &)
 
void transfer (PtrList< coalCloud > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< coalCloudset (const label, coalCloud *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< coalCloudset (const label, const autoPtr< coalCloud > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< coalCloudset (const label, const tmp< coalCloud > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< coalCloud > &)
 Assignment operator. More...
 
void operator= (PtrList< coalCloud > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList 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 UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 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...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 42 of file coalCloudList.H.

Constructor & Destructor Documentation

◆ coalCloudList()

coalCloudList ( const volScalarField rho,
const volVectorField U,
const dimensionedVector g,
const SLGThermo slgThermo 
)

Definition at line 31 of file coalCloudList.C.

References Foam::endl(), forAllConstIter(), Foam::Info, dictionary::lookup(), Foam::name(), setSize(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

Member Function Documentation

◆ evolve()

void evolve ( )

Evolve the cloud collection.

Definition at line 83 of file coalCloudList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ UTrans()

Return const reference to momentum source.

Definition at line 31 of file coalCloudListI.H.

References Foam::dimMass, Foam::dimVelocity, fld(), forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), coalCloudList::SU(), and Foam::Zero.

Here is the call graph for this function:

◆ SU()

Foam::tmp< Foam::fvVectorMatrix > SU ( volVectorField U) const
inline

Return tmp momentum source term.

Definition at line 55 of file coalCloudListI.H.

References Foam::dimForce, forAll, UPtrList< T >::operator[](), and tmp< T >::ref().

Referenced by coalCloudList::UTrans().

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

◆ hsTrans()

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > hsTrans ( ) const
inline

Sensible enthalpy transfer [J/kg].

Definition at line 72 of file coalCloudListI.H.

References Foam::dimEnergy, fld(), forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and coalCloudList::Sh().

Here is the call graph for this function:

◆ Sh()

Foam::tmp< Foam::fvScalarMatrix > Sh ( volScalarField hs) const
inline

Return sensible enthalpy source term [J/kg/m^3/s].

Definition at line 96 of file coalCloudListI.H.

References Foam::dimEnergy, Foam::dimTime, forAll, UPtrList< T >::operator[](), tmp< T >::ref(), and coalCloudList::SYi().

Referenced by coalCloudList::hsTrans().

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

◆ SYi()

Foam::tmp< Foam::fvScalarMatrix > SYi ( const label  i,
volScalarField Yi 
) const
inline

Return mass source term for specie i - specie eqn.

Definition at line 113 of file coalCloudListI.H.

References Foam::dimMass, Foam::dimTime, forAll, UPtrList< T >::operator[](), and tmp< T >::ref().

Referenced by coalCloudList::Sh().

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

◆ rhoTrans()

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > rhoTrans ( ) const
inline

Return total mass transfer [kg/m^3].

Definition at line 131 of file coalCloudListI.H.

References Foam::dimMass, fld(), forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), and tmp< T >::ref().

Here is the call graph for this function:

◆ Srho() [1/3]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Srho ( ) const
inline

Return tmp total mass source for carrier phase.

  • fully explicit

Definition at line 160 of file coalCloudListI.H.

References Foam::dimDensity, Foam::dimTime, fld(), forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), and tmp< T >::ref().

Referenced by coalCloudList::Srho().

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

◆ Srho() [2/3]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Srho ( const label  i) const
inline

Return tmp total mass source for carrier phase specie i.

  • fully explicit

Definition at line 185 of file coalCloudListI.H.

References Foam::dimDensity, Foam::dimTime, fld(), forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and coalCloudList::Srho().

Here is the call graph for this function:

◆ Srho() [3/3]

Foam::tmp< Foam::fvScalarMatrix > Srho ( volScalarField rho) const
inline

Return total mass source term [kg/m^3/s].

Definition at line 211 of file coalCloudListI.H.

References Foam::dimMass, Foam::dimTime, forAll, UPtrList< T >::operator[](), and tmp< T >::ref().

Here is the call graph for this function:

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