Cantera  2.5.1
Public Member Functions | Protected Attributes | List of all members
FlowReactor Class Reference

Adiabatic flow in a constant-area duct. More...

#include <FlowReactor.h>

Inheritance diagram for FlowReactor:
[legend]
Collaboration diagram for FlowReactor:
[legend]

Public Member Functions

virtual std::string typeStr () const
 String indicating the reactor model implemented. More...
 
virtual int type () const
 
virtual void getState (doublereal *y)
 Get the the current state of the reactor. More...
 
virtual void initialize (doublereal t0=0.0)
 Initialize the reactor. More...
 
virtual void evalEqs (doublereal t, doublereal *y, doublereal *ydot, doublereal *params)
 
virtual void updateState (doublereal *y)
 Set the state of the reactor to correspond to the state vector y. More...
 
void setMassFlowRate (doublereal mdot)
 
void setTimeConstant (doublereal tau)
 
double speed () const
 
double distance () const
 
virtual size_t componentIndex (const std::string &nm) const
 Return the index in the solution vector for this reactor of the component named nm. More...
 
- Public Member Functions inherited from Reactor
template<class G >
void insert (G &contents)
 Insert something into the reactor. More...
 
void insert (shared_ptr< Solution > sol)
 
virtual void setKineticsMgr (Kinetics &kin)
 Specify chemical kinetics governing the reactor. More...
 
virtual void setChemistry (bool cflag=true)
 Enable or disable changes in reactor composition due to chemical reactions. More...
 
bool chemistryEnabled () const
 Returns true if changes in the reactor composition due to chemical reactions are enabled. More...
 
virtual void setEnergy (int eflag=1)
 Set the energy equation on or off. More...
 
bool energyEnabled () const
 Returns true if solution of the energy equation is enabled. More...
 
virtual size_t neq ()
 Number of equations (state variables) for this reactor. More...
 
virtual void syncState ()
 Set the state of the reactor to correspond to the state of the associated ThermoPhase object. More...
 
virtual size_t nSensParams ()
 Number of sensitivity parameters associated with this reactor (including walls) More...
 
virtual void addSensitivityReaction (size_t rxn)
 Add a sensitivity parameter associated with the reaction number rxn (in the homogeneous phase). More...
 
virtual void addSensitivitySpeciesEnthalpy (size_t k)
 Add a sensitivity parameter associated with the enthalpy formation of species k (in the homogeneous phase) More...
 
virtual std::string componentName (size_t k)
 Return the name of the solution component with index i. More...
 
void setAdvanceLimits (const double *limits)
 Set absolute step size limits during advance. More...
 
bool hasAdvanceLimits ()
 Check whether Reactor object uses advance limits. More...
 
bool getAdvanceLimits (double *limits)
 Retrieve absolute step size limits during advance. More...
 
void setAdvanceLimit (const std::string &nm, const double limit)
 Set individual step size limit for compoment name nm More...
 
- Public Member Functions inherited from ReactorBase
 ReactorBase (const std::string &name="(none)")
 
 ReactorBase (const ReactorBase &)=delete
 
ReactorBaseoperator= (const ReactorBase &)=delete
 
std::string name () const
 Return the name of this reactor. More...
 
void setName (const std::string &name)
 Set the name of this reactor. More...
 
void setInitialVolume (doublereal vol)
 Set the initial reactor volume. By default, the volume is 1.0 m^3. More...
 
virtual void setThermoMgr (thermo_t &thermo)
 Specify the mixture contained in the reactor. More...
 
void addInlet (FlowDevice &inlet)
 Connect an inlet FlowDevice to this reactor. More...
 
void addOutlet (FlowDevice &outlet)
 Connect an outlet FlowDevice to this reactor. More...
 
FlowDeviceinlet (size_t n=0)
 Return a reference to the n-th inlet FlowDevice connected to this reactor. More...
 
FlowDeviceoutlet (size_t n=0)
 Return a reference to the n-th outlet FlowDevice connected to this reactor. More...
 
size_t nInlets ()
 Return the number of inlet FlowDevice objects connected to this reactor. More...
 
size_t nOutlets ()
 Return the number of outlet FlowDevice objects connected to this reactor. More...
 
size_t nWalls ()
 Return the number of Wall objects connected to this reactor. More...
 
void addWall (WallBase &w, int lr)
 Insert a Wall between this reactor and another reactor. More...
 
WallBasewall (size_t n)
 Return a reference to the n-th Wall connected to this reactor. More...
 
void addSurface (ReactorSurface *surf)
 
ReactorSurface * surface (size_t n)
 Return a reference to the n-th ReactorSurface connected to this reactor. More...
 
void restoreState ()
 Set the state of the Phase object associated with this reactor to the reactor's current state. More...
 
thermo_tcontents ()
 return a reference to the contents. More...
 
const thermo_tcontents () const
 
doublereal residenceTime ()
 Return the residence time (s) of the contents of this reactor, based on the outlet mass flow rates and the mass of the reactor contents. More...
 
doublereal volume () const
 Returns the current volume (m^3) of the reactor. More...
 
doublereal density () const
 Returns the current density (kg/m^3) of the reactor's contents. More...
 
doublereal temperature () const
 Returns the current temperature (K) of the reactor's contents. More...
 
doublereal enthalpy_mass () const
 Returns the current enthalpy (J/kg) of the reactor's contents. More...
 
doublereal intEnergy_mass () const
 Returns the current internal energy (J/kg) of the reactor's contents. More...
 
doublereal pressure () const
 Returns the current pressure (Pa) of the reactor. More...
 
doublereal mass () const
 Returns the mass (kg) of the reactor's contents. More...
 
const doublereal * massFractions () const
 Return the vector of species mass fractions. More...
 
doublereal massFraction (size_t k) const
 Return the mass fraction of the k-th species. More...
 
ReactorNetnetwork ()
 The ReactorNet that this reactor belongs to. More...
 
void setNetwork (ReactorNet *net)
 Set the ReactorNet that this reactor belongs to. More...
 

Protected Attributes

doublereal m_speed
 
doublereal m_dist
 
doublereal m_T
 
doublereal m_fctr
 
doublereal m_rho0
 
doublereal m_speed0
 
doublereal m_P0
 
doublereal m_h0
 
- Protected Attributes inherited from Reactor
Kineticsm_kin
 Pointer to the homogeneous Kinetics object that handles the reactions. More...
 
doublereal m_vdot
 net rate of volume change from moving walls [m^3/s] More...
 
doublereal m_Q
 net heat transfer through walls [W] More...
 
doublereal m_mass
 total mass More...
 
vector_fp m_work
 
vector_fp m_sdot
 Production rates of gas phase species on surfaces [kmol/s]. More...
 
vector_fp m_wdot
 Species net molar production rates. More...
 
vector_fp m_uk
 Species molar internal energies. More...
 
bool m_chem
 
bool m_energy
 
size_t m_nv
 
vector_fp m_advancelimits
 Advance step limit. More...
 
std::vector< SensitivityParameter > m_sensParams
 
- Protected Attributes inherited from ReactorBase
size_t m_nsp
 Number of homogeneous species in the mixture. More...
 
thermo_tm_thermo
 
doublereal m_vol
 
doublereal m_enthalpy
 
doublereal m_intEnergy
 
doublereal m_pressure
 
vector_fp m_state
 
std::vector< FlowDevice * > m_inlet
 
std::vector< FlowDevice * > m_outlet
 
std::vector< WallBase * > m_wall
 
std::vector< ReactorSurface * > m_surfaces
 
vector_int m_lr
 
std::string m_name
 
ReactorNetm_net
 The ReactorNet that this reactor is part of. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Reactor
virtual void applySensitivity (double *params)
 Set reaction rate multipliers based on the sensitivity variables in params. More...
 
virtual void resetSensitivity (double *params)
 Reset the reaction rate multipliers. More...
 
virtual size_t speciesIndex (const std::string &nm) const
 Return the index in the solution vector for this reactor of the species named nm, in either the homogeneous phase or a surface phase, relative to the start of the species terms. More...
 
virtual void evalWalls (double t)
 Evaluate terms related to Walls. More...
 
virtual double evalSurfaces (double t, double *ydot)
 Evaluate terms related to surface reactions. More...
 
virtual void updateSurfaceState (double *y)
 Update the state of SurfPhase objects attached to this reactor. More...
 
virtual void updateConnected (bool updatePressure)
 Update the state information needed by connected reactors and flow devices. More...
 
virtual void getSurfaceInitialConditions (double *y)
 Get initial conditions for SurfPhase objects attached to this reactor. More...
 

Detailed Description

Adiabatic flow in a constant-area duct.

Definition at line 15 of file FlowReactor.h.

Member Function Documentation

◆ typeStr()

virtual std::string typeStr ( ) const
inlinevirtual

String indicating the reactor model implemented.

Usually corresponds to the name of the derived class.

Reimplemented from Reactor.

Definition at line 20 of file FlowReactor.h.

◆ type()

virtual int type ( ) const
inlinevirtual
Deprecated:
To be changed after Cantera 2.5.

Reimplemented from Reactor.

Definition at line 27 of file FlowReactor.h.

References Cantera::warn_deprecated().

◆ getState()

void getState ( doublereal *  y)
virtual

Get the the current state of the reactor.

Parameters
[out]ystate vector representing the initial state of the reactor

Reimplemented from Reactor.

Definition at line 26 of file FlowReactor.cpp.

◆ initialize()

void initialize ( doublereal  t0 = 0.0)
virtual

Initialize the reactor.

Called automatically by ReactorNet::initialize.

Reimplemented from Reactor.

Definition at line 40 of file FlowReactor.cpp.

◆ evalEqs()

void evalEqs ( doublereal  t,
doublereal *  y,
doublereal *  ydot,
doublereal *  params 
)
virtual

Evaluate the reactor governing equations. Called by ReactorNet::eval.

Parameters
[in]ttime.
[in]ysolution vector, length neq()
[out]ydotrate of change of solution vector, length neq()
[in]paramssensitivity parameter vector, length ReactorNet::nparams()

Reimplemented from Reactor.

Definition at line 69 of file FlowReactor.cpp.

◆ updateState()

void updateState ( doublereal *  y)
virtual

Set the state of the reactor to correspond to the state vector y.

Reimplemented from Reactor.

Definition at line 46 of file FlowReactor.cpp.

◆ componentIndex()

size_t componentIndex ( const std::string &  nm) const
virtual

Return the index in the solution vector for this reactor of the component named nm.

Possible values for nm are "X" (position), "U", the name of a homogeneous phase species, or the name of a surface species.

Reimplemented from Reactor.

Definition at line 96 of file FlowReactor.cpp.

References Cantera::npos.


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