| Cantera 3.0.0

Loading...
Searching...
No Matches
GasKinetics.h
Go to the documentation of this file.
1/**
2 * @file GasKinetics.h
3 */
4
5// This file is part of Cantera. See License.txt in the top-level directory or
6// at https://cantera.org/license.txt for license and copyright information.
7
8#ifndef CT_GASKINETICS_H
9#define CT_GASKINETICS_H
10
11#include "BulkKinetics.h"
12#include "Reaction.h"
13
14#ifndef CT_SKIP_DEPRECATION_WARNINGS
15#pragma message("warning: GasKinetics.h and class GasKinetics are deprecated and will " \
16 "be removed after Cantera 3.0. Replace with class BulkKinetics.")
17#endif
18
19 namespace Cantera
20{
21
22/**
23 * Kinetics manager for elementary gas-phase chemistry. This kinetics manager
24 * implements standard mass-action reaction rate expressions for low-density
25 * gases.
26 * @ingroup kineticsmgr
27 * @deprecated Replace with BulkKinetics. To be removed after %Cantera 3.0.
28 */
29 class GasKinetics : public BulkKinetics
30{
31 public:
32
33 //! Constructor.
34 GasKinetics() {}
35
36 //! @deprecated To be removed after %Cantera 3.0; code base only uses default.
37 GasKinetics(ThermoPhase* thermo) : GasKinetics() {
38 warn_deprecated("GasKinetics::GasKinetics(ThermoPhase*)",
39 "To be removed after Cantera 3.0. Use default constructor instead.");
40 addPhase(*thermo);
41 }
42
43 string kineticsType() const override {
44 return "gas";
45 }
46
47 //! Update temperature-dependent portions of reaction rates and falloff
48 //! functions.
49 virtual void update_rates_T() {
50 warn_deprecated("GasKinetics::update_rates_T",
51 "Class GasKinetics has been merged into class BulkKinetics, and the "
52 "update_rates_T() method is now part of updateROP(). Class GasKinetics "
53 "will be removed after Cantera 3.0.");
54 updateROP();
55 }
56
57 //! Update properties that depend on concentrations.
58 //! Currently the enhanced collision partner concentrations are updated
59 //! here, as well as the pressure-dependent portion of P-log and Chebyshev
60 //! reactions.
61 virtual void update_rates_C() {
62 warn_deprecated("GasKinetics::update_rates_C",
63 "Class GasKinetics has been merged into class BulkKinetics, and the "
64 "update_rates_T() method is now part of updateROP(). Class GasKinetics "
65 "will be removed after Cantera 3.0.");
66 updateROP();
67 }
68
69};
70
71}
72
73#endif
BulkKinetics.h
Reaction.h
Cantera::BulkKinetics
Specialization of Kinetics for chemistry in a single bulk phase.
Definition BulkKinetics.h:21
Cantera::GasKinetics
Kinetics manager for elementary gas-phase chemistry.
Definition GasKinetics.h:30
Cantera::GasKinetics::kineticsType
string kineticsType() const override
Identifies the Kinetics manager type.
Definition GasKinetics.h:43
Cantera::GasKinetics::GasKinetics
GasKinetics(ThermoPhase *thermo)
Definition GasKinetics.h:37
Cantera::GasKinetics::GasKinetics
GasKinetics()
Constructor.
Definition GasKinetics.h:34
Cantera::GasKinetics::update_rates_C
virtual void update_rates_C()
Update properties that depend on concentrations.
Definition GasKinetics.h:61
Cantera::GasKinetics::update_rates_T
virtual void update_rates_T()
Update temperature-dependent portions of reaction rates and falloff functions.
Definition GasKinetics.h:49
Cantera::Kinetics::thermo
ThermoPhase & thermo(size_t n=0)
This method returns a reference to the nth ThermoPhase object defined in this kinetics mechanism.
Definition Kinetics.h:254
Cantera::Kinetics::addPhase
virtual void addPhase(ThermoPhase &thermo)
Definition Kinetics.cpp:616
Cantera::ThermoPhase
Base class for a phase with thermodynamic properties.
Definition ThermoPhase.h:390
Cantera
Namespace for the Cantera kernel.
Definition AnyMap.cpp:564
Cantera::warn_deprecated
void warn_deprecated(const string &source, const AnyBase &node, const string &message)
A deprecation warning for syntax in an input file.
Definition AnyMap.cpp:1926