Cantera  3.2.0a2
Loading...
Searching...
No Matches
ReactorBase Class Reference

Base class for reactor objects. More...

#include <ReactorBase.h>

Inheritance diagram for ReactorBase:
[legend]

Detailed Description

Base class for reactor objects.

Allows using any substance model, with arbitrary inflow, outflow, heat loss/gain, surface chemistry, and volume change, whenever defined.

Definition at line 48 of file ReactorBase.h.

Public Member Functions

 ReactorBase (const string &name="(none)")
 
 ReactorBase (shared_ptr< Solution > sol, const string &name="(none)")
 Instantiate a ReactorBase object with Solution contents.
 
 ReactorBase (const ReactorBase &)=delete
 
ReactorBaseoperator= (const ReactorBase &)=delete
 
virtual string type () const
 String indicating the reactor model implemented.
 
string name () const
 Return the name of this reactor.
 
void setName (const string &name)
 Set the name of this reactor.
 
bool setDefaultName (map< string, int > &counts)
 Set the default name of a reactor. Returns false if it was previously set.
 
void setSolution (shared_ptr< Solution > sol)
 Set the Solution specifying the ReactorBase content.
 
void restoreState ()
 Set the state of the Phase object associated with this reactor to the reactor's current state.
 
virtual void syncState ()
 Set the state of the reactor to the associated ThermoPhase object.
 
ThermoPhasecontents ()
 return a reference to the contents.
 
const ThermoPhasecontents () const
 
double 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.
 
ReactorNetnetwork ()
 The ReactorNet that this reactor belongs to.
 
void setNetwork (ReactorNet *net)
 Set the ReactorNet that this reactor belongs to.
 
virtual void addSensitivityReaction (size_t rxn)
 Add a sensitivity parameter associated with the reaction number rxn
 
virtual size_t nSensParams () const
 Number of sensitivity parameters associated with this reactor.
 
Methods to set up a simulation
virtual void setInitialVolume (double vol)
 Set the initial reactor volume.
 
virtual void setChemistry (bool cflag=true)
 Enable or disable changes in reactor composition due to chemical reactions.
 
virtual void setEnergy (int eflag=1)
 Set the energy equation on or off.
 
virtual void addInlet (FlowDevice &inlet)
 Connect an inlet FlowDevice to this reactor.
 
virtual void addOutlet (FlowDevice &outlet)
 Connect an outlet FlowDevice to this reactor.
 
FlowDeviceinlet (size_t n=0)
 Return a reference to the n-th inlet FlowDevice connected to this reactor.
 
FlowDeviceoutlet (size_t n=0)
 Return a reference to the n-th outlet FlowDevice connected to this reactor.
 
size_t nInlets ()
 Return the number of inlet FlowDevice objects connected to this reactor.
 
size_t nOutlets ()
 Return the number of outlet FlowDevice objects connected to this reactor.
 
size_t nWalls ()
 Return the number of Wall objects connected to this reactor.
 
virtual void addWall (WallBase &w, int lr)
 Insert a Wall between this reactor and another reactor.
 
WallBasewall (size_t n)
 Return a reference to the n-th Wall connected to this reactor.
 
virtual void addSurface (ReactorSurface *surf)
 Add a ReactorSurface object to a Reactor object.
 
void addSurface (shared_ptr< ReactorBase > surf)
 Add a ReactorSurface object to a Reactor object.
 
ReactorSurfacesurface (size_t n)
 Return a reference to the n-th ReactorSurface connected to this reactor.
 
virtual size_t nSurfs () const
 Return the number of surfaces in a reactor.
 
virtual void initialize (double t0=0.0)
 Initialize the reactor.
 
Solution components

The values returned are those after the last call to ReactorNet::advance or ReactorNet::step.

double volume () const
 Returns the current volume (m^3) of the reactor.
 
double density () const
 Returns the current density (kg/m^3) of the reactor's contents.
 
double temperature () const
 Returns the current temperature (K) of the reactor's contents.
 
double enthalpy_mass () const
 Returns the current enthalpy (J/kg) of the reactor's contents.
 
double intEnergy_mass () const
 Returns the current internal energy (J/kg) of the reactor's contents.
 
double pressure () const
 Returns the current pressure (Pa) of the reactor.
 
double mass () const
 Returns the mass (kg) of the reactor's contents.
 
const double * massFractions () const
 Return the vector of species mass fractions.
 
double massFraction (size_t k) const
 Return the mass fraction of the k-th species.
 

Protected Member Functions

virtual void setThermo (ThermoPhase &thermo)
 Specify the mixture contained in the reactor.
 
virtual void setKinetics (Kinetics &kin)
 Specify the kinetics manager for the reactor.
 

Protected Attributes

size_t m_nsp = 0
 Number of homogeneous species in the mixture.
 
ThermoPhasem_thermo = nullptr
 
double m_vol = 0.0
 Current volume of the reactor [m^3].
 
double m_mass = 0.0
 Current mass of the reactor [kg].
 
double m_enthalpy = 0.0
 Current specific enthalpy of the reactor [J/kg].
 
double m_intEnergy = 0.0
 Current internal energy of the reactor [J/kg].
 
double m_pressure = 0.0
 Current pressure in the reactor [Pa].
 
vector< double > m_state
 
vector< FlowDevice * > m_inlet
 
vector< FlowDevice * > m_outlet
 
vector< WallBase * > m_wall
 
vector< ReactorSurface * > m_surfaces
 
vector< int > m_lr
 Vector of length nWalls(), indicating whether this reactor is on the left (0) or right (1) of each wall.
 
string m_name
 Reactor name.
 
bool m_defaultNameSet = false
 true if default name has been previously set.
 
ReactorNetm_net = nullptr
 The ReactorNet that this reactor is part of.
 
shared_ptr< Solutionm_solution
 Composite thermo/kinetics/transport handler.
 
vector< SensitivityParameterm_sensParams
 

Constructor & Destructor Documentation

◆ ReactorBase() [1/2]

ReactorBase ( const string &  name = "(none)")
explicit

Definition at line 16 of file ReactorBase.cpp.

◆ ReactorBase() [2/2]

ReactorBase ( shared_ptr< Solution sol,
const string &  name = "(none)" 
)

Instantiate a ReactorBase object with Solution contents.

Parameters
solSolution object to be set.
nameName of the reactor.
Since
New in Cantera 3.1.

Definition at line 20 of file ReactorBase.cpp.

◆ ~ReactorBase()

~ReactorBase ( )
virtual

Definition at line 32 of file ReactorBase.cpp.

Member Function Documentation

◆ type()

virtual string type ( ) const
inlinevirtual

String indicating the reactor model implemented.

Usually corresponds to the name of the derived class.

Reimplemented in ConstPressureMoleReactor, ConstPressureReactor, FlowReactor, IdealGasConstPressureMoleReactor, IdealGasConstPressureReactor, IdealGasMoleReactor, IdealGasReactor, MoleReactor, Reactor, ReactorSurface, and Reservoir.

Definition at line 63 of file ReactorBase.h.

◆ name()

string name ( ) const
inline

Return the name of this reactor.

Definition at line 68 of file ReactorBase.h.

◆ setName()

void setName ( const string &  name)
inline

Set the name of this reactor.

Definition at line 73 of file ReactorBase.h.

◆ setDefaultName()

bool setDefaultName ( map< string, int > &  counts)

Set the default name of a reactor. Returns false if it was previously set.

Definition at line 39 of file ReactorBase.cpp.

◆ setSolution()

void setSolution ( shared_ptr< Solution sol)

Set the Solution specifying the ReactorBase content.

Parameters
solSolution object to be set.
Since
New in Cantera 3.1.
Deprecated:
To be removed after Cantera 3.2. Superseded by instantiation of ReactorBase with Solution object.

Definition at line 52 of file ReactorBase.cpp.

◆ setInitialVolume()

virtual void setInitialVolume ( double  vol)
inlinevirtual

Set the initial reactor volume.

Reimplemented in Reactor.

Definition at line 91 of file ReactorBase.h.

◆ setChemistry()

virtual void setChemistry ( bool  cflag = true)
inlinevirtual

Enable or disable changes in reactor composition due to chemical reactions.

Reimplemented in Reactor.

Definition at line 97 of file ReactorBase.h.

◆ setEnergy()

virtual void setEnergy ( int  eflag = 1)
inlinevirtual

Set the energy equation on or off.

Reimplemented in Reactor.

Definition at line 102 of file ReactorBase.h.

◆ addInlet()

void addInlet ( FlowDevice inlet)
virtual

Connect an inlet FlowDevice to this reactor.

Reimplemented in ReactorSurface.

Definition at line 88 of file ReactorBase.cpp.

◆ addOutlet()

void addOutlet ( FlowDevice outlet)
virtual

Connect an outlet FlowDevice to this reactor.

Reimplemented in ReactorSurface.

Definition at line 93 of file ReactorBase.cpp.

◆ inlet()

FlowDevice & inlet ( size_t  n = 0)

Return a reference to the n-th inlet FlowDevice connected to this reactor.

Definition at line 183 of file ReactorBase.cpp.

◆ outlet()

FlowDevice & outlet ( size_t  n = 0)

Return a reference to the n-th outlet FlowDevice connected to this reactor.

Definition at line 187 of file ReactorBase.cpp.

◆ nInlets()

size_t nInlets ( )
inline

Return the number of inlet FlowDevice objects connected to this reactor.

Definition at line 119 of file ReactorBase.h.

◆ nOutlets()

size_t nOutlets ( )
inline

Return the number of outlet FlowDevice objects connected to this reactor.

Definition at line 124 of file ReactorBase.h.

◆ nWalls()

size_t nWalls ( )
inline

Return the number of Wall objects connected to this reactor.

Definition at line 129 of file ReactorBase.h.

◆ addWall()

void addWall ( WallBase w,
int  lr 
)
virtual

Insert a Wall between this reactor and another reactor.

lr = 0 if this reactor is to the left of the wall and lr = 1 if this reactor is to the right of the wall. This method is called automatically for both the left and right reactors by WallBase::install.

Reimplemented in ReactorSurface.

Definition at line 98 of file ReactorBase.cpp.

◆ wall()

WallBase & wall ( size_t  n)

Return a reference to the n-th Wall connected to this reactor.

Definition at line 108 of file ReactorBase.cpp.

◆ addSurface() [1/2]

void addSurface ( ReactorSurface surf)
virtual

Add a ReactorSurface object to a Reactor object.

Reimplemented in ReactorSurface.

Definition at line 113 of file ReactorBase.cpp.

◆ addSurface() [2/2]

void addSurface ( shared_ptr< ReactorBase surf)

Add a ReactorSurface object to a Reactor object.

Definition at line 121 of file ReactorBase.cpp.

◆ surface()

ReactorSurface * surface ( size_t  n)

Return a reference to the n-th ReactorSurface connected to this reactor.

Definition at line 131 of file ReactorBase.cpp.

◆ nSurfs()

virtual size_t nSurfs ( ) const
inlinevirtual

Return the number of surfaces in a reactor.

Definition at line 154 of file ReactorBase.h.

◆ initialize()

virtual void initialize ( double  t0 = 0.0)
inlinevirtual

◆ restoreState()

void restoreState ( )

Set the state of the Phase object associated with this reactor to the reactor's current state.

Definition at line 136 of file ReactorBase.cpp.

◆ syncState()

void syncState ( )
virtual

Set the state of the reactor to the associated ThermoPhase object.

This method is the inverse of restoreState() and will trigger integrator reinitialization.

Reimplemented in FlowReactor, and ReactorSurface.

Definition at line 143 of file ReactorBase.cpp.

◆ contents() [1/2]

ThermoPhase & contents ( )
inline

return a reference to the contents.

Definition at line 177 of file ReactorBase.h.

◆ contents() [2/2]

const ThermoPhase & contents ( ) const
inline

Definition at line 185 of file ReactorBase.h.

◆ residenceTime()

double 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.

Definition at line 174 of file ReactorBase.cpp.

◆ volume()

double volume ( ) const
inline

Returns the current volume (m^3) of the reactor.

Definition at line 204 of file ReactorBase.h.

◆ density()

double density ( ) const
inline

Returns the current density (kg/m^3) of the reactor's contents.

Definition at line 209 of file ReactorBase.h.

◆ temperature()

double temperature ( ) const
inline

Returns the current temperature (K) of the reactor's contents.

Definition at line 218 of file ReactorBase.h.

◆ enthalpy_mass()

double enthalpy_mass ( ) const
inline

Returns the current enthalpy (J/kg) of the reactor's contents.

Definition at line 227 of file ReactorBase.h.

◆ intEnergy_mass()

double intEnergy_mass ( ) const
inline

Returns the current internal energy (J/kg) of the reactor's contents.

Deprecated:
To be removed after Cantera 3.2.

Definition at line 233 of file ReactorBase.h.

◆ pressure()

double pressure ( ) const
inline

Returns the current pressure (Pa) of the reactor.

Definition at line 240 of file ReactorBase.h.

◆ mass()

double mass ( ) const
inline

Returns the mass (kg) of the reactor's contents.

Definition at line 245 of file ReactorBase.h.

◆ massFractions()

const double * massFractions ( ) const
inline

Return the vector of species mass fractions.

Definition at line 250 of file ReactorBase.h.

◆ massFraction()

double massFraction ( size_t  k) const
inline

Return the mass fraction of the k-th species.

Definition at line 259 of file ReactorBase.h.

◆ network()

ReactorNet & network ( )

The ReactorNet that this reactor belongs to.

Definition at line 159 of file ReactorBase.cpp.

◆ setNetwork()

void setNetwork ( ReactorNet net)

Set the ReactorNet that this reactor belongs to.

Definition at line 169 of file ReactorBase.cpp.

◆ addSensitivityReaction()

virtual void addSensitivityReaction ( size_t  rxn)
inlinevirtual

Add a sensitivity parameter associated with the reaction number rxn

Reimplemented in Reactor, and ReactorSurface.

Definition at line 276 of file ReactorBase.h.

◆ nSensParams()

virtual size_t nSensParams ( ) const
inlinevirtual

Number of sensitivity parameters associated with this reactor.

Reimplemented in Reactor.

Definition at line 281 of file ReactorBase.h.

◆ setThermo()

void setThermo ( ThermoPhase thermo)
protectedvirtual

Specify the mixture contained in the reactor.

Note that a pointer to this substance is stored, and as the integration proceeds, the state of the substance is modified.

Since
New in Cantera 3.1.

Reimplemented in IdealGasConstPressureMoleReactor, IdealGasConstPressureReactor, IdealGasMoleReactor, IdealGasReactor, and ReactorSurface.

Definition at line 74 of file ReactorBase.cpp.

◆ setKinetics()

virtual void setKinetics ( Kinetics kin)
inlineprotectedvirtual

Specify the kinetics manager for the reactor.

Called by setSolution().

Since
New in Cantera 3.1.
Deprecated:
To be removed after Cantera 3.2. Superseded by instantiation of ReactorBase with Solution object.

Reimplemented in Reactor, and ReactorSurface.

Definition at line 296 of file ReactorBase.h.

Member Data Documentation

◆ m_nsp

size_t m_nsp = 0
protected

Number of homogeneous species in the mixture.

Definition at line 301 of file ReactorBase.h.

◆ m_thermo

ThermoPhase* m_thermo = nullptr
protected

Definition at line 303 of file ReactorBase.h.

◆ m_vol

double m_vol = 0.0
protected

Current volume of the reactor [m^3].

Definition at line 304 of file ReactorBase.h.

◆ m_mass

double m_mass = 0.0
protected

Current mass of the reactor [kg].

Definition at line 305 of file ReactorBase.h.

◆ m_enthalpy

double m_enthalpy = 0.0
protected

Current specific enthalpy of the reactor [J/kg].

Definition at line 306 of file ReactorBase.h.

◆ m_intEnergy

double m_intEnergy = 0.0
protected

Current internal energy of the reactor [J/kg].

Deprecated:
To be removed after Cantera 3.2

Definition at line 310 of file ReactorBase.h.

◆ m_pressure

double m_pressure = 0.0
protected

Current pressure in the reactor [Pa].

Definition at line 311 of file ReactorBase.h.

◆ m_state

vector<double> m_state
protected

Definition at line 312 of file ReactorBase.h.

◆ m_inlet

vector<FlowDevice*> m_inlet
protected

Definition at line 313 of file ReactorBase.h.

◆ m_outlet

vector<FlowDevice*> m_outlet
protected

Definition at line 313 of file ReactorBase.h.

◆ m_wall

vector<WallBase*> m_wall
protected

Definition at line 315 of file ReactorBase.h.

◆ m_surfaces

vector<ReactorSurface*> m_surfaces
protected

Definition at line 316 of file ReactorBase.h.

◆ m_lr

vector<int> m_lr
protected

Vector of length nWalls(), indicating whether this reactor is on the left (0) or right (1) of each wall.

Definition at line 320 of file ReactorBase.h.

◆ m_name

string m_name
protected

Reactor name.

Definition at line 321 of file ReactorBase.h.

◆ m_defaultNameSet

bool m_defaultNameSet = false
protected

true if default name has been previously set.

Definition at line 322 of file ReactorBase.h.

◆ m_net

ReactorNet* m_net = nullptr
protected

The ReactorNet that this reactor is part of.

Definition at line 325 of file ReactorBase.h.

◆ m_solution

shared_ptr<Solution> m_solution
protected

Composite thermo/kinetics/transport handler.

Definition at line 328 of file ReactorBase.h.

◆ m_sensParams

vector<SensitivityParameter> m_sensParams
protected

Definition at line 331 of file ReactorBase.h.


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