Cantera 2.6.0

Public Member Functions | List of all members
Reservoir Class Reference

A source or sink whose state remains constant regardless of any flows or other interactions with other Reactor objects. More...

`#include <Reservoir.h>`

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

## Public Member Functions
virtual std::string | typeStr () const
| String indicating the reactor model implemented. More...
virtual std::string | type () const
| String indicating the reactor model implemented. More...
virtual void | initialize (doublereal t0=0.0)
| Initialize the reactor. More...
void | insert (ThermoPhase &contents)
void | insert (shared_ptr< Solution > sol)
Public Member Functions inherited from ReactorBase
| ReactorBase (const std::string &name="(none)")
| ReactorBase (const ReactorBase &)=delete
ReactorBase & | operator= (const ReactorBase &)=delete
virtual std::string | typeStr () const
| String indicating the reactor model implemented. More...
virtual std::string | type () const
| String indicating the reactor model implemented. More...
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 | restoreState ()
| Set the state of the Phase object associated with this reactor to the reactor's current state. More...
virtual void | syncState ()
| Set the state of the reactor to correspond to the state of the associated ThermoPhase object. More...
ThermoPhase & | contents ()
| return a reference to the contents. More...
const ThermoPhase & | contents () 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...
ReactorNet & | network ()
| The ReactorNet that this reactor belongs to. More...
void | setNetwork (ReactorNet *net)
| Set the ReactorNet that this reactor belongs to. More...
void | setInitialVolume (doublereal vol)
| Set the initial reactor volume. By default, the volume is 1.0 m^3. More...
virtual void | setThermoMgr (ThermoPhase &thermo)
| Specify the mixture contained in the reactor. More...
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...
virtual void | setEnergy (int eflag=1)
| Set the energy equation on or off. 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...
FlowDevice & | inlet (size_t n=0)
| Return a reference to the n-th inlet FlowDevice connected to this reactor. More...
FlowDevice & | outlet (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...
WallBase & | wall (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...
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...

## Additional Inherited Members
Protected Attributes inherited from ReactorBase
size_t | m_nsp
| Number of homogeneous species in the mixture. More...
ThermoPhase * | m_thermo
double | m_vol
| Current volume of the reactor [m^3]. More...
double | m_enthalpy
| Current specific enthalpy of the reactor [J/kg]. More...
double | m_intEnergy
| Current internal energy of the reactor [J/kg]. More...
double | m_pressure
| Current pressure in the reactor [Pa]. More...
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
| Vector of length nWalls(), indicating whether this reactor is on the left (0) or right (1) of each wall. More...
std::string | m_name
ReactorNet * | m_net
| The ReactorNet that this reactor is part of. More...

## Detailed Description

A source or sink whose state remains constant regardless of any flows or other interactions with other Reactor objects.

Definition at line 17 of file Reservoir.h.

## Constructor & Destructor Documentation

## ◆ Reservoir()

Reservoir | ( |  | ) |
| inline

Definition at line 20 of file Reservoir.h.

## Member Function Documentation

## ◆ typeStr()

virtual std::string typeStr | ( |  | ) | const
| inline virtual

String indicating the reactor model implemented.

Usually corresponds to the name of the derived class.

Deprecated:
  To be removed after Cantera 2.6. Use type() instead.

Reimplemented from ReactorBase.

Definition at line 22 of file Reservoir.h.

References Cantera::warn_deprecated().

## ◆ type()

virtual std::string type | ( |  | ) | const
| inline virtual

String indicating the reactor model implemented.

Usually corresponds to the name of the derived class.

Reimplemented from ReactorBase.

Definition at line 28 of file Reservoir.h.

## ◆ initialize()

virtual void initialize | ( | doublereal | t0 = `0.0` | ) |
| inline virtual

Initialize the reactor.

Called automatically by ReactorNet::initialize.

Reimplemented from ReactorBase.

Definition at line 32 of file Reservoir.h.

## ◆ insert() [1/2]

void insert | ( | ThermoPhase & | contents | ) |
| inline

Definition at line 34 of file Reservoir.h.

## ◆ insert() [2/2]

void insert | ( | shared_ptr< Solution > | sol | ) |
| inline

Definition at line 38 of file Reservoir.h.

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

- Reservoir.h