FreeFOAM The Cross-Platform CFD Toolkit
BasicReactingParcel< ThermoType > Class Template Reference

#include <lagrangianIntermediate/BasicReactingParcel.H>


Detailed Description

template<class ThermoType>
class Foam::BasicReactingParcel< ThermoType >

Source files

Definition at line 55 of file BasicReactingParcel.H.

+ Inheritance diagram for BasicReactingParcel< ThermoType >:
+ Collaboration diagram for BasicReactingParcel< ThermoType >:

List of all members.

Public Types

typedef ThermoType thermoType
 The type of thermodynamics this parcel was instantiated for.

Public Member Functions

 TypeName ("BasicReactingParcel")
 Run-time type information.
 BasicReactingParcel (ReactingCloud< BasicReactingParcel > &owner, const vector &position, const label cellI)
 Construct from owner, position, and cloud owner.
 BasicReactingParcel (ReactingCloud< BasicReactingParcel > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const scalarField &Y0, const typename ReactingParcel< BasicReactingParcel >::constantProperties &constProps)
 Construct from components.
 BasicReactingParcel (const Cloud< BasicReactingParcel > &c, Istream &is, bool readFields=true)
 Construct from Istream.
 BasicReactingParcel (const BasicReactingParcel &p)
 Construct as a copy.
autoPtr< BasicReactingParcelclone () const
 Construct and return a clone.
virtual ~BasicReactingParcel ()
 Destructor.
- Public Member Functions inherited from ReactingParcel< BasicReactingParcel< ThermoType > >
 TypeName ("ReactingParcel")
 Runtime type information.
 ReactingParcel (ReactingCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI)
 Construct from owner, position, and cloud owner.
 ReactingParcel (ReactingCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const scalarField &Y0, const constantProperties &constProps)
 Construct from components.
 ReactingParcel (const Cloud< BasicReactingParcel< ThermoType > > &c, Istream &is, bool readFields=true)
 Construct from Istream.
 ReactingParcel (const ReactingParcel &p)
 Construct as a copy.
scalar mass0 () const
 Return const access to initial mass.
scalar & mass0 ()
 Return access to initial mass.
const scalarFieldY () const
 Return const access to mass fractions of mixture.
scalarFieldY ()
 Return access to mass fractions of mixture.
scalar pc () const
 Return the owner cell pressure.
void setCellValues (TrackData &td, const scalar dt, const label cellI)
 Set cell values.
void cellValueSourceCorrection (TrackData &td, const scalar dt, const label cellI)
 Correct cell values using latest transfer information.
void correctSurfaceValues (TrackData &td, const label cellI, const scalar T, const scalarField &Cs, scalar &rhos, scalar &mus, scalar &Pr, scalar &kappa)
 Correct surface values due to emitted species.
void calc (TrackData &td, const scalar dt, const label cellI)
 Update parcel properties over the time interval.
- Public Member Functions inherited from reactingParcel
 TypeName ("reactingParcel")
 Run-time type information.
 reactingParcel ()
 Construct null.
virtual ~reactingParcel ()
 Destructor.
- Public Member Functions inherited from ThermoParcel< BasicReactingParcel< ThermoType > >
 TypeName ("ThermoParcel")
 Runtime type information.
 ThermoParcel (ThermoCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI)
 Construct from owner, position, and cloud owner.
 ThermoParcel (ThermoCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const constantProperties &constProps)
 Construct from components.
 ThermoParcel (const Cloud< BasicReactingParcel< ThermoType > > &c, Istream &is, bool readFields=true)
 Construct from Istream.
 ThermoParcel (const ThermoParcel &p)
 Construct as a copy.
scalar T () const
 Return const access to temperature.
scalar & T ()
 Return access to temperature.
scalar cp () const
 Return const access to specific heat capacity.
scalar & cp ()
 Return access to specific heat capacity.
void calcSurfaceValues (TrackData &td, const label cellI, const scalar T, scalar &Ts, scalar &rhos, scalar &mus, scalar &Pr, scalar &kappa) const
 Calculate surface thermo properties.
- Public Member Functions inherited from KinematicParcel< BasicReactingParcel< ThermoType > >
 TypeName ("KinematicParcel")
 Runtime type information.
 KinematicParcel (KinematicCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI)
 Construct from owner, position, and cloud owner.
 KinematicParcel (KinematicCloud< BasicReactingParcel< ThermoType > > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const constantProperties &constProps)
 Construct from components.
 KinematicParcel (const Cloud< BasicReactingParcel< ThermoType > > &c, Istream &is, bool readFields=true)
 Construct from Istream.
 KinematicParcel (const KinematicParcel &p)
 Construct as a copy.
bool active () const
 Return const access to active flag.
bool & active ()
 Return const access to active flag.
label typeId () const
 Return const access to type id.
label typeId ()
 Return access to type id.
scalar nParticle () const
 Return const access to number of particles.
scalar & nParticle ()
 Return access to number of particles.
scalar d () const
 Return const access to diameter.
scalar & d ()
 Return access to diameter.
const vectorU () const
 Return const access to velocity.
vectorU ()
 Return access to velocity.
scalar rho () const
 Return const access to density.
scalar & rho ()
 Return access to density.
scalar tTurb () const
 Return const access to time spent in turbulent eddy.
scalar & tTurb ()
 Return access to time spent in turbulent eddy.
const vectorUTurb () const
 Return const access to turbulent velocity fluctuation.
vectorUTurb ()
 Return access to turbulent velocity fluctuation.
scalar wallImpactDistance (const vector &n) const
 The nearest distance to a wall that.
label faceInterpolation () const
 Return the index of the face to be used in the interpolation.
scalar massCell (const label cellI) const
 Cell owner mass.
scalar mass () const
 Particle mass.
scalar volume () const
 Particle volume.
scalar volume (const scalar d) const
 Particle volume for a given diameter.
scalar areaP () const
 Particle projected area.
scalar areaP (const scalar d) const
 Projected area for given diameter.
scalar areaS () const
 Particle surface area.
scalar areaS (const scalar d) const
 Surface area for given diameter.
scalar Re (const vector &U, const scalar d, const scalar rhoc, const scalar muc) const
 Reynolds number.
bool move (TrackData &td)
 Move the parcel.
bool hitPatch (const polyPatch &p, TrackData &td, const label patchI)
 Overridable function to handle the particle hitting a patch.
bool hitPatch (const polyPatch &p, int &td, const label patchI)
 Overridable function to handle the particle hitting a patch.
void hitPatch (const polyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a polyPatch.
void hitPatch (const polyPatch &, int &)
void hitProcessorPatch (const processorPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitProcessorPatch (const processorPolyPatch &, int &)
 Overridable function to handle the particle hitting a.
void hitWallPatch (const wallPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wallPatch.
void hitWallPatch (const wallPolyPatch &, int &)
 Overridable function to handle the particle hitting a wallPatch.
void transformProperties (const tensor &T)
 Transform the physical properties of the particle.
void transformProperties (const vector &separation)
 Transform the physical properties of the particle.
- Public Member Functions inherited from Particle< BasicReactingParcel< ThermoType > >
 TypeName ("Particle")
 Runtime type information.
 Particle (const Cloud< BasicReactingParcel< ThermoType > > &, const vector &position, const label celli)
 Construct from components.
 Particle (const Cloud< BasicReactingParcel< ThermoType > > &, Istream &, bool readFields=true)
 Construct from Istream.
 Particle (const Particle &p)
 Construct as a copy.
virtual ~Particle ()
 Destructor.
bool inCell () const
 Return true if particle is in cell.
bool inCell (const vector &position, const label celli, const scalar stepFraction) const
 Return true if position is in cell i.
const vectorposition () const
 Return current particle position.
vectorposition ()
 Return current particle position.
label & cell ()
 Return current cell particle is in.
label cell () const
 Return current cell particle is in.
label face () const
 Return current face particle is on otherwise -1.
const Cloud
< BasicReactingParcel
< ThermoType > > & 
cloud () const
 Return reference to the particle cloud.
bool softImpact () const
 Return the impact model to be used, soft or hard (default).
scalar currentTime () const
 Return the particle current time.
bool onBoundary () const
 Is the particle on the boundary/(or outside the domain)?
label patch (const label facei) const
 Which patch is particle on.
label patchFace (const label patchi, const label facei) const
 Which face of this patch is this particle on.
scalar & stepFraction ()
 Return the fraction of time-step completed.
scalar stepFraction () const
 Return the fraction of time-step completed.
label origProc () const
 Return the originating processor id.
label origId () const
 Return the particle id on originating processor.
label track (const vector &endPosition, TrackData &td)
 Track particle to end of trajectory.
label track (const vector &endPosition)
 Calls the templated track with dummy TrackData.
scalar trackToFace (const vector &endPosition, TrackData &td)
 Track particle to a given position and returns 1.0 if the.
scalar trackToFace (const vector &endPosition)
 Calls the templated trackToFace with dummy TrackData.
void write (Ostream &os, bool writeFields) const
 Write the particle data.

Additional Inherited Members

- Static Public Member Functions inherited from ReactingParcel< BasicReactingParcel< ThermoType > >
static void readFields (Cloud< BasicReactingParcel< ThermoType > > &c)
 Read.
static void writeFields (const Cloud< BasicReactingParcel< ThermoType > > &c)
 Write.
- Static Public Attributes inherited from ReactingParcel< BasicReactingParcel< ThermoType > >
static string propHeader
 String representation of properties.
- Static Public Attributes inherited from ThermoParcel< BasicReactingParcel< ThermoType > >
- Static Public Attributes inherited from KinematicParcel< BasicReactingParcel< ThermoType > >
- Static Public Attributes inherited from Particle< BasicReactingParcel< ThermoType > >
- Protected Member Functions inherited from ReactingParcel< BasicReactingParcel< ThermoType > >
void calcPhaseChange (TrackData &td, const scalar dt, const label cellI, const scalar Re, 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.
scalar updateMassFraction (const scalar mass0, const scalarField &dMass, scalarField &Y) const
 Update mass fraction.
- Protected Member Functions inherited from ThermoParcel< BasicReactingParcel< ThermoType > >
scalar calcHeatTransfer (TrackData &td, const scalar dt, const label cellI, const scalar Re, const scalar Pr, const scalar kappa, const scalar d, const scalar rho, const scalar T, const scalar cp, const scalar NCpW, const scalar Sh, scalar &dhsTrans)
 Calculate new particle temperature.
- Protected Member Functions inherited from KinematicParcel< BasicReactingParcel< ThermoType > >
const vector calcVelocity (TrackData &td, const scalar dt, const label cellI, const scalar Re, const scalar mu, const scalar d, const vector &U, const scalar rho, const scalar mass, const vector &Su, vector &dUTrans) const
 Calculate new particle velocity.
- Protected Member Functions inherited from Particle< BasicReactingParcel< ThermoType > >
scalar lambda (const vector &from, const vector &to, const label facei, const scalar stepFraction) const
 Return the 'lambda' value for the position, p, on the face,.
scalar lambda (const vector &from, const vector &to, const label facei) const
 Return the 'lambda' value for the position, p, on the face,.
void findFaces (const vector &position, DynamicList< label > &faceList) const
 Find the faces between position and cell centre.
void findFaces (const vector &position, const label celli, const scalar stepFraction, DynamicList< label > &faceList) const
 Find the faces between position and cell centre.
void hitWedgePatch (const wedgePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wedgePatch.
void hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitCyclicPatch (const cyclicPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a cyclicPatch.
virtual void transformPosition (const tensor &T)
 Transform the position the particle.
void prepareForParallelTransfer (const label patchi, TrackData &td)
 Convert global addressing to the processor patch.
void correctAfterParallelTransfer (const label patchi, TrackData &td)
 Convert processor patch addressing to the global equivalents.
- Protected Attributes inherited from ReactingParcel< BasicReactingParcel< ThermoType > >
scalar mass0_
 Initial particle mass [kg].
scalarField Y_
 Mass fractions of mixture [].
scalar pc_
 Pressure [Pa].
- Protected Attributes inherited from ThermoParcel< BasicReactingParcel< ThermoType > >
scalar T_
 Temperature [K].
scalar cp_
 Specific heat capacity [J/(kg.K)].
scalar Tc_
 Temperature [K].
scalar cpc_
 Specific heat capacity [J/(kg.K)].
- Protected Attributes inherited from KinematicParcel< BasicReactingParcel< ThermoType > >
bool active_
 Active flag - tracking inactive when active = false.
label typeId_
 Parcel type id.
scalar nParticle_
 Number of particles in Parcel.
scalar d_
 Diameter [m].
vector U_
 Velocity of Parcel [m/s].
scalar rho_
 Density [kg/m3].
scalar tTurb_
 Time spent in turbulent eddy [s].
vector UTurb_
 Turbulent velocity fluctuation [m/s].
scalar rhoc_
 Density [kg/m3].
vector Uc_
 Velocity [m/s].
scalar muc_
 Viscosity [Pa.s].
- Protected Attributes inherited from Particle< BasicReactingParcel< ThermoType > >
const Cloud
< BasicReactingParcel
< ThermoType > > & 
cloud_
 Reference to the particle cloud.
vector position_
 Position of particle.
label celli_
 Index of the cell it is in.
label facei_
 Face index if the particle is on a face otherwise -1.
scalar stepFraction_
 Fraction of time-step completed.
label origProc_
 Originating processor id.
label origId_
 Local particle id on originating processor.

Member Typedef Documentation

The type of thermodynamics this parcel was instantiated for.

Definition at line 63 of file BasicReactingParcel.H.


Constructor & Destructor Documentation

BasicReactingParcel ( ReactingCloud< BasicReactingParcel< ThermoType > > &  owner,
const vector position,
const label  cellI 
)

Construct from owner, position, and cloud owner.

Other properties initialised as null

Referenced by BasicReactingParcel< ThermoType >::clone().

BasicReactingParcel ( ReactingCloud< BasicReactingParcel< ThermoType > > &  owner,
const vector position,
const label  cellI,
const label  typeId,
const scalar  nParticle0,
const scalar  d0,
const vector U0,
const scalarField Y0,
const typename ReactingParcel< BasicReactingParcel< ThermoType > >::constantProperties &  constProps 
)

Construct from components.

BasicReactingParcel ( const Cloud< BasicReactingParcel< ThermoType > > &  c,
Istream is,
bool  readFields = true 
)

Construct from Istream.

Construct as a copy.

~BasicReactingParcel ( )
virtual

Destructor.

Definition at line 97 of file BasicReactingParcel.C.


Member Function Documentation

TypeName ( "BasicReactingParcel< ThermoType >"  )

Run-time type information.

autoPtr<BasicReactingParcel> clone ( ) const
inline

Construct and return a clone.

Reimplemented from ReactingParcel< BasicReactingParcel< ThermoType > >.

Definition at line 106 of file BasicReactingParcel.H.

References BasicReactingParcel< ThermoType >::BasicReactingParcel().


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