parcelCloudList Class Reference

List of parcel clouds, with the same interface as an individual parcel cloud. This is the object that should be constructed by a solver in order to support the coupled simulation of multiple clouds. More...

Inheritance diagram for parcelCloudList:
Collaboration diagram for parcelCloudList:

Public Member Functions

 parcelCloudList (const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g)
 Construct with given carrier fields. More...
 
 parcelCloudList (const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo)
 Construct with given carrier fields and thermo. More...
 
 parcelCloudList (const parcelCloudList &)=delete
 Disallow default bitwise copy construction. More...
 
 ~parcelCloudList ()
 Destructor. More...
 
const tmp< volScalarFieldtheta () const
 Return the particle volume fraction field. More...
 
tmp< fvVectorMatrixSU (const volVectorField &U) const
 Return momentum source term [kg m/s^2]. More...
 
tmp< volVectorField::InternalUTrans () const
 Momentum transfer [kg m/s]. More...
 
tmp< volScalarField::InternalUCoeff () const
 Momentum transfer coefficient [kg]. More...
 
tmp< fvScalarMatrixSh (const volScalarField &hs) const
 Return sensible enthalpy source term [J/s]. More...
 
tmp< volScalarField::InternalhsTrans () const
 Sensible enthalpy transfer [J]. More...
 
tmp< volScalarField::InternalhsCoeff () const
 Sensible enthalpy transfer coefficient [J/K]. More...
 
tmp< volScalarFieldEp () const
 Return equivalent particulate emission [kg/m/s^3]. More...
 
tmp< volScalarFieldap () const
 Return equivalent particulate absorption [1/m]. More...
 
tmp< volScalarFieldsigmap () const
 Return equivalent particulate scattering factor [1/m]. More...
 
tmp< fvScalarMatrixSYi (const label speciei, const volScalarField &Yi) const
 Return mass source term for specie [kg/s]. More...
 
tmp< fvScalarMatrixSrho (const volScalarField &rho) const
 Return total mass source term [kg/s]. More...
 
tmp< volScalarField::InternalSrho () const
 Return total mass source [kg/m^3/s]. More...
 
void info ()
 Print cloud information. More...
 
void evolve ()
 Evolve the cloud. More...
 
void storeGlobalPositions ()
 Call this before a topology change. Stores the particles global. More...
 
void operator= (const parcelCloudList &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from PtrList< parcelCloud >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< parcelCloud > &)
 Copy constructor. More...
 
 PtrList (const PtrList< parcelCloud > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (PtrList< parcelCloud > &&)
 Move constructor. More...
 
 PtrList (PtrList< parcelCloud > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< parcelCloud > &)
 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 (parcelCloud *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< parcelCloud > &)
 
void append (const tmp< parcelCloud > &)
 
void transfer (PtrList< parcelCloud > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< parcelCloudset (const label, parcelCloud *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< parcelCloudset (const label, const autoPtr< parcelCloud > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< parcelCloudset (const label, const tmp< parcelCloud > &)
 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< parcelCloud > &)
 Assignment operator. More...
 
void operator= (PtrList< parcelCloud > &&)
 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...
 

Static Public Attributes

static const word cloudsName
 The name of the clouds. 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< parcelCloud >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

List of parcel clouds, with the same interface as an individual parcel cloud. This is the object that should be constructed by a solver in order to support the coupled simulation of multiple clouds.

Source files

Definition at line 48 of file parcelCloudList.H.

Constructor & Destructor Documentation

◆ parcelCloudList() [1/3]

parcelCloudList ( const volScalarField rho,
const volVectorField U,
const volScalarField mu,
const dimensionedVector g 
)

Construct with given carrier fields.

Definition at line 93 of file parcelCloudList.C.

◆ parcelCloudList() [2/3]

parcelCloudList ( const volScalarField rho,
const volVectorField U,
const dimensionedVector g,
const fluidThermo carrierThermo 
)

Construct with given carrier fields and thermo.

Definition at line 108 of file parcelCloudList.C.

◆ parcelCloudList() [3/3]

parcelCloudList ( const parcelCloudList )
delete

Disallow default bitwise copy construction.

◆ ~parcelCloudList()

Destructor.

Definition at line 124 of file parcelCloudList.C.

Member Function Documentation

◆ theta()

const Foam::tmp< Foam::volScalarField > theta ( ) const

Return the particle volume fraction field.

Definition at line 130 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimless, forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and parcelCloudList::SU().

Here is the call graph for this function:

◆ SU()

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

Return momentum source term [kg m/s^2].

Definition at line 151 of file parcelCloudList.C.

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

Referenced by parcelCloudList::theta().

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

◆ UTrans()

Momentum transfer [kg m/s].

Definition at line 164 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ UCoeff()

Momentum transfer coefficient [kg].

Definition at line 183 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ Sh()

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

Return sensible enthalpy source term [J/s].

Definition at line 203 of file parcelCloudList.C.

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

Referenced by parcelCloudList::UCoeff().

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

◆ hsTrans()

Sensible enthalpy transfer [J].

Definition at line 216 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimEnergy, forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ hsCoeff()

Sensible enthalpy transfer coefficient [J/K].

Definition at line 235 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimEnergy, Foam::dimTemperature, forAll, DimensionedField< Type, GeoMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ Ep()

Return equivalent particulate emission [kg/m/s^3].

Definition at line 254 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimLength, Foam::dimMass, Foam::dimTime, forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), UPtrList< T >::operator[](), Foam::pow3(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ ap()

Return equivalent particulate absorption [1/m].

Definition at line 273 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimLength, Foam::dimless, forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), UPtrList< T >::operator[](), and tmp< T >::ref().

Here is the call graph for this function:

◆ sigmap()

Foam::tmp< Foam::volScalarField > sigmap ( ) const

Return equivalent particulate scattering factor [1/m].

Definition at line 293 of file parcelCloudList.C.

References parcelCloudList::cloudsName, Foam::dimLength, Foam::dimless, forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), UPtrList< T >::operator[](), tmp< T >::ref(), and parcelCloudList::SYi().

Here is the call graph for this function:

◆ SYi()

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

Return mass source term for specie [kg/s].

Definition at line 313 of file parcelCloudList.C.

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

Referenced by parcelCloudList::sigmap().

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

◆ Srho() [1/2]

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

Return total mass source term [kg/s].

Definition at line 328 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ Srho() [2/2]

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

Definition at line 341 of file parcelCloudList.C.

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

Referenced by parcelCloudList::SYi().

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

◆ info()

void info ( )

Print cloud information.

Definition at line 360 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ evolve()

void evolve ( )

Evolve the cloud.

Definition at line 369 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ storeGlobalPositions()

void storeGlobalPositions ( )

Call this before a topology change. Stores the particles global.

positions in the database for use during mapping.

Definition at line 378 of file parcelCloudList.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const parcelCloudList )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ cloudsName


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