 |
Cantera
4.0.0a1
|
A source or sink whose state remains constant regardless of any flows or other interactions with other Reactor objects. More...
#include <Reservoir.h>
A source or sink whose state remains constant regardless of any flows or other interactions with other Reactor objects.
Definition at line 18 of file Reservoir.h.
Public Member Functions | |
| string | type () const override |
| String indicating the reactor model implemented. | |
| void | initialize (double t0=0.0) override |
| Initialize the reactor. | |
| ReactorBase (shared_ptr< Solution > sol, const string &name="(none)") | |
| Instantiate a ReactorBase object with Solution contents. | |
| ReactorBase (shared_ptr< Solution > sol, bool clone, const string &name="(none)") | |
| Instantiate a ReactorBase object with Solution contents. | |
| ReactorBase (const ReactorBase &)=delete | |
| ReactorBase (const string &name="(none)") | |
 Public Member Functions inherited from ReactorBase | |
| ReactorBase (shared_ptr< Solution > sol, const string &name="(none)") | |
| Instantiate a ReactorBase object with Solution contents. | |
| ReactorBase (shared_ptr< Solution > sol, bool clone, const string &name="(none)") | |
| Instantiate a ReactorBase object with Solution contents. | |
| ReactorBase (const ReactorBase &)=delete | |
| ReactorBase & | operator= (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. | |
| shared_ptr< Solution > | phase () |
| Access the Solution object used to represent the contents of this reactor. | |
| shared_ptr< const Solution > | phase () const |
| Access the Solution object used to represent the contents of this reactor. | |
| virtual bool | timeIsIndependent () const |
| Indicates whether the governing equations for this reactor are functions of time or a spatial variable. | |
| size_t | neq () |
| Number of equations (state variables) for this reactor. | |
| virtual void | syncState () |
| Set the state of the reactor to the associated ThermoPhase object. | |
| virtual void | updateConnected (bool updatePressure) |
| Update state information needed by connected reactors, flow devices, and walls. | |
| 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. | |
| ReactorNet & | network () |
| The ReactorNet that this reactor belongs to. | |
| void | setNetwork (ReactorNet *net) |
| Set the ReactorNet that this reactor belongs to. | |
| size_t | offset () const |
| Get the starting offset for this reactor's state variables within the global state vector of the ReactorNet. | |
| void | setOffset (size_t offset) |
| Set the starting offset for this reactor's state variables within the global state vector of the ReactorNet. | |
| size_t | speciesOffset () const |
| Offset of the first species in the local state vector. | |
| virtual void | getJacobianScalingFactors (double &f_species, double *f_energy) |
| Get scaling factors for the Jacobian matrix terms proportional to \( d\dot{n}_k/dC_j \). | |
| 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. | |
| virtual void | setInitialVolume (double vol) |
| Set the initial reactor volume. | |
| virtual double | area () const |
| Returns an area associated with a reactor [m²]. | |
| virtual void | evalWalls (double t) |
| Evaluate contributions from walls connected to this reactor. | |
| virtual void | setArea (double a) |
| Set an area associated with a reactor [m²]. | |
| virtual bool | chemistryEnabled () const |
Returns true if changes in the reactor composition due to chemical reactions are enabled. | |
| virtual void | setChemistryEnabled (bool cflag=true) |
| Enable or disable changes in reactor composition due to chemical reactions. | |
| virtual bool | energyEnabled () const |
Returns true if solution of the energy equation is enabled. | |
| virtual void | setEnergyEnabled (bool eflag=true) |
| 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. | |
| FlowDevice & | inlet (size_t n=0) |
| Return a reference to the n-th inlet FlowDevice connected to this reactor. | |
| FlowDevice & | outlet (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. | |
| WallBase & | wall (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. | |
| ReactorSurface * | surface (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. | |
| span< const double > | surfaceProductionRates () const |
| Production rates on surfaces. | |
| virtual void | getState (double *y) |
| Get the current state of the reactor. | |
| virtual void | getStateDae (double *y, double *ydot) |
| Get the current state and derivative vector of the reactor for a DAE solver. | |
| virtual void | eval (double t, double *LHS, double *RHS) |
| Evaluate the reactor governing equations. | |
| virtual void | evalDae (double t, double *y, double *ydot, double *residual) |
| Evaluate the reactor governing equations. | |
| virtual void | getConstraints (double *constraints) |
| Given a vector of length neq(), mark which variables should be considered algebraic constraints. | |
| virtual vector< size_t > | steadyConstraints () const |
| Get the indices of equations that are algebraic constraints when solving the steady-state problem. | |
| virtual void | updateState (double *y) |
| Set the state of the reactor to correspond to the state vector y. | |
| virtual void | addSensitivitySpeciesEnthalpy (size_t k) |
| Add a sensitivity parameter associated with the enthalpy formation of species k. | |
| virtual size_t | componentIndex (const string &nm) const |
| Return the index in the solution vector for this reactor of the component named nm. | |
| virtual string | componentName (size_t k) |
| Return the name of the solution component with index i. | |
| virtual double | upperBound (size_t k) const |
| Get the upper bound on the k-th component of the local state vector. | |
| virtual double | lowerBound (size_t k) const |
| Get the lower bound on the k-th component of the local state vector. | |
| virtual void | resetBadValues (double *y) |
| Reset physically or mathematically problematic values, such as negative species concentrations. | |
| virtual void | getJacobianElements (vector< Eigen::Triplet< double > > &trips) |
| Get Jacobian elements for this reactor within the full reactor network. | |
| virtual Eigen::SparseMatrix< double > | jacobian () |
| Calculate the Jacobian of a specific reactor specialization. | |
| virtual void | setDerivativeSettings (AnyMap &settings) |
| Use this to set the kinetics objects derivative settings. | |
| virtual void | applySensitivity (double *params) |
| Set reaction rate multipliers based on the sensitivity variables in params. | |
| virtual void | resetSensitivity (double *params) |
| Reset the reaction rate multipliers. | |
| virtual bool | preconditionerSupported () const |
| Return a false if preconditioning is not supported or true otherwise. | |
| 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 | 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. | |
Additional Inherited Members | |
| Protected Member Functions inherited from ReactorBase | |
| ReactorBase (const string &name="(none)") | |
| Protected Attributes inherited from ReactorBase | |
| size_t | m_nsp = 0 |
| Number of homogeneous species in the mixture. | |
| ThermoPhase * | m_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_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< double > | m_sdot |
| species production rates on 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. | |
| size_t | m_nv = 0 |
| Number of state variables for this reactor. | |
| ReactorNet * | m_net = nullptr |
| The ReactorNet that this reactor is part of. | |
| size_t | m_offset = 0 |
| Offset into global ReactorNet state vector. | |
| shared_ptr< Solution > | m_solution |
| Composite thermo/kinetics/transport handler. | |
| vector< SensitivityParameter > | m_sensParams |
|
inlineoverridevirtual |
String indicating the reactor model implemented.
Usually corresponds to the name of the derived class.
Reimplemented from ReactorBase.
Definition at line 23 of file Reservoir.h.
|
inlineoverridevirtual |
Initialize the reactor.
Called automatically by ReactorNet::initialize.
Reimplemented from ReactorBase.
Definition at line 27 of file Reservoir.h.
| ReactorBase | ( | shared_ptr< Solution > | sol, |
| const string & | name = "(none)" |
||
| ) |
Instantiate a ReactorBase object with Solution contents.
| sol | Solution object to be set. |
| name | Name of the reactor. |
Definition at line 57 of file ReactorBase.cpp.
| ReactorBase | ( | shared_ptr< Solution > | sol, |
| bool | clone, | ||
| const string & | name = "(none)" |
||
| ) |
Instantiate a ReactorBase object with Solution contents.
| sol | Solution object representing the contents of this reactor |
| clone | Determines whether to clone sol so that the internal state of this reactor is independent of the original Solution object and any Solution objects used by other reactors in the network. |
| name | Name of the reactor. |
clone argument in Cantera 3.2. If not specified, the default behavior in Cantera 3.2 is not to clone the Solution object. This will change after Cantera 3.2 to default to true. Definition at line 68 of file ReactorBase.cpp.
|
explicit |
Definition at line 488 of file ReactorBase.cpp.
1.9.7