| Cantera 3.0.0

Loading...
Searching...
No Matches
Public Member Functions | List of all members
Reservoir Class Reference
Zero-Dimensional Reactor Networks » Reactors

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]

## Detailed Description

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.
void | insert (ThermoPhase &contents)
void | insert (shared_ptr< Solution > sol)
Public Member Functions inherited from ReactorBase
| ReactorBase (const string &name="(none)")
| ReactorBase (const ReactorBase &)=delete
ReactorBase & | operator= (const ReactorBase &)=delete
string | name () const
| Return the name of this reactor.
void | setName (const string &name)
| Set the name of this reactor.
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 correspond to the state of the associated ThermoPhase object.
ThermoPhase & | contents ()
| return a reference to the contents.
const ThermoPhase & | contents () 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.
ReactorNet & | network ()
| The ReactorNet that this reactor belongs to.
void | setNetwork (ReactorNet *net)
| Set the ReactorNet that this reactor belongs to.
void | setInitialVolume (double vol)
| Set the initial reactor volume. By default, the volume is 1.0 m^3.
virtual void | setThermoMgr (ThermoPhase &thermo)
| Specify the mixture contained in the reactor.
virtual void | setKineticsMgr (Kinetics &kin)
| Specify chemical kinetics governing the reactor.
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.
void | addInlet (FlowDevice &inlet)
| Connect an inlet FlowDevice to this reactor.
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.
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)
ReactorSurface * | surface (size_t n)
| Return a reference to the n-th ReactorSurface connected to this reactor.
virtual size_t | nSurfs ()
| Return the number of surfaces in a reactor.
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.

## Additional Inherited Members
Protected Attributes inherited from ReactorBase
size_t | m_nsp = 0
| Number of homogeneous species in the mixture.
ThermoPhase * | m_thermo = nullptr
double | m_vol = 1.0
| Current volume of the reactor [m^3].
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
ReactorNet * | m_net = nullptr
| The ReactorNet that this reactor is part of.

## Constructor & Destructor Documentation

## ◆ Reservoir()

Reservoir | ( |  | ) |
| inline

Definition at line 21 of file Reservoir.h.

## Member Function Documentation

## ◆ type()

string type | ( |  | ) | const
| inline override virtual

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.

## ◆ initialize()

void initialize | ( | double | t0 = `0.0` | ) |
| inline override virtual

Initialize the reactor.

Called automatically by ReactorNet::initialize.

Reimplemented from ReactorBase.

Definition at line 27 of file Reservoir.h.

## ◆ insert() [1/2]

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

Definition at line 29 of file Reservoir.h.

## ◆ insert() [2/2]

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

Definition at line 33 of file Reservoir.h.

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

- Reservoir.h