Templated base class for multiphase reacting cloud. More...
Public Types | |
typedef CloudType | cloudType |
Type of cloud this cloud was instantiated for. More... | |
typedef CloudType::particleType | parcelType |
Type of parcel the cloud was instantiated for. More... | |
typedef ReactingMultiphaseCloud< CloudType > | reactingMultiphaseCloudType |
Convenience typedef for this cloud type. More... | |
Public Types inherited from DSMCCloud< ParcelType > | |
typedef ParcelType | parcelType |
Type of parcel the cloud was instantiated for. More... | |
Public Types inherited from Cloud< ParticleType > | |
typedef ParticleType | particleType |
typedef ParticleType | parcelType |
Parcels are just particles. More... | |
Public Member Functions | |
ReactingMultiphaseCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &thermo, bool readFields=true) | |
Construct given carrier gas fields. More... | |
ReactingMultiphaseCloud (ReactingMultiphaseCloud< CloudType > &c, const word &name) | |
Copy constructor with new name. More... | |
ReactingMultiphaseCloud (const fvMesh &mesh, const word &name, const ReactingMultiphaseCloud< CloudType > &c) | |
Copy constructor with new name - creates bare cloud. More... | |
virtual autoPtr< Cloud< parcelType > > | clone (const word &name) |
Construct and return clone based on (this) with new name. More... | |
virtual autoPtr< Cloud< parcelType > > | cloneBare (const word &name) const |
Construct and return bare clone based on (this) with new name. More... | |
virtual | ~ReactingMultiphaseCloud () |
Destructor. More... | |
const ReactingMultiphaseCloud & | cloudCopy () const |
Return a reference to the cloud copy. More... | |
const parcelType::constantProperties & | constProps () const |
Return the constant properties. More... | |
parcelType::constantProperties & | constProps () |
Return access to the constant properties. More... | |
const DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > & | devolatilisation () const |
Return const access to devolatilisation model. More... | |
DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > & | devolatilisation () |
Return reference to devolatilisation model. More... | |
const SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > & | surfaceReaction () const |
Return const access to reacting surface reaction model. More... | |
SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > & | surfaceReaction () |
Return reference to reacting surface reaction model. More... | |
void | setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt) |
Set parcel thermo properties. More... | |
void | checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed) |
Check parcel properties. More... | |
void | storeState () |
Store the current cloud state. More... | |
void | restoreState () |
Reset the current cloud to the previously stored state. More... | |
void | resetSourceTerms () |
Reset the cloud source terms. More... | |
void | evolve () |
Evolve the cloud. More... | |
virtual void | autoMap (const mapPolyMesh &) |
Remap the cells of particles corresponding to the. More... | |
void | info () |
Print cloud information. More... | |
virtual void | writeFields () const |
Write the field data for the cloud. More... | |
Public Member Functions inherited from DSMCCloud< ParcelType > | |
DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true) | |
Construct given name and mesh, will read Parcels and fields from. More... | |
DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict) | |
Construct given name, mesh and initialisation dictionary. More... | |
virtual | ~DSMCCloud () |
Destructor. More... | |
const word & | cloudName () const |
Return the cloud type. More... | |
const fvMesh & | mesh () const |
Return reference to the mesh. More... | |
const IOdictionary & | particleProperties () const |
Return particle properties dictionary. More... | |
const List< word > & | typeIdList () const |
Return the idList. More... | |
scalar | nParticle () const |
Return the number of real particles represented by one. More... | |
const List< DynamicList< ParcelType * > > & | cellOccupancy () const |
Return the cell occupancy addressing. More... | |
volScalarField & | sigmaTcRMax () |
Return the sigmaTcRMax field. non-const access to allow. More... | |
scalarField & | collisionSelectionRemainder () |
Return the collision selection remainder field. non-const. More... | |
const List< typename ParcelType::constantProperties > & | constProps () const |
Return all of the constant properties. More... | |
const ParcelType::constantProperties & | constProps (label typeId) const |
Return the constant properties of the given typeId. More... | |
Random & | rndGen () |
Return reference to the random object. More... | |
volScalarField::Boundary & | qBF () |
Return non-const heat flux boundary field reference. More... | |
volVectorField::Boundary & | fDBF () |
Return non-const force density at boundary field reference. More... | |
volScalarField::Boundary & | rhoNBF () |
Return non-const number density boundary field reference. More... | |
volScalarField::Boundary & | rhoMBF () |
Return non-const mass density boundary field reference. More... | |
volScalarField::Boundary & | linearKEBF () |
Return non-const linear kinetic energy density boundary. More... | |
volScalarField::Boundary & | internalEBF () |
Return non-const internal energy density boundary field. More... | |
volScalarField::Boundary & | iDofBF () |
Return non-const internal degree of freedom density boundary. More... | |
volVectorField::Boundary & | momentumBF () |
Return non-const momentum density boundary field reference. More... | |
const volScalarField & | boundaryT () const |
Return macroscopic temperature. More... | |
const volVectorField & | boundaryU () const |
Return macroscopic velocity. More... | |
const volScalarField & | q () const |
Return heat flux at surface field. More... | |
const volVectorField & | fD () const |
Return force density at surface field. More... | |
const volScalarField & | rhoN () const |
Return the real particle number density field. More... | |
const volScalarField & | rhoM () const |
Return the particle mass density field. More... | |
const volScalarField & | dsmcRhoN () const |
Return the field of number of DSMC particles. More... | |
const volScalarField & | linearKE () const |
Return the total linear kinetic energy (translational and. More... | |
const volScalarField & | internalE () const |
Return the internal energy density field. More... | |
const volScalarField & | iDof () const |
Return the average internal degrees of freedom field. More... | |
const volVectorField & | momentum () const |
Return the momentum density field. More... | |
vector | equipartitionLinearVelocity (scalar temperature, scalar mass) |
Generate a random velocity sampled from the Maxwellian speed. More... | |
scalar | equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom) |
Generate a random internal energy, sampled from the. More... | |
scalar | maxwellianAverageSpeed (scalar temperature, scalar mass) const |
Average particle speed. More... | |
scalarField | maxwellianAverageSpeed (scalarField temperature, scalar mass) const |
scalar | maxwellianRMSSpeed (scalar temperature, scalar mass) const |
RMS particle speed. More... | |
scalarField | maxwellianRMSSpeed (scalarField temperature, scalar mass) const |
scalar | maxwellianMostProbableSpeed (scalar temperature, scalar mass) const |
Most probable speed. More... | |
scalarField | maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const |
const BinaryCollisionModel< DSMCCloud< ParcelType > > & | binaryCollision () const |
Return reference to binary elastic collision model. More... | |
BinaryCollisionModel< DSMCCloud< ParcelType > > & | binaryCollision () |
Return non-const reference to binary elastic collision model. More... | |
const WallInteractionModel< DSMCCloud< ParcelType > > & | wallInteraction () const |
Return reference to wall interaction model. More... | |
WallInteractionModel< DSMCCloud< ParcelType > > & | wallInteraction () |
Return non-const reference to wall interaction model. More... | |
const InflowBoundaryModel< DSMCCloud< ParcelType > > & | inflowBoundary () const |
Return reference to wall interaction model. More... | |
InflowBoundaryModel< DSMCCloud< ParcelType > > & | inflowBoundary () |
Return non-const reference to wall interaction model. More... | |
scalar | massInSystem () const |
Total mass in system. More... | |
vector | linearMomentumOfSystem () const |
Total linear momentum of the system. More... | |
scalar | linearKineticEnergyOfSystem () const |
Total linear kinetic energy in the system. More... | |
scalar | internalEnergyOfSystem () const |
Total internal energy in the system. More... | |
void | info () const |
Print cloud information. More... | |
void | dumpParticlePositions () const |
Dump particle positions to .obj file. More... | |
void | addNewParcel (const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId) |
Add new parcel. More... | |
void | evolve () |
Evolve the cloud (move, collide) More... | |
void | clear () |
Clear the Cloud. More... | |
Public Member Functions inherited from Cloud< ParticleType > | |
TypeName ("Cloud") | |
Runtime type information. More... | |
Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles) | |
Construct from mesh and a list of particles. More... | |
Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true) | |
Construct from mesh by reading from file with given cloud instance. More... | |
const polyMesh & | pMesh () const |
Return the polyMesh reference. More... | |
virtual label | nParcels () const |
Return the number of particles in the cloud. More... | |
DynamicList< label > & | labels () const |
Return temporary addressing. More... | |
void | addParticle (ParticleType *pPtr) |
Transfer particle to cloud. More... | |
void | deleteParticle (ParticleType &p) |
Remove particle from cloud and delete. More... | |
void | deleteLostParticles () |
Remove lost particles from cloud and delete. More... | |
void | cloudReset (const Cloud< ParticleType > &c) |
Reset the particles. More... | |
template<class TrackCloudType > | |
void | move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime) |
Move the particles. More... | |
void | autoMap (const mapPolyMesh &) |
Remap the cells of particles corresponding to the. More... | |
IOobject | fieldIOobject (const word &fieldName, const IOobject::readOption r) const |
Helper to construct IOobject for field and current time. More... | |
template<class DataType > | |
void | checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const |
Check lagrangian data field. More... | |
template<class DataType > | |
void | checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const |
Check lagrangian data fieldfield. More... | |
template<class Type > | |
bool | readStoreFile (const IOobject &io, const IOobject &ioNew) const |
Helper function to store a cloud field on its registry. More... | |
void | readFromFiles (objectRegistry &obr, const wordRes &selectFields) const |
Read from files into objectRegistry. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
void | writePositions () const |
Write positions to <cloudName>_positions.obj file. More... | |
void | storeGlobalPositions () const |
Call this before a topology change. More... | |
Public Member Functions inherited from DSMCBaseCloud | |
TypeName ("DSMCBaseCloud") | |
Runtime type information. More... | |
DSMCBaseCloud ()=default | |
Null constructor. More... | |
virtual | ~DSMCBaseCloud ()=default |
Destructor. More... | |
Public Member Functions inherited from reactingMultiphaseCloud | |
TypeName ("reactingMultiphaseCloud") | |
Runtime type information. More... | |
reactingMultiphaseCloud ()=default | |
Null constructor. More... | |
virtual | ~reactingMultiphaseCloud ()=default |
Destructor. More... | |
Protected Member Functions | |
void | setModels () |
Set cloud sub-models. More... | |
void | cloudReset (ReactingMultiphaseCloud< CloudType > &c) |
Reset state of cloud. More... | |
Protected Attributes | |
parcelType::constantProperties | constProps_ |
Parcel constant properties. More... | |
autoPtr< DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > > | devolatilisationModel_ |
Devolatilisation model. More... | |
autoPtr< SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > > | surfaceReactionModel_ |
Surface reaction model. More... | |
scalar | dMassDevolatilisation_ |
Total mass transferred to continuous phase via devolatilisation. More... | |
scalar | dMassSurfaceReaction_ |
Total mass transferred to continuous phase via surface. More... | |
Protected Attributes inherited from Cloud< ParticleType > | |
cloud::geometryType | geometryType_ |
Geometry type. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from Cloud< ParticleType > | |
static word | cloudPropertiesName |
Name of cloud properties dictionary. More... | |
Templated base class for multiphase reacting cloud.
Definition at line 68 of file ReactingMultiphaseCloud.H.
Type of cloud this cloud was instantiated for.
Definition at line 78 of file ReactingMultiphaseCloud.H.
typedef CloudType::particleType parcelType |
Type of parcel the cloud was instantiated for.
Definition at line 81 of file ReactingMultiphaseCloud.H.
Convenience typedef for this cloud type.
Definition at line 84 of file ReactingMultiphaseCloud.H.
ReactingMultiphaseCloud | ( | const word & | cloudName, |
const volScalarField & | rho, | ||
const volVectorField & | U, | ||
const dimensionedVector & | g, | ||
const SLGThermo & | thermo, | ||
bool | readFields = true |
||
) |
Construct given carrier gas fields.
Definition at line 79 of file ReactingMultiphaseCloud.C.
ReactingMultiphaseCloud | ( | ReactingMultiphaseCloud< CloudType > & | c, |
const word & | name | ||
) |
Copy constructor with new name.
Definition at line 117 of file ReactingMultiphaseCloud.C.
ReactingMultiphaseCloud | ( | const fvMesh & | mesh, |
const word & | name, | ||
const ReactingMultiphaseCloud< CloudType > & | c | ||
) |
Copy constructor with new name - creates bare cloud.
Definition at line 135 of file ReactingMultiphaseCloud.C.
|
virtual |
Destructor.
Definition at line 155 of file ReactingMultiphaseCloud.C.
|
protected |
Set cloud sub-models.
Definition at line 37 of file ReactingMultiphaseCloud.C.
|
protected |
Reset state of cloud.
Definition at line 61 of file ReactingMultiphaseCloud.C.
|
inlinevirtual |
Construct and return clone based on (this) with new name.
Definition at line 185 of file ReactingMultiphaseCloud.H.
|
inlinevirtual |
Construct and return bare clone based on (this) with new name.
Definition at line 194 of file ReactingMultiphaseCloud.H.
|
inline |
Return a reference to the cloud copy.
Definition at line 32 of file ReactingMultiphaseCloudI.H.
|
inline |
Return the constant properties.
Definition at line 40 of file ReactingMultiphaseCloudI.H.
|
inline |
Return access to the constant properties.
Definition at line 48 of file ReactingMultiphaseCloudI.H.
|
inline |
Return const access to devolatilisation model.
|
inline |
Return reference to devolatilisation model.
|
inline |
Return const access to reacting surface reaction model.
|
inline |
Return reference to reacting surface reaction model.
void setParcelThermoProperties | ( | parcelType & | parcel, |
const scalar | lagrangianDt | ||
) |
Set parcel thermo properties.
Definition at line 163 of file ReactingMultiphaseCloud.C.
void checkParcelProperties | ( | parcelType & | parcel, |
const scalar | lagrangianDt, | ||
const bool | fullyDescribed | ||
) |
Check parcel properties.
Definition at line 197 of file ReactingMultiphaseCloud.C.
void storeState | ( | ) |
Store the current cloud state.
Definition at line 234 of file ReactingMultiphaseCloud.C.
void restoreState | ( | ) |
Reset the current cloud to the previously stored state.
Definition at line 247 of file ReactingMultiphaseCloud.C.
void resetSourceTerms | ( | ) |
Reset the cloud source terms.
Definition at line 255 of file ReactingMultiphaseCloud.C.
void evolve | ( | ) |
Evolve the cloud.
Definition at line 262 of file ReactingMultiphaseCloud.C.
|
virtual |
Remap the cells of particles corresponding to the.
mesh topology change with a default tracking data object
Reimplemented from DSMCCloud< ParcelType >.
Definition at line 275 of file ReactingMultiphaseCloud.C.
void info | ( | ) |
Print cloud information.
Definition at line 286 of file ReactingMultiphaseCloud.C.
|
virtual |
Write the field data for the cloud.
Reimplemented from Cloud< ParticleType >.
Definition at line 296 of file ReactingMultiphaseCloud.C.
|
protected |
Parcel constant properties.
Definition at line 109 of file ReactingMultiphaseCloud.H.
|
protected |
Devolatilisation model.
Definition at line 119 of file ReactingMultiphaseCloud.H.
|
protected |
Surface reaction model.
Definition at line 126 of file ReactingMultiphaseCloud.H.
|
protected |
Total mass transferred to continuous phase via devolatilisation.
Definition at line 132 of file ReactingMultiphaseCloud.H.
|
protected |
Total mass transferred to continuous phase via surface.
reactions
Definition at line 136 of file ReactingMultiphaseCloud.H.