parcelCloud Class Referenceabstract

Virtual abstract base class for parcel clouds. As parcelCloudBase but with additional virtualisation of the evolve method, plus some additional methods that are defined below the parcel-cloud layer (i.e., in Cloud). These methods are implemented by forwarding in the ParcelCloud class. More...

Inheritance diagram for parcelCloud:
Collaboration diagram for parcelCloud:

Public Member Functions

 TypeName ("parcelCloud")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, parcelCloud, viscosity,(const word &name, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g),(name, rho, U, mu, g))
 
 declareRunTimeSelectionTable (autoPtr, parcelCloud, thermo,(const word &name, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo),(name, rho, U, g, carrierThermo))
 
 parcelCloud ()
 Null constructor. More...
 
 parcelCloud (const parcelCloud &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~parcelCloud ()
 Destructor. More...
 
virtual void storeGlobalPositions ()=0
 Call this before a topology change. Stores the particles global. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &map)
 Redistribute or update using the given distribution map. More...
 
virtual void evolve ()=0
 Evolve the cloud. More...
 
void operator= (const parcelCloud &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from parcelCloudBase
 TypeName ("parcelCloudBase")
 Runtime type information. More...
 
 parcelCloudBase ()
 Null constructor. More...
 
 parcelCloudBase (const parcelCloudBase &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~parcelCloudBase ()
 Destructor. More...
 
virtual label nParcels () const =0
 Number of parcels. More...
 
virtual scalar massInSystem () const =0
 Total mass in system. More...
 
virtual const tmp< volScalarFieldvDotSweep () const =0
 Volume swept rate of parcels per cell. More...
 
virtual const tmp< volScalarFieldalpha () const =0
 Return the particle volume fraction field. More...
 
virtual const tmp< volScalarFieldY () const =0
 Return the particle mass fraction field. More...
 
virtual const tmp< volScalarFieldrhoEff () const =0
 Return the particle effective density field. More...
 
virtual tmp< fvVectorMatrixSU (const volVectorField &U) const =0
 Return momentum source term [kg m/s^2]. More...
 
virtual tmp< volVectorField::InternalUTrans () const =0
 Momentum transfer [kg m/s]. More...
 
virtual tmp< volScalarField::InternalUCoeff () const =0
 Momentum transfer coefficient [kg]. More...
 
virtual tmp< fvScalarMatrixSh (const volScalarField &hs) const =0
 Return sensible enthalpy source term [J/s]. More...
 
virtual tmp< volScalarField::InternalhsTrans () const =0
 Sensible enthalpy transfer [J]. More...
 
virtual tmp< volScalarField::InternalhsCoeff () const =0
 Sensible enthalpy transfer coefficient [J/K]. More...
 
virtual tmp< volScalarFieldEp () const =0
 Return equivalent particulate emission [kg/m/s^3]. More...
 
virtual tmp< volScalarFieldap () const =0
 Return equivalent particulate absorption [1/m]. More...
 
virtual tmp< volScalarFieldsigmap () const =0
 Return equivalent particulate scattering factor [1/m]. More...
 
virtual tmp< fvScalarMatrixSYi (const label i, const volScalarField &Yi) const =0
 Return mass source term for specie [kg/s]. More...
 
virtual tmp< fvScalarMatrixSrho (const volScalarField &rho) const =0
 Return total mass source term [kg/s]. More...
 
virtual tmp< volScalarField::InternalSrho () const =0
 Return total mass source [kg/m^3/s]. More...
 
virtual void info ()=0
 Print cloud information. More...
 
void operator= (const parcelCloudBase &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< parcelCloudNew (const word &name, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g)
 Selectors. More...
 
static autoPtr< parcelCloudNew (const word &name, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo)
 Select and construct with given carrier fields and thermo. More...
 

Detailed Description

Virtual abstract base class for parcel clouds. As parcelCloudBase but with additional virtualisation of the evolve method, plus some additional methods that are defined below the parcel-cloud layer (i.e., in Cloud). These methods are implemented by forwarding in the ParcelCloud class.

This class contains the selection table and represents the high level interface used by a solver.

Source files

Definition at line 54 of file parcelCloud.H.

Constructor & Destructor Documentation

◆ parcelCloud() [1/2]

Null constructor.

Definition at line 40 of file parcelCloud.C.

◆ parcelCloud() [2/2]

parcelCloud ( const parcelCloud )
delete

Disallow default bitwise copy construction.

◆ ~parcelCloud()

~parcelCloud ( )
virtual

Destructor.

Definition at line 46 of file parcelCloud.C.

Member Function Documentation

◆ TypeName()

TypeName ( "parcelCloud"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
parcelCloud  ,
viscosity  ,
(const word &name, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g)  ,
(name, rho, U, mu, g)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
parcelCloud  ,
thermo  ,
(const word &name, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo)  ,
(name, rho, U, g, carrierThermo)   
)

◆ New() [1/2]

Foam::autoPtr< Foam::parcelCloud > New ( const word name,
const volScalarField rho,
const volVectorField U,
const volScalarField mu,
const dimensionedVector g 
)
static

Selectors.

Select and construct with given carrier fields

Definition at line 30 of file parcelCloudNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::libs, Foam::constant::physicoChemical::mu, IOobject::MUST_READ, Foam::name(), Foam::nl, IOobject::NO_WRITE, dlLibraryTable::open(), rho, Foam::type(), and U.

Referenced by parcelCloudList::parcelCloudList().

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

◆ New() [2/2]

Foam::autoPtr< Foam::parcelCloud > New ( const word name,
const volScalarField rho,
const volVectorField U,
const dimensionedVector g,
const fluidThermo carrierThermo 
)
static

Select and construct with given carrier fields and thermo.

Definition at line 73 of file parcelCloudNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::libs, dictionary::lookup(), IOobject::MUST_READ, Foam::name(), Foam::nl, IOobject::NO_WRITE, dlLibraryTable::open(), rho, Foam::type(), and U.

Here is the call graph for this function:

◆ storeGlobalPositions()

virtual void storeGlobalPositions ( )
pure virtual

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

positions in the database for use during mapping.

Implemented in ParcelCloud< CloudType >.

◆ topoChange()

virtual void topoChange ( const polyTopoChangeMap )
inlinevirtual

Update topology using the given map.

Reimplemented in ParcelCloud< CloudType >.

Definition at line 142 of file parcelCloud.H.

References NotImplemented.

◆ mapMesh()

virtual void mapMesh ( const polyMeshMap )
inlinevirtual

Update from another mesh using the given map.

Reimplemented in ParcelCloud< CloudType >.

Definition at line 148 of file parcelCloud.H.

References NotImplemented.

◆ distribute()

virtual void distribute ( const polyDistributionMap map)
inlinevirtual

Redistribute or update using the given distribution map.

Reimplemented in ParcelCloud< CloudType >.

Definition at line 154 of file parcelCloud.H.

References NotImplemented.

◆ evolve()

virtual void evolve ( )
pure virtual

Evolve the cloud.

Implemented in ParcelCloud< CloudType >.

◆ operator=()

void operator= ( const parcelCloud )
delete

Disallow default bitwise assignment.


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