[SCons] Remove legacy_rate_constants option

Cantera · May 28, 2022 · e41449e · e41449e
1 parent d6b2c22
commit e41449e
Show file tree

Hide file tree

Showing 9 changed files with 1 addition and 36 deletions.
diff --git a/SConstruct b/SConstruct
@@ -578,15 +578,6 @@ config_options = [
         "verbose_tests",
         "If enabled, verbose test output will be shown.",
         False),
-    BoolOption(
-        "legacy_rate_constants",
-        """If enabled, rate constant calculations include third-body concentrations
-           for three-body reactions, which corresponds to a legacy implementation used
-           prior to Cantera 3.0. The option is disabled by default, such that rate
-           constant calculations are consistent with conventional definitions
-           (see Eq. 9.75 in Kee, Coltrin and Glarborg, 'Chemically Reacting Flow',
-           Wiley Interscience, 2003).""",
-        False),
 ]
 
 config = Configuration()
@@ -1847,11 +1838,6 @@ if env.get('has_sundials_lapack') and env['use_lapack']:
 else:
     configh['CT_SUNDIALS_USE_LAPACK'] = 0
 
-if env['legacy_rate_constants']:
-    configh['CT_LEGACY_RATE_CONSTANTS'] = 1
-else:
-    configh['CT_LEGACY_RATE_CONSTANTS'] = 0
-
 cdefine('LAPACK_FTN_STRING_LEN_AT_END', 'lapack_ftn_string_len_at_end')
 cdefine('LAPACK_FTN_TRAILING_UNDERSCORE', 'lapack_ftn_trailing_underscore')
 cdefine('FTN_TRAILING_UNDERSCORE', 'lapack_ftn_trailing_underscore')

diff --git a/include/cantera/base/config.h.in b/include/cantera/base/config.h.in
@@ -65,7 +65,4 @@ typedef int ftnlen;       // Fortran hidden string length type
 //    built to use this option
 {CT_SUNDIALS_USE_LAPACK!s}
 
-//    Use legacy rate constant by default
-{CT_LEGACY_RATE_CONSTANTS!s}
-
 #endif
diff --git a/interfaces/cython/cantera/test/test_jacobian.py b/interfaces/cython/cantera/test/test_jacobian.py
@@ -20,7 +20,6 @@ class RateExpressionTests:
 
     @classmethod
     def setUpClass(cls):
-        ct.use_legacy_rate_constants(False)
         cls.tpx = cls.gas.TPX
 
         cls.r_stoich = cls.gas.reactant_stoich_coeffs
@@ -534,7 +533,6 @@ class FullTests:
 
     @classmethod
     def setUpClass(cls):
-        ct.use_legacy_rate_constants(False)
         cls.tpx = cls.gas.TPX
 
     def setUp(self):

diff --git a/interfaces/cython/cantera/test/test_kinetics.py b/interfaces/cython/cantera/test/test_kinetics.py
@@ -59,16 +59,9 @@ def test_multiplier(self):
         self.assertArrayNear(0.5 * rev_rates0, rev_rates2)
 
     def test_legacy_reaction_rate(self):
-        ct.use_legacy_rate_constants(True) # set to False for test suite
-        with self.assertRaisesRegex(ct.CanteraError, "Deprecated: Behavior to change"):
-            self.phase.forward_rate_constants
-
-        ct.suppress_deprecation_warnings() # disable fatal deprecation warnings
+        ct.use_legacy_rate_constants(True)
         fwd_rates_legacy = self.phase.forward_rate_constants
-
         ct.use_legacy_rate_constants(False)
-        ct.make_deprecation_warnings_fatal() # re-enable fatal deprecation warnings
-
         fwd_rates = self.phase.forward_rate_constants
         ix_3b = np.array([r.reaction_type == "three-body" for r in self.phase.reactions()])
         ix_other = ix_3b == False

diff --git a/interfaces/cython/cantera/test/utilities.py b/interfaces/cython/cantera/test/utilities.py
@@ -67,7 +67,6 @@ def setUpClass(cls):
             cls.using_tempfile = True
 
         cantera.make_deprecation_warnings_fatal()
-        cantera.use_legacy_rate_constants(False)
         cantera.add_directory(cls.test_work_path)
         cls.test_data_path = TEST_DATA_PATH
         cls.cantera_data_path = CANTERA_DATA_PATH

diff --git a/src/base/application.cpp b/src/base/application.cpp
@@ -129,11 +129,7 @@ Application::Application() :
     m_suppress_thermo_warnings(false),
     m_suppress_warnings(false),
     m_fatal_warnings(false),
-#if CT_LEGACY_RATE_CONSTANTS
-    m_use_legacy_rate_constants(true)
-#else
     m_use_legacy_rate_constants(false)
-#endif
 {
     // install a default logwriter that writes to standard
     // output / standard error

diff --git a/src/base/application.h b/src/base/application.h
@@ -366,8 +366,6 @@ class Application
      * and Glarborg, 'Chemically Reacting Flow', Wiley Interscience, 2003). If set to
      * 'true', output for rate constants of three-body reactions is multiplied by
      * third-body concentrations (legacy behavior prior to Cantera 3.0).
-     * For user-compiled Cantera, the default behavior can be changed by the SCons flag
-     * 'legacy_rate_constants'.
      */
     void use_legacy_rate_constants(bool legacy=true) {
         m_use_legacy_rate_constants = legacy;

diff --git a/test/general/string_processing.cpp b/test/general/string_processing.cpp
@@ -118,7 +118,6 @@ int main(int argc, char** argv)
     printf("Running main() from string_processing.cpp\n");
     testing::InitGoogleTest(&argc, argv);
     Cantera::make_deprecation_warnings_fatal();
-    Cantera::use_legacy_rate_constants(false);
     int result = RUN_ALL_TESTS();
     Cantera::appdelete();
     return result;

diff --git a/test/kinetics/pdep.cpp b/test/kinetics/pdep.cpp
@@ -226,7 +226,6 @@ int main(int argc, char** argv)
 {
     printf("Running main() from pdep.cpp\n");
     Cantera::make_deprecation_warnings_fatal();
-    Cantera::use_legacy_rate_constants(false);
     testing::InitGoogleTest(&argc, argv);
     int result = RUN_ALL_TESTS();
     Cantera::appdelete();