Templated base class for 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 ReactingCloud< CloudType > | reactingCloudType |
Convenience typedef for this cloud type. More... | |
![]() | |
typedef ParcelType | parcelType |
Type of parcel the cloud was instantiated for. More... | |
![]() | |
typedef ParticleType | particleType |
typedef IDLList< ParticleType >::iterator | iterator |
typedef IDLList< ParticleType >::const_iterator | const_iterator |
Public Member Functions | |
ReactingCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &thermo, bool readFields=true) | |
Construct given carrier gas fields. More... | |
ReactingCloud (ReactingCloud< CloudType > &c, const word &name) | |
Copy constructor with new name. More... | |
ReactingCloud (const fvMesh &mesh, const word &name, const ReactingCloud< 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 | ~ReactingCloud () |
Destructor. More... | |
const ReactingCloud & | 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 CompositionModel< ReactingCloud< CloudType > > & | composition () const |
Return const access to reacting composition model. More... | |
const PhaseChangeModel< ReactingCloud< CloudType > > & | phaseChange () const |
Return const access to reacting phase change model. More... | |
PhaseChangeModel< ReactingCloud< CloudType > > & | phaseChange () |
Return reference to reacting phase change model. More... | |
DimensionedField< scalar, volMesh > & | rhoTrans (const label i) |
Mass. More... | |
const PtrList< DimensionedField< scalar, volMesh > > & | rhoTrans () const |
Return const access to mass source fields. More... | |
PtrList< DimensionedField< scalar, volMesh > > & | rhoTrans () |
Return reference to mass source fields. More... | |
tmp< fvScalarMatrix > | SYi (const label i, volScalarField &Yi) const |
Return mass source term for specie i - specie eqn. More... | |
tmp< DimensionedField< scalar, volMesh > > | Srho (const label i) const |
Return tmp mass source for field i - fully explicit. More... | |
tmp< DimensionedField< scalar, volMesh > > | Srho () const |
Return tmp total mass source for carrier phase. More... | |
tmp< fvScalarMatrix > | Srho (volScalarField &rho) const |
Return total mass source term [kg/m3/s]. 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 | relaxSources (const ReactingCloud< CloudType > &cloudOldTime) |
Apply relaxation to (steady state) cloud sources. More... | |
void | scaleSources () |
Apply scaling to (transient) cloud sources. 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... | |
![]() | |
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 refernce 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 refernce to the random object. More... | |
volScalarField::GeometricBoundaryField & | qBF () |
Return non-const heat flux boundary field reference. More... | |
volVectorField::GeometricBoundaryField & | fDBF () |
Return non-const force density at boundary field reference. More... | |
volScalarField::GeometricBoundaryField & | rhoNBF () |
Return non-const number density boundary field reference. More... | |
volScalarField::GeometricBoundaryField & | rhoMBF () |
Return non-const mass density boundary field reference. More... | |
volScalarField::GeometricBoundaryField & | linearKEBF () |
Return non-const linear kinetic energy density boundary. More... | |
volScalarField::GeometricBoundaryField & | internalEBF () |
Return non-const internal energy density boundary field. More... | |
volScalarField::GeometricBoundaryField & | iDofBF () |
Return non-const internal degree of freedom density boundary. More... | |
volVectorField::GeometricBoundaryField & | 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 vector &U, const scalar Ei, const label cellI, const label tetFaceI, const label tetPtI, const label typeId) |
Add new parcel. More... | |
void | evolve () |
Evolve the cloud (move, collide) More... | |
void | clear () |
Clear the Cloud. More... | |
![]() | |
TypeName ("Cloud") | |
Runtime type information. More... | |
Cloud (const polyMesh &mesh, const IDLList< ParticleType > &particles) | |
Construct from mesh and a list of particles. More... | |
Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles) | |
Construct from mesh, cloud name, and a list of particles. More... | |
Cloud (const polyMesh &mesh, const bool checkClass=true) | |
Construct from mesh by reading from file. 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... | |
label | size () const |
DynamicList< label > & | labels () |
label | nTrackingRescues () const |
Return nTrackingRescues. More... | |
void | trackingRescue () const |
Increment the nTrackingRescues counter. More... | |
const PackedBoolList & | cellHasWallFaces () const |
Whether each cell has any wall faces (demand driven data) More... | |
virtual bool | hasWallImpactDistance () const |
Switch to specify if particles of the cloud can return. More... | |
const const_iterator | begin () const |
iterator | begin () |
const const_iterator | cbegin () const |
const const_iterator | end () const |
iterator | end () |
const const_iterator | cend () const |
void | clear () |
void | addParticle (ParticleType *pPtr) |
Transfer particle to cloud. More... | |
void | deleteParticle (ParticleType &) |
Remove particle from cloud and delete. More... | |
void | cloudReset (const Cloud< ParticleType > &c) |
Reset the particles. More... | |
void | move (TrackData &td, const scalar trackTime) |
Move the particles. More... | |
void | autoMap (TrackData &td, 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... | |
void | checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const |
Check lagrangian data field. More... | |
void | checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const |
Check lagrangian data fieldfield. More... | |
virtual void | readFields () |
Read the field data for the cloud of particles. Dummy at. More... | |
virtual void | writeFields () const |
Write the field data for the cloud of particles Dummy at. More... | |
virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const |
Write using given format, version and compression. More... | |
void | writePositions () const |
Write positions to <cloudName>_positions.obj file. More... | |
![]() | |
TypeName ("DSMCBaseCloud") | |
Runtime type information. More... | |
DSMCBaseCloud () | |
Null constructor. More... | |
virtual | ~DSMCBaseCloud () |
Destructor. More... | |
![]() | |
TypeName ("reactingCloud") | |
Runtime type information. More... | |
reactingCloud () | |
Null constructor. More... | |
virtual | ~reactingCloud () |
Destructor. More... | |
Protected Member Functions | |
void | checkSuppliedComposition (const scalarField &YSupplied, const scalarField &Y, const word &YName) |
Check that size of a composition field is valid. More... | |
void | setModels () |
Set cloud sub-models. More... | |
void | cloudReset (ReactingCloud< CloudType > &c) |
Reset state of cloud. More... | |
Protected Attributes | |
parcelType::constantProperties | constProps_ |
Parcel constant properties. More... | |
autoPtr< CompositionModel< ReactingCloud< CloudType > > > | compositionModel_ |
Reacting composition model. More... | |
autoPtr< PhaseChangeModel< ReactingCloud< CloudType > > > | phaseChangeModel_ |
Reacting phase change model. More... | |
PtrList< DimensionedField< scalar, volMesh > > | rhoTrans_ |
Mass transfer fields - one per carrier phase specie. More... | |
Private Member Functions | |
ReactingCloud (const ReactingCloud &) | |
Disallow default bitwise copy construct. More... | |
void | operator= (const ReactingCloud &) |
Disallow default bitwise assignment. More... | |
Private Attributes | |
autoPtr< ReactingCloud< CloudType > > | cloudCopyPtr_ |
Cloud copy pointer. More... | |
Additional Inherited Members | |
![]() | |
static word | cloudPropertiesName |
Name of cloud properties dictionary. More... | |
Templated base class for reacting cloud.
Definition at line 62 of file ReactingCloud.H.
Type of cloud this cloud was instantiated for.
Definition at line 72 of file ReactingCloud.H.
typedef CloudType::particleType parcelType |
Type of parcel the cloud was instantiated for.
Definition at line 75 of file ReactingCloud.H.
typedef ReactingCloud<CloudType> reactingCloudType |
Convenience typedef for this cloud type.
Definition at line 78 of file ReactingCloud.H.
|
private |
Disallow default bitwise copy construct.
Referenced by ReactingCloud< CloudType >::clone(), and ReactingCloud< CloudType >::cloneBare().
ReactingCloud | ( | 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 90 of file ReactingCloud.C.
References composition, Foam::dimMass, forAll, mesh, Foam::name(), readFields(), and timeName.
ReactingCloud | ( | ReactingCloud< CloudType > & | c, |
const word & | name | ||
) |
Copy constructor with new name.
Definition at line 149 of file ReactingCloud.C.
References Foam::constant::universal::c, forAll, Foam::name(), thermo, and timeName.
ReactingCloud | ( | const fvMesh & | mesh, |
const word & | name, | ||
const ReactingCloud< CloudType > & | c | ||
) |
Copy constructor with new name - creates bare cloud.
Definition at line 188 of file ReactingCloud.C.
|
virtual |
Destructor.
Definition at line 208 of file ReactingCloud.C.
|
private |
Disallow default bitwise assignment.
|
protected |
Check that size of a composition field is valid.
Definition at line 58 of file ReactingCloud.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Y.
|
protected |
Set cloud sub-models.
Definition at line 34 of file ReactingCloud.C.
References Foam::compressible::New().
|
protected |
Reset state of cloud.
Definition at line 77 of file ReactingCloud.C.
References Foam::constant::universal::c.
|
inlinevirtual |
Construct and return clone based on (this) with new name.
Definition at line 175 of file ReactingCloud.H.
References Foam::name(), and ReactingCloud< CloudType >::ReactingCloud().
|
inlinevirtual |
Construct and return bare clone based on (this) with new name.
Definition at line 184 of file ReactingCloud.H.
References DSMCCloud< ParcelType >::mesh(), and ReactingCloud< CloudType >::ReactingCloud().
|
inline |
Return a reference to the cloud copy.
Definition at line 30 of file ReactingCloudI.H.
|
inline |
Return the constant properties.
Definition at line 38 of file ReactingCloudI.H.
|
inline |
Return access to the constant properties.
|
inline |
Return const access to reacting composition model.
Definition at line 54 of file ReactingCloudI.H.
|
inline |
Return const access to reacting phase change model.
Definition at line 62 of file ReactingCloudI.H.
|
inline |
Return reference to reacting phase change model.
|
inline |
Mass.
Return reference to mass source for field i
Definition at line 78 of file ReactingCloudI.H.
Referenced by ReactingCloud< CloudType >::relaxSources().
|
inline |
Return const access to mass source fields.
Definition at line 87 of file ReactingCloudI.H.
|
inline |
Return reference to mass source fields.
|
inline |
Return mass source term for specie i - specie eqn.
Definition at line 103 of file ReactingCloudI.H.
References Foam::dimless, Foam::dimMass, Foam::dimTime, Foam::dimVolume, GeometricField::internalField(), mesh, Foam::name(), Foam::neg(), Foam::pos(), fvMatrix::source(), Foam::fvc::Sp(), and timeName.
|
inline |
Return tmp mass source for field i - fully explicit.
Definition at line 158 of file ReactingCloudI.H.
References Foam::dimTime, Foam::dimVolume, mesh, Foam::name(), and timeName.
|
inline |
Return tmp total mass source for carrier phase.
Definition at line 195 of file ReactingCloudI.H.
References Foam::dimTime, Foam::dimVolume, forAll, mesh, Foam::name(), and timeName.
|
inline |
Return total mass source term [kg/m3/s].
Definition at line 237 of file ReactingCloudI.H.
References Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, mesh, Foam::name(), rho, fvMatrix::source(), Foam::fvc::SuSp(), and timeName.
void setParcelThermoProperties | ( | parcelType & | parcel, |
const scalar | lagrangianDt | ||
) |
Set parcel thermo properties.
Definition at line 216 of file ReactingCloud.C.
References composition, and thermo.
void checkParcelProperties | ( | parcelType & | parcel, |
const scalar | lagrangianDt, | ||
const bool | fullyDescribed | ||
) |
void storeState |
Store the current cloud state.
Definition at line 254 of file ReactingCloud.C.
References Foam::name().
void restoreState |
Reset the current cloud to the previously stored state.
Definition at line 267 of file ReactingCloud.C.
void resetSourceTerms |
void relaxSources | ( | const ReactingCloud< CloudType > & | cloudOldTime | ) |
Apply relaxation to (steady state) cloud sources.
Definition at line 287 of file ReactingCloud.C.
References forAll, relax(), and ReactingCloud< CloudType >::rhoTrans().
void scaleSources |
Apply scaling to (transient) cloud sources.
Definition at line 305 of file ReactingCloud.C.
References forAll.
void evolve |
Evolve the cloud.
Definition at line 320 of file ReactingCloud.C.
References solve().
|
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 333 of file ReactingCloud.C.
void info |
|
virtual |
Write the field data for the cloud.
Definition at line 355 of file ReactingCloud.C.
References composition.
|
private |
Cloud copy pointer.
Definition at line 86 of file ReactingCloud.H.
|
protected |
Parcel constant properties.
Definition at line 103 of file ReactingCloud.H.
|
protected |
Reacting composition model.
Definition at line 110 of file ReactingCloud.H.
|
protected |
Reacting phase change model.
Definition at line 114 of file ReactingCloud.H.
|
protected |
Mass transfer fields - one per carrier phase specie.
Definition at line 120 of file ReactingCloud.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.