Cantera 2.6.0

IdealGasReactor.h
Go to the documentation of this file.
1//! @file IdealGasReactor.h
2
3// This file is part of Cantera. See License.txt in the top-level directory or
4// at https://cantera.org/license.txt for license and copyright information.
5
6#ifndef CT_IDEALGASREACTOR_H
7#define CT_IDEALGASREACTOR_H
8
9#include "Reactor.h"
10
11 namespace Cantera
12{
13
14/**
15 * Class IdealGasReactor is a class for stirred reactors that is specifically
16 * optimized for ideal gases. In this formulation, temperature replaces the
17 * total internal energy as a state variable.
18 */
19 class IdealGasReactor : public Reactor
20{
21 public:
22 IdealGasReactor() {}
23
24 virtual std::string typeStr() const {
25 warn_deprecated("IdealGasReactor::typeStr",
26 "To be removed after Cantera 2.6. Use type() instead.");
27 return "IdealGasReactor";
28 }
29
30 virtual std::string type() const {
31 return "IdealGasReactor";
32 }
33
34 virtual void setThermoMgr(ThermoPhase& thermo);
35
36 virtual void getState(doublereal* y);
37
38 virtual void initialize(doublereal t0 = 0.0);
39
40 virtual void eval(double t, double* LHS, double* RHS);
41
42 virtual void updateState(doublereal* y);
43
44 //! Return the index in the solution vector for this reactor of the
45 //! component named *nm*. Possible values for *nm* are "mass",
46 //! "volume", "temperature", the name of a homogeneous phase species, or the
47 //! name of a surface species.
48 virtual size_t componentIndex(const std::string& nm) const;
49 std::string componentName(size_t k);
50
51 protected:
52 vector_fp m_uk; //!< Species molar internal energies
53};
54
55}
56
57#endif
Reactor.h
Cantera::IdealGasReactor
Class IdealGasReactor is a class for stirred reactors that is specifically optimized for ideal gases.
Definition: IdealGasReactor.h:20
Cantera::IdealGasReactor::componentIndex
virtual size_t componentIndex(const std::string &nm) const
Return the index in the solution vector for this reactor of the component named nm.
Definition: IdealGasReactor.cpp:140
Cantera::IdealGasReactor::updateState
virtual void updateState(doublereal *y)
Set the state of the reactor to correspond to the state vector y.
Definition: IdealGasReactor.cpp:61
Cantera::IdealGasReactor::eval
virtual void eval(double t, double *LHS, double *RHS)
Evaluate the reactor governing equations.
Definition: IdealGasReactor.cpp:74
Cantera::IdealGasReactor::typeStr
virtual std::string typeStr() const
String indicating the reactor model implemented.
Definition: IdealGasReactor.h:24
Cantera::IdealGasReactor::getState
virtual void getState(doublereal *y)
Get the the current state of the reactor.
Definition: IdealGasReactor.cpp:29
Cantera::IdealGasReactor::componentName
std::string componentName(size_t k)
Return the name of the solution component with index i.
Definition: IdealGasReactor.cpp:156
Cantera::IdealGasReactor::type
virtual std::string type() const
String indicating the reactor model implemented.
Definition: IdealGasReactor.h:30
Cantera::IdealGasReactor::initialize
virtual void initialize(doublereal t0=0.0)
Initialize the reactor.
Definition: IdealGasReactor.cpp:55
Cantera::IdealGasReactor::setThermoMgr
virtual void setThermoMgr(ThermoPhase &thermo)
Specify the mixture contained in the reactor.
Definition: IdealGasReactor.cpp:18
Cantera::IdealGasReactor::m_uk
vector_fp m_uk
Species molar internal energies.
Definition: IdealGasReactor.h:52
Cantera::Reactor
Class Reactor is a general-purpose class for stirred reactors.
Definition: Reactor.h:41
Cantera::ThermoPhase
Base class for a phase with thermodynamic properties.
Definition: ThermoPhase.h:102
Cantera
Namespace for the Cantera kernel.
Definition: AnyMap.cpp:557
Cantera::warn_deprecated
void warn_deprecated(const std::string &source, const AnyBase &node, const std::string &message)
A deprecation warning for syntax in an input file.
Definition: AnyMap.cpp:1901
Cantera::vector_fp
std::vector< double > vector_fp
Turn on the use of stl vectors for the basic array type within cantera Vector of doubles.
Definition: ct_defs.h:184