Cantera  3.1.0b1
Loading...
Searching...
No Matches
IdealGasMoleReactor.h
Go to the documentation of this file.
1//! @file IdealGasMoleReactor.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_IDEALGASMOLE_REACTOR_H
7#define CT_IDEALGASMOLE_REACTOR_H
8
10
11namespace Cantera
12{
13
14/**
15 * IdealGasMoleReactor is a class for ideal gas constant-volume reactors which use a
16 * state of moles.
17 * @since New in %Cantera 3.0
18 * @ingroup reactorGroup
19 */
21{
22public:
23 using MoleReactor::MoleReactor; // inherit constructors
24
25 string type() const override {
26 return "IdealGasMoleReactor";
27 }
28
29 size_t componentIndex(const string& nm) const override;
30
31 string componentName(size_t k) override;
32
33 void getState(double* y) override;
34
35 void initialize(double t0=0.0) override;
36
37 void eval(double t, double* LHS, double* RHS) override;
38
39 void updateState(double* y) override;
40
41 //! Calculate an approximate Jacobian to accelerate preconditioned solvers
42
43 //! Neglects derivatives with respect to mole fractions that would generate a
44 //! fully-dense Jacobian. Currently, also neglects terms related to interactions
45 //! between reactors, for example via inlets and outlets.
46 Eigen::SparseMatrix<double> jacobian() override;
47
48 bool preconditionerSupported() const override {return true;};
49
50protected:
51 void setThermo(ThermoPhase& thermo) override;
52
53 vector<double> m_uk; //!< Species molar internal energies
54};
55
56}
57
58#endif
IdealGasMoleReactor is a class for ideal gas constant-volume reactors which use a state of moles.
bool preconditionerSupported() const override
Return a false if preconditioning is not supported or true otherwise.
void eval(double t, double *LHS, double *RHS) override
Evaluate the reactor governing equations.
string type() const override
String indicating the reactor model implemented.
size_t componentIndex(const string &nm) const override
Return the index in the solution vector for this reactor of the component named nm.
Eigen::SparseMatrix< double > jacobian() override
Calculate an approximate Jacobian to accelerate preconditioned solvers.
vector< double > m_uk
Species molar internal energies.
void getState(double *y) override
Get the the current state of the reactor.
string componentName(size_t k) override
Return the name of the solution component with index i.
void setThermo(ThermoPhase &thermo) override
Specify the mixture contained in the reactor.
void updateState(double *y) override
Set the state of the reactor to correspond to the state vector y.
void initialize(double t0=0.0) override
Initialize the reactor.
MoleReactor is meant to serve the same purpose as the reactor class but with a state vector composed ...
Definition MoleReactor.h:21
Base class for a phase with thermodynamic properties.
Namespace for the Cantera kernel.
Definition AnyMap.cpp:595