Cantera  3.1.0a1
Loading...
Searching...
No Matches
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]

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)
 
 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
 
void insert (shared_ptr< Solution > sol)
 
- Public Member Functions inherited from ReactorBase
 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.
 
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 correspond to the state of 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.
 
void setInitialVolume (double vol)
 Set the initial reactor volume. By default, the volume is 1.0 m^3.
 
void insert (shared_ptr< Solution > sol)
 
virtual void setThermoMgr (ThermoPhase &thermo)
 Specify the mixture contained in the reactor.
 
virtual void setKineticsMgr (Kinetics &kin)
 
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.
 
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.
 
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)
 
ReactorSurfacesurface (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.
 
ThermoPhasem_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
 
ReactorNetm_net = nullptr
 The ReactorNet that this reactor is part of.
 
shared_ptr< Solutionm_solution
 Composite thermo/kinetics/transport handler.
 

Member Function Documentation

◆ type()

string type ( ) const
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.

◆ initialize()

void initialize ( double  t0 = 0.0)
inlineoverridevirtual

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
Deprecated:
Unused; to be removed after Cantera 3.1.

Definition at line 30 of file Reservoir.h.

◆ ReactorBase() [1/2]

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

Definition at line 53 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 58 of file ReactorBase.cpp.

◆ insert() [2/2]

void insert ( shared_ptr< Solution sol)
Deprecated:
To be removed after Cantera 3.1. Superseded by setSolution.

Definition at line 93 of file ReactorBase.cpp.


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