Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ReactingCloud< CloudType > Class Template Reference
Lagrangian particle models » Clouds

Templated base class for reacting cloud. More...

Inheritance diagram for ReactingCloud< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for ReactingCloud< CloudType >:
Collaboration graph
[legend]

Public Types

typedef CloudType cloudType
 
typedef CloudType::particleType parcelType
 
typedef ReactingCloud< CloudType > reactingCloudType
 
- Public Types inherited from DSMCCloud< ParcelType >
typedef ParcelType parcelType
 
- Public Types inherited from Cloud
typedef ParticleType particleType
 
typedef ParticleType parcelType
 

Public Member Functions

 ReactingCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &thermo, bool readFields=true)
 
 ReactingCloud (ReactingCloud< CloudType > &c, const word &name)
 
 ReactingCloud (const fvMesh &mesh, const word &name, const ReactingCloud< CloudType > &c)
 
virtual autoPtr< Cloud< parcelType > > clone (const word &name)
 
virtual autoPtr< Cloud< parcelType > > cloneBare (const word &name) const
 
virtual ~ReactingCloud ()=default
 
const ReactingCloud & cloudCopy () const
 
const parcelType::constantProperties & constProps () const
 
parcelType::constantProperties & constProps ()
 
const CompositionModel< ReactingCloud< CloudType > > & composition () const
 
const PhaseChangeModel< ReactingCloud< CloudType > > & phaseChange () const
 
PhaseChangeModel< ReactingCloud< CloudType > > & phaseChange ()
 
volScalarField::Internal & rhoTrans (const label i)
 
const PtrList< volScalarField::Internal > & rhoTrans () const
 
PtrList< volScalarField::Internal > & rhoTrans ()
 
tmp< fvScalarMatrix > SYi (const label i, volScalarField &Yi) const
 
tmp< volScalarField::Internal > Srho (const label i) const
 
tmp< volScalarField::Internal > Srho () const
 
tmp< fvScalarMatrix > Srho (volScalarField &rho) const
 
void setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt)
 
void checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed)
 
void storeState ()
 
void restoreState ()
 
void resetSourceTerms ()
 
void relaxSources (const ReactingCloud< CloudType > &cloudOldTime)
 
void scaleSources ()
 
void evolve ()
 
virtual void autoMap (const mapPolyMesh &)
 
void info ()
 
virtual void writeFields () const
 
virtual void writeObjects (objectRegistry &obr) const
 
- Public Member Functions inherited from DSMCCloud< ParcelType >
 DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true)
 
 DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict)
 
virtual ~DSMCCloud ()
 
const word & cloudName () const
 
const fvMesh & mesh () const
 
const IOdictionary & particleProperties () const
 
const List< word > & typeIdList () const
 
scalar nParticle () const
 
const List< DynamicList< ParcelType * > > & cellOccupancy () const
 
volScalarField & sigmaTcRMax ()
 
scalarField & collisionSelectionRemainder ()
 
const List< typename ParcelType::constantProperties > & constProps () const
 
const ParcelType::constantProperties & constProps (label typeId) const
 
Random & rndGen ()
 
volScalarField::Boundary & qBF ()
 
volVectorField::Boundary & fDBF ()
 
volScalarField::Boundary & rhoNBF ()
 
volScalarField::Boundary & rhoMBF ()
 
volScalarField::Boundary & linearKEBF ()
 
volScalarField::Boundary & internalEBF ()
 
volScalarField::Boundary & iDofBF ()
 
volVectorField::Boundary & momentumBF ()
 
const volScalarField & boundaryT () const
 
const volVectorField & boundaryU () const
 
const volScalarField & q () const
 
const volVectorField & fD () const
 
const volScalarField & rhoN () const
 
const volScalarField & rhoM () const
 
const volScalarField & dsmcRhoN () const
 
const volScalarField & linearKE () const
 
const volScalarField & internalE () const
 
const volScalarField & iDof () const
 
const volVectorField & momentum () const
 
vector equipartitionLinearVelocity (scalar temperature, scalar mass)
 
scalar equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom)
 
scalar maxwellianAverageSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianAverageSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianRMSSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianRMSSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianMostProbableSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const
 
const BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision () const
 
BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision ()
 
const WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction () const
 
WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction ()
 
const InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary () const
 
InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary ()
 
scalar massInSystem () const
 
vector linearMomentumOfSystem () const
 
scalar linearKineticEnergyOfSystem () const
 
scalar internalEnergyOfSystem () const
 
void info () const
 
void dumpParticlePositions () const
 
void addNewParcel (const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId)
 
void evolve ()
 
void clear ()
 
- Public Member Functions inherited from Cloud
 TypeName ("Cloud")
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles)
 
 Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
 
const polyMesh & pMesh () const
 
virtual label nParcels () const
 
DynamicList< label > & labels () const
 
void addParticle (ParticleType *pPtr)
 
void deleteParticle (ParticleType &p)
 
void deleteLostParticles ()
 
void cloudReset (const Cloud< ParticleType > &c)
 
template<class TrackCloudType >
void move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime)
 
void autoMap (const mapPolyMesh &)
 
IOobject fieldIOobject (const word &fieldName, const IOobject::readOption r) const
 
template<class DataType >
void checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const
 
template<class DataType >
void checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const
 
template<class Type >
bool readStoreFile (const IOobject &io, const IOobject &ioNew) const
 
void readFromFiles (objectRegistry &obr, const wordRes &selectFields) const
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
void writePositions () const
 
void storeGlobalPositions () const
 
- Public Member Functions inherited from DSMCBaseCloud
 TypeName ("DSMCBaseCloud")
 
 DSMCBaseCloud ()=default
 
virtual ~DSMCBaseCloud ()=default
 
- Public Member Functions inherited from reactingCloud
 TypeName ("reactingCloud")
 
 reactingCloud ()=default
 
virtual ~reactingCloud ()=default
 

Protected Member Functions

void checkSuppliedComposition (const scalarField &YSupplied, const scalarField &Y, const word &YName)
 
void setModels ()
 
void cloudReset (ReactingCloud< CloudType > &c)
 

Protected Attributes

parcelType::constantProperties constProps_
 
autoPtr< CompositionModel< ReactingCloud< CloudType > > > compositionModel_
 
autoPtr< PhaseChangeModel< ReactingCloud< CloudType > > > phaseChangeModel_
 
PtrList< volScalarField::Internal > rhoTrans_
 
- Protected Attributes inherited from Cloud
cloud::geometryType geometryType_
 

Additional Inherited Members

- Static Public Attributes inherited from Cloud
static word cloudPropertiesName
 

Detailed Description

template<class CloudType>
class Foam::ReactingCloud< CloudType >

Templated base class for reacting cloud.

Source files

Definition at line 64 of file ReactingCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Definition at line 74 of file ReactingCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Definition at line 77 of file ReactingCloud.H.

◆ reactingCloudType

typedef ReactingCloud<CloudType> reactingCloudType

Definition at line 80 of file ReactingCloud.H.

Constructor & Destructor Documentation

◆ ReactingCloud() [1/3]

ReactingCloud ( const word &  cloudName,
const volScalarField &  rho,
const volVectorField &  U,
const dimensionedVector &  g,
const SLGThermo &  thermo,
bool  readFields = true 
)

Definition at line 85 of file ReactingCloud.C.

References composition, Foam::dimMass, forAll, mesh, Foam::name(), Foam::readFields(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ ReactingCloud() [2/3]

ReactingCloud ( ReactingCloud< CloudType > &  c,
const word &  name 
)

Definition at line 145 of file ReactingCloud.C.

References Foam::constant::universal::c, forAll, Foam::name(), thermo, and timeName.

Here is the call graph for this function:

◆ ReactingCloud() [3/3]

ReactingCloud ( const fvMesh &  mesh,
const word &  name,
const ReactingCloud< CloudType > &  c 
)

Definition at line 184 of file ReactingCloud.C.

◆ ~ReactingCloud()

virtual ~ReactingCloud ( )
virtualdefault

Member Function Documentation

◆ checkSuppliedComposition()

void checkSuppliedComposition ( const scalarField &  YSupplied,
const scalarField &  Y,
const word &  YName 
)
protected

Definition at line 53 of file ReactingCloud.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Y.

Here is the call graph for this function:

◆ setModels()

void setModels
protected

Definition at line 29 of file ReactingCloud.C.

References Foam::New().

Here is the call graph for this function:

◆ cloudReset()

void cloudReset ( ReactingCloud< CloudType > &  c)
protected

Definition at line 72 of file ReactingCloud.C.

References Foam::constant::universal::c.

◆ clone()

virtual autoPtr<Cloud<parcelType> > clone ( const word &  name)
inlinevirtual

Definition at line 177 of file ReactingCloud.H.

References Foam::name().

Here is the call graph for this function:

◆ cloneBare()

virtual autoPtr<Cloud<parcelType> > cloneBare ( const word &  name) const
inlinevirtual

Definition at line 186 of file ReactingCloud.H.

References DSMCCloud< ParcelType >::mesh().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::ReactingCloud< CloudType > & cloudCopy
inline

Definition at line 25 of file ReactingCloudI.H.

◆ constProps() [1/2]

CloudType::particleType::constantProperties & constProps
inline

Definition at line 33 of file ReactingCloudI.H.

◆ constProps() [2/2]

parcelType::constantProperties& constProps ( )
inline

◆ composition()

const Foam::CompositionModel< Foam::ReactingCloud< CloudType > > & composition
inline

Definition at line 49 of file ReactingCloudI.H.

◆ phaseChange() [1/2]

Foam::PhaseChangeModel< Foam::ReactingCloud< CloudType > > & phaseChange
inline

Definition at line 57 of file ReactingCloudI.H.

◆ phaseChange() [2/2]

PhaseChangeModel<ReactingCloud<CloudType> >& phaseChange ( )
inline

◆ rhoTrans() [1/3]

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & rhoTrans ( const label  i)
inline

Definition at line 73 of file ReactingCloudI.H.

Referenced by ReactingCloud< CloudType >::relaxSources().

Here is the caller graph for this function:

◆ rhoTrans() [2/3]

Foam::PtrList< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > & rhoTrans
inline

Definition at line 82 of file ReactingCloudI.H.

◆ rhoTrans() [3/3]

PtrList<volScalarField::Internal>& rhoTrans ( )
inline

◆ SYi()

Foam::tmp< Foam::fvScalarMatrix > SYi ( const label  i,
volScalarField &  Yi 
) const
inline

Definition at line 98 of file ReactingCloudI.H.

References coupled(), Foam::dimless, Foam::dimMass, Foam::dimTime, Foam::dimVolume, mesh, Foam::name(), Foam::neg(), Foam::New(), Foam::pos0(), GeometricField::primitiveFieldRef(), tmp::ref(), fvMatrix::source(), Sp, timeName, and Foam::Zero.

Here is the call graph for this function:

◆ Srho() [1/3]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Srho ( const label  i) const
inline

Definition at line 153 of file ReactingCloudI.H.

References coupled(), Foam::dimTime, Foam::dimVolume, mesh, Foam::name(), tmp::ref(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ Srho() [2/3]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Srho
inline

Definition at line 188 of file ReactingCloudI.H.

References coupled(), Foam::dimTime, Foam::dimVolume, forAll, mesh, Foam::name(), tmp::ref(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ Srho() [3/3]

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

Definition at line 228 of file ReactingCloudI.H.

References coupled(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, mesh, Foam::name(), Foam::New(), tmp::ref(), rho, fvMatrix::source(), Foam::fam::SuSp(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ setParcelThermoProperties()

void setParcelThermoProperties ( parcelType &  parcel,
const scalar  lagrangianDt 
)

Definition at line 204 of file ReactingCloud.C.

References composition.

◆ checkParcelProperties()

void checkParcelProperties ( parcelType &  parcel,
const scalar  lagrangianDt,
const bool  fullyDescribed 
)

Definition at line 217 of file ReactingCloud.C.

References composition.

◆ storeState()

void storeState

Definition at line 241 of file ReactingCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Definition at line 254 of file ReactingCloud.C.

◆ resetSourceTerms()

void resetSourceTerms

Definition at line 262 of file ReactingCloud.C.

References forAll.

◆ relaxSources()

void relaxSources ( const ReactingCloud< CloudType > &  cloudOldTime)

Definition at line 274 of file ReactingCloud.C.

References forAll, relax(), and ReactingCloud< CloudType >::rhoTrans().

Here is the call graph for this function:

◆ scaleSources()

void scaleSources

Definition at line 292 of file ReactingCloud.C.

References forAll.

◆ evolve()

void evolve

Definition at line 307 of file ReactingCloud.C.

References solve().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const mapPolyMesh &  mapper)
virtual

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 319 of file ReactingCloud.C.

◆ info()

void info

Definition at line 328 of file ReactingCloud.C.

References Foam::Info.

◆ writeFields()

void writeFields
virtual

Reimplemented from Cloud.

Definition at line 337 of file ReactingCloud.C.

References composition, and Foam::writeFields().

Here is the call graph for this function:

◆ writeObjects()

void writeObjects ( objectRegistry &  obr) const
virtual

Definition at line 347 of file ReactingCloud.C.

References composition.

Member Data Documentation

◆ constProps_

parcelType::constantProperties constProps_
protected

Definition at line 105 of file ReactingCloud.H.

◆ compositionModel_

autoPtr<CompositionModel<ReactingCloud<CloudType> > > compositionModel_
protected

Definition at line 112 of file ReactingCloud.H.

◆ phaseChangeModel_

autoPtr<PhaseChangeModel<ReactingCloud<CloudType> > > phaseChangeModel_
protected

Definition at line 116 of file ReactingCloud.H.

◆ rhoTrans_

PtrList<volScalarField::Internal> rhoTrans_
protected

Definition at line 122 of file ReactingCloud.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17