coalCloudList Class Reference
Inheritance diagram for coalCloudList:
[legend]
Collaboration diagram for coalCloudList:
[legend]

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/m3/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/m3]. 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/m3/s]. More...
 
- Public Member Functions inherited from PtrList< coalCloud >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< coalCloud > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< coalCloud > &&list)
 Move construct. More...
 
 PtrList (UList< coalCloud * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< coalCloud > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< coalCloud > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< coalCloud > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< coalCloudclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< coalCloudclone (Args &&... args) const
 
const coalCloudset (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< coalCloudset (const label i, coalCloud *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< coalCloudset (const label i, autoPtr< coalCloud > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< coalCloudset (const label i, autoPtr< coalCloud > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< coalCloudset (const label i, std::unique_ptr< coalCloud > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< coalCloudset (const label i, const refPtr< coalCloud > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< coalCloudset (const label i, const tmp< coalCloud > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (coalCloud *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< coalCloud > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< coalCloud > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< coalCloud > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< coalCloud > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< coalCloud > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< coalCloudemplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< coalCloudemplace (const label i, Args &&... args)
 
autoPtr< coalCloudrelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< coalCloud > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< coalCloud > &list)
 Copy assignment. More...
 
void operator= (PtrList< coalCloud > &&list)
 Move assignment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< coalCloud >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 

Detailed Description

Definition at line 44 of file coalCloudList.H.

Constructor & Destructor Documentation

◆ coalCloudList()

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

Definition at line 34 of file coalCloudList.C.

References Foam::endl(), g, dictionary::get(), Foam::Info, Foam::name(), rho, Foam::BitOps::set(), setSize(), slgThermo(), and U.

Here is the call graph for this function:

Member Function Documentation

◆ evolve()

void evolve ( )

Evolve the cloud collection.

Definition at line 84 of file coalCloudList.C.

References forAll.

◆ UTrans()

Return const reference to momentum source.

Definition at line 33 of file coalCloudListI.H.

References Foam::dimMass, Foam::dimVelocity, fld, forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), fvMesh::time(), Time::timeName(), 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 64 of file coalCloudListI.H.

References Foam::dimForce, forAll, tmp< T >::ref(), and U.

Here is the call graph for this function:

◆ hsTrans()

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

Sensible enthalpy transfer [J/kg].

Definition at line 81 of file coalCloudListI.H.

References Foam::dimEnergy, fld, forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and Foam::Zero.

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/m3/s].

Definition at line 112 of file coalCloudListI.H.

References Foam::dimEnergy, Foam::dimTime, forAll, and tmp< T >::ref().

Here is the call 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 129 of file coalCloudListI.H.

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

Here is the call graph for this function:

◆ rhoTrans()

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

Return total mass transfer [kg/m3].

Definition at line 147 of file coalCloudListI.H.

References Foam::dimMass, fld, forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and Foam::Zero.

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 183 of file coalCloudListI.H.

References Foam::dimDensity, Foam::dimTime, fld, forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and Foam::Zero.

Here is the call 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 215 of file coalCloudListI.H.

References Foam::dimDensity, Foam::dimTime, fld, forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and Foam::Zero.

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/m3/s].

Definition at line 248 of file coalCloudListI.H.

References Foam::dimMass, Foam::dimTime, forAll, tmp< T >::ref(), and rho.

Here is the call graph for this function:

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