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:

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.
	ReactorBase (const string &name="(none)")
	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
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 (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.
void	setSolution (shared_ptr< Solution > sol)
	Set the Solution specifying the ReactorBase content.
shared_ptr< Solution >	contents4 ()
	Access the Solution object used to represent the contents of this reactor.
shared_ptr< const Solution >	contents4 () const
	Access the Solution object used to represent the contents of this reactor.
virtual 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.
ThermoPhase &	contents ()
	return a reference to the contents.
const ThermoPhase &	contents () const
	return a reference to the contents.
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.
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 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.
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.
void	addSurface (shared_ptr< ReactorBase > 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.
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 Member Functions inherited from ReactorBase
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 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_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.
ReactorNet *	m_net = nullptr
	The ReactorNet that this reactor is part of.
shared_ptr< Solution >	m_solution
	Composite thermo/kinetics/transport handler.
vector< SensitivityParameter >	m_sensParams

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.

ReactorBase() [1/3]

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

explicit

Deprecated:

After Cantera 3.2, this constructor will become protected

Definition at line 52 of file ReactorBase.cpp.

ReactorBase() [2/3]

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

Instantiate a ReactorBase object with Solution contents.

Parameters

sol	Solution object to be set.
name	Name of the reactor.

Since

New in Cantera 3.1.

Definition at line 58 of file ReactorBase.cpp.

ReactorBase() [3/3]

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

Instantiate a ReactorBase object with Solution contents.

Parameters

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.

Since

Added the 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 69 of file ReactorBase.cpp.

---

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

• Reservoir.h