Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ReactingParcel< ParcelType > Class Template Reference

Reacting parcel class with one/two-way coupling with the continuous phase. More...

Inheritance diagram for ReactingParcel< ParcelType >:
Inheritance graph
[legend]
Collaboration diagram for ReactingParcel< ParcelType >:
Collaboration graph
[legend]

Classes

class  constantProperties
 Class to hold reacting parcel constant properties. More...
 
class  iNew
 Factory class to read-construct particles used for. More...
 
class  TrackingData
 

Public Member Functions

 TypeName ("ReactingParcel")
 Runtime type information. More...
 
 AddToPropertyList (ParcelType, " mass0"+" nPhases(Y1..YN)")
 String representation of properties. More...
 
 ReactingParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
 Construct from mesh, coordinates and topology. More...
 
 ReactingParcel (const polyMesh &mesh, const vector &position, const label celli)
 Construct from a position and a cell, searching for the rest of the. More...
 
 ReactingParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label typeId, const scalar nParticle0, const scalar d0, const scalar dTarget0, const vector &U0, const vector &f0, const vector &angularMomentum0, const vector &torque0, const scalarField &Y0, const constantProperties &constProps)
 Construct from components. More...
 
 ReactingParcel (const polyMesh &mesh, Istream &is, bool readFields=true)
 Construct from Istream. More...
 
 ReactingParcel (const ReactingParcel &p, const polyMesh &mesh)
 Construct as a copy. More...
 
 ReactingParcel (const ReactingParcel &p)
 Construct as a copy. More...
 
virtual autoPtr< particleclone () const
 Construct and return a (basic particle) clone. More...
 
virtual autoPtr< particleclone (const polyMesh &mesh) const
 Construct and return a (basic particle) clone. More...
 
scalar mass0 () const
 Return const access to initial mass [kg]. More...
 
const scalarFieldY () const
 Return const access to mass fractions of mixture []. More...
 
scalar pc () const
 Return the owner cell pressure [Pa]. More...
 
scalar & pc ()
 Return reference to the owner cell pressure [Pa]. More...
 
scalar & mass0 ()
 Return access to initial mass [kg]. More...
 
scalarFieldY ()
 Return access to mass fractions of mixture []. More...
 
template<class TrackData >
void setCellValues (TrackData &td, const scalar dt, const label celli)
 Set cell values. More...
 
template<class TrackData >
void cellValueSourceCorrection (TrackData &td, const scalar dt, const label celli)
 Correct cell values using latest transfer information. More...
 
template<class TrackData >
void correctSurfaceValues (TrackData &td, const label celli, const scalar T, const scalarField &Cs, scalar &rhos, scalar &mus, scalar &Prs, scalar &kappas)
 Correct surface values due to emitted species. More...
 
template<class TrackData >
void calc (TrackData &td, const scalar dt, const label celli)
 Update parcel properties over the time interval. More...
 

Static Public Member Functions

template<class CloudType , class CompositionType >
static void readFields (CloudType &c, const CompositionType &compModel)
 Read. More...
 
template<class CloudType >
static void readFields (CloudType &c)
 Read - no composition. More...
 
template<class CloudType , class CompositionType >
static void writeFields (const CloudType &c, const CompositionType &compModel)
 Write. More...
 
template<class CloudType >
static void writeFields (const CloudType &c)
 Write - composition supplied. More...
 

Protected Member Functions

template<class TrackData >
void calcPhaseChange (TrackData &td, const scalar dt, const label celli, const scalar Re, const scalar Pr, const scalar Ts, const scalar nus, const scalar d, const scalar T, const scalar mass, const label idPhase, const scalar YPhase, const scalarField &YComponents, scalarField &dMassPC, scalar &Sh, scalar &N, scalar &NCpW, scalarField &Cs)
 Calculate Phase change. More...
 
scalar updateMassFraction (const scalar mass0, const scalarField &dMass, scalarField &Y) const
 Update mass fraction. More...
 

Protected Attributes

scalar mass0_
 Initial mass [kg]. More...
 
scalarField Y_
 Mass fractions of mixture []. More...
 
scalar pc_
 Pressure [Pa]. More...
 

Friends

Ostreamoperator (Ostream &, const ReactingParcel< ParcelType > &)
 

Detailed Description

template<class ParcelType>
class Foam::ReactingParcel< ParcelType >

Reacting parcel class with one/two-way coupling with the continuous phase.

Source files

Definition at line 50 of file ReactingParcel.H.

Constructor & Destructor Documentation

◆ ReactingParcel() [1/6]

ReactingParcel ( const polyMesh mesh,
const barycentric coordinates,
const label  celli,
const label  tetFacei,
const label  tetPti 
)
inline

Construct from mesh, coordinates and topology.

Other properties initialised as null

Definition at line 64 of file ReactingParcelI.H.

Referenced by ReactingParcel< ParcelType >::constantProperties::constantProperties(), ReactingParcel< ParcelType >::ReactingParcel(), and ReactingParcel< ParcelType >::updateMassFraction().

Here is the caller graph for this function:

◆ ReactingParcel() [2/6]

ReactingParcel ( const polyMesh mesh,
const vector position,
const label  celli 
)
inline

Construct from a position and a cell, searching for the rest of the.

required topology. Other properties are initialised as null.

Definition at line 81 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::ReactingParcel().

Here is the call graph for this function:

◆ ReactingParcel() [3/6]

ReactingParcel ( const polyMesh mesh,
const barycentric coordinates,
const label  celli,
const label  tetFacei,
const label  tetPti,
const label  typeId,
const scalar  nParticle0,
const scalar  d0,
const scalar  dTarget0,
const vector U0,
const vector f0,
const vector angularMomentum0,
const vector torque0,
const scalarField Y0,
const constantProperties constProps 
)
inline

Construct from components.

Definition at line 96 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::mass0_.

◆ ReactingParcel() [4/6]

ReactingParcel ( const polyMesh mesh,
Istream is,
bool  readFields = true 
)

Construct from Istream.

Definition at line 46 of file ReactingParcelIO.C.

References IOstream::check(), IOstream::format(), Istream::read(), and DynamicList< T, SizeInc, SizeMult, SizeDiv >::transfer().

Here is the call graph for this function:

◆ ReactingParcel() [5/6]

ReactingParcel ( const ReactingParcel< ParcelType > &  p,
const polyMesh mesh 
)

Construct as a copy.

◆ ReactingParcel() [6/6]

ReactingParcel ( const ReactingParcel< ParcelType > &  p)

Construct as a copy.

Member Function Documentation

◆ calcPhaseChange()

void calcPhaseChange ( TrackData &  td,
const scalar  dt,
const label  celli,
const scalar  Re,
const scalar  Pr,
const scalar  Ts,
const scalar  nus,
const scalar  d,
const scalar  T,
const scalar  mass,
const label  idPhase,
const scalar  YPhase,
const scalarField YComponents,
scalarField dMassPC,
scalar &  Sh,
scalar &  N,
scalar &  NCpW,
scalarField Cs 
)
protected

◆ updateMassFraction()

Foam::scalar updateMassFraction ( const scalar  mass0,
const scalarField dMass,
scalarField Y 
) const
protected

Update mass fraction.

Definition at line 151 of file ReactingParcel.C.

References forAll, ReactingParcel< ParcelType >::mass0_, mesh, p, ReactingParcel< ParcelType >::pc_, ReactingParcel< ParcelType >::ReactingParcel(), ReactingParcel< ParcelType >::setCellValues(), Foam::sum(), and ReactingParcel< ParcelType >::Y_.

Referenced by ReactingParcel< ParcelType >::calcPhaseChange().

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

◆ TypeName()

TypeName ( "ReactingParcel< ParcelType >"  )

Runtime type information.

◆ AddToPropertyList()

AddToPropertyList ( ParcelType  ,
" mass0"+" nPhases(Y1..YN)"   
)

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 285 of file ReactingParcel.H.

◆ clone() [2/2]

virtual autoPtr<particle> clone ( const polyMesh mesh) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 291 of file ReactingParcel.H.

References mesh.

◆ mass0() [1/2]

Foam::scalar mass0 ( ) const
inline

Return const access to initial mass [kg].

Definition at line 161 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::mass0_.

Referenced by ReactingParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

◆ Y() [1/2]

const Foam::scalarField & Y ( ) const
inline

Return const access to mass fractions of mixture [].

Definition at line 168 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::Y_.

Referenced by ReactingParcel< ParcelType >::iNew::operator()(), and ReactingParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

◆ pc() [1/2]

Foam::scalar pc ( ) const
inline

Return the owner cell pressure [Pa].

Definition at line 175 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::pc_.

Referenced by ReactingParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

◆ pc() [2/2]

Foam::scalar & pc ( )
inline

Return reference to the owner cell pressure [Pa].

Definition at line 182 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::pc_.

◆ mass0() [2/2]

Foam::scalar & mass0 ( )
inline

Return access to initial mass [kg].

Definition at line 189 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::mass0_.

◆ Y() [2/2]

Foam::scalarField & Y ( )
inline

Return access to mass fractions of mixture [].

Definition at line 196 of file ReactingParcelI.H.

References ReactingParcel< ParcelType >::Y_.

◆ setCellValues()

void setCellValues ( TrackData &  td,
const scalar  dt,
const label  celli 
)

Set cell values.

Definition at line 206 of file ReactingParcel.C.

References ReactingParcel< ParcelType >::cellValueSourceCorrection(), coordinates(), Foam::endl(), Foam::nl, and WarningInFunction.

Referenced by ReactingParcel< ParcelType >::iNew::operator()(), and ReactingParcel< ParcelType >::updateMassFraction().

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

◆ cellValueSourceCorrection()

void cellValueSourceCorrection ( TrackData &  td,
const scalar  dt,
const label  celli 
)

Correct cell values using latest transfer information.

Definition at line 237 of file ReactingParcel.C.

References ReactingParcel< ParcelType >::correctSurfaceValues(), Foam::endl(), forAll, Foam::mag(), Foam::max(), Foam::nl, and WarningInFunction.

Referenced by ReactingParcel< ParcelType >::iNew::operator()(), and ReactingParcel< ParcelType >::setCellValues().

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

◆ correctSurfaceValues()

void correctSurfaceValues ( TrackData &  td,
const label  celli,
const scalar  T,
const scalarField Cs,
scalar &  rhos,
scalar &  mus,
scalar &  Prs,
scalar &  kappas 
)

◆ calc()

void calc ( TrackData &  td,
const scalar  dt,
const label  celli 
)

◆ readFields() [1/2]

void readFields ( CloudType c,
const CompositionType &  compModel 
)
static

◆ readFields() [2/2]

void readFields ( CloudType c)
static

Read - no composition.

Definition at line 89 of file ReactingParcelIO.C.

References Foam::readFields(), and ReactingParcel< ParcelType >::readFields().

Here is the call graph for this function:

◆ writeFields() [1/2]

void writeFields ( const CloudType c,
const CompositionType &  compModel 
)
static

◆ writeFields() [2/2]

void writeFields ( const CloudType c)
static

Write - composition supplied.

Definition at line 163 of file ReactingParcelIO.C.

References ReactingParcel< ParcelType >::writeFields().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream ,
const ReactingParcel< ParcelType > &   
)
friend

Member Data Documentation

◆ mass0_

scalar mass0_
protected

◆ Y_

scalarField Y_
protected

◆ pc_

scalar pc_
protected

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