Cantera 2.4.0¶

Published on August 24, 2018 | Full release on Github

Cantera 2.4.0 includes more than 380 commits to the code since 2.3.0, merges more than 70 pull requests, and closes almost 60 issues. In this release, we improved the maintainability of Cantera by removing or deprecating old, untested code, moving the website and Mixmaster to separate repositories, and automating more of the build/testing process. We also added new features to the 1-D reactor code (among other areas), including adding an ionized gas transport class and the IonFlow and BurnerIonFlame classes, providing better accessing to callbacks during 1-D solutions, and automatically detecting certain common failure conditions of the 1-D solver. This release of Cantera was made possible by contributions from 14 developers: @speth, @bryanwweber, @BangShiuh, @decaluwe, @wandadars, @jsantner, @arghdos, @rwest, @g3bk47, @awehrfritz, @band-a-prend, @vdevgan, @KyleLinevitchJr, and @MarcDuQuesne.

For installation and compilation instructions for Cantera 2.4.0, please see the directions on the Cantera website. In addition to Conda packages, Windows installers, and Ubuntu packages, this release also features the addition of a pre-compiled Matlab toolbox for macOS users, replacing Homebrew as the prefered method of installing Cantera for Matlab on macOS.

Thanks to a small development grant from NumFOCUS (see more about NumFOCUS below), @bryanwweber and @decaluwe reorganized and restyled the Cantera website. The website has moved to a separate repository, allowing the website content to be updated without modifications to the main Cantera source code. We also tried to make it easy for all of our users to find what they're looking for quickly, from installation instructions and tutorials for beginners, to advanced examples and API documentation for experienced Cantera programmers. The new website also redirects all traffic to HTTPS, ensuring a secure experience for everyone.

Cantera is now officially part of NumFOCUS. NumFOCUS is a 501(c)3 nonprofit dedicated to supporting the open source scientific computing community. If you are interested in learning more about NumFOCUS, please visit their website at numfocus.org, or our website at cantera.org/community.html#donations.

Cantera 2.4.0 is the last release that will be compatible with Python 2.7. Support for Python 2.7 from the Python Software Foundation will end January 1, 2020. Given the recent release cadence of Cantera, the next major version of Cantera will probably be released very close to that date, so we have made the decision to drop Python 2.7 support for Cantera 2.5.0 and higher.

One notable change to the build requirements for Cantera 2.4.0 is that SCons 3.0.0 or higher must be used to compile the source code. This means that either Python 2 or Python 3 can be used to run SCons. In addition, there are now three options to handle building the Python interface, depending on whether the user wants to build for Python 2 or Python 3. Please check the documentation or run scons help for more information.

Summary of changes in Cantera 2.4.0¶

Bugs fixed¶

• Fix inconstencies and bugs in several ThermoPhase derived classes, including PDSS_IdealGas, IonsFromNeutralVPSSTP, PDSS_IonsFromNeutral, PDSS_HKFT, LatticePhase, PDSS_SSVol, ConstDensityThermo, and PureFluidPhase
• Preserve constant property pair when multiplying Quantity objects
• Fix using pure fluids in reactors
• Add temperature dependence of rotational relaxation in transport calculations
• Disable linking to external SUNDIALS libraries when building the Matlab toolbox

Changes to existing capabilities¶

• Allow instantiation of ThermoPhase derived classes without XML
• set_equivalence_ratio now supports sulfur oxidation
• Make all complex object types (ThermoPhase, Kinetics, Transport, Reactor, Domain1D, etc.) objects non-copyable
• Deprecate FreeFlow and AxiStagnFlow classes by moving the relevant functions into the StFlow class
• Allow convertMech function to be called multiple times
• Remove the requirement for users to have Boost headers installed when building against the Cantera library
• Change the options to build the Python interface, since SCons can be run by Python 3
• Update GTest, fmtlib, SUNDIALS, and Eigen submodule versions

Additions¶

• Add ion gas transport model, and IonFlow and BurnerIonFlame flame classes
• Add C++ OpenMP, Non-Ideal Shock Tube, PSR/WSR, and time-dependent mass flow rate examples
• Add class AnyMap
• Allow negative reaction orders
• Add unity Lewis number transport model
• Add electron to the built-in elements
• Add get_equivalence_ratio function

Full Changelog¶

Bugs fixed¶

Thermo/Species/Elements¶

• Fix issues parsing composition strings with mixtures of commas, colons, and spaces (3f6f580)
• Fix setting mass/mole fractions of phases with only a single species (ed8de04)
• Fix reference state calculations (38d291c, 7b529ac)
• Fix test failures due to inconsistent species addition order (11a0727, #433)
• Fix errors in entropy calculation in PDSS_IdealGas (dfb32f0)
• Fix and test creation of IonsFromNeutralVPSSTP objects (3a11938)
• Fix inconsistentices in PDSS_IonsFromNeutral (ff46dc9)
• Fix PDSS_HKFT initialization when only one property is given (2c3512c)
• Fix default molar volume in LatticePhase (f3ba29f)
• Setting the composition with an empty array raises an exception (8a4142d)
• Fix implementation and documentation of PDSS_SSVol (ee663c9, a19b2bd, 286217d, be8e51d)
• Fix definition of ConstDensityThermo::standardConcentration (89fded3, #458, #490)
• Preserve constant property pair when multiplying Quantity objects (c9b0bce)
• Fix PureFluidPhase state data consistency (fb68cae, 0417d31)

Kinetics¶

• Validate balance of surface sites for interface reactions (ac53371, #412)
• Reactions which are declared as duplicate but do not have the corresponding duplicate reaction are errors (0fd2f7c, 2678b57, #389)
• Fix use of 'scale' and 'OneWayFlow' options in ReactonPathDiagrams (0d982c8, 0249ce8, #378, #424)
• Fix how species contributions to reaction paths are handled (3093e6e, 5a0fb57, 092e007, #377, #424)
• Preserve pressure units in PLOG reactions when converting from Chemkin to CTI format (7b7aea2, a02753a, #435)
• Fix style arguments for reaction path diagrams (b41038f, #463)
• Fix duplicate reaction checking (513b432, 4c489c1, #468)
• Fix failures due to tolerances in some kinetics tests (67aa9eb)

Transport¶

• Fixes to enable CK_mix and CK_multi mode flags (35aa8be, 435f286, 1b60513)
• Add temperature dependence of rotational relaxation (e79cf6f, #547)

0-D Reactors¶

• Fix using pure fluids in reactors (2ac8a0e, deeaaed, #475, #487)
• Check that contents are Solution objects not Mixtures (a22db9f)

1-D Flames¶

• Fix handling of domain boundary conditions when the energy equation is not solved (52dbe8c)
• Fix handling of Soret diffusion enabling/disabling with respect to mixture-averaged diffusion approximation (a03afbd, 4bd5e92, fde5051, #511)

CTI/Input files¶

• Fix file size limit when converting CTI to CTML (0a1257d, #416, #430)
• Fix for reactions with pathologically named third bodies (55a8910, 6d591b8, 44b24ca, #460)
• ctml_writer is more tolerant of non-ASCII characters (0c0a38d)
• Fix incorrect entry in nasathermo.dat (3933a94, #491)
• Fix writing surface reactions to the CTI file when there are no gas-phase reactions (552ba97)
• Fix over-zealous detection of new input file sections (f47e98a)
• Detect badly-formatted values of the 4th Troe coefficient (bde6e05)
• Suppress some output when quiet=True (70016b9)
• Fix duplicate key check in parseCompString (d091617, #525)
• Fix spurious unexpected output warnings (fd57936)

Examples¶

• Fix errors and empty figures in IC engine example (6f564e6, 0d01d03)
• Remove extraneous arguments in Matlab example scripts (a31b7d1)
• Remove or fix broken Matlab examples (536158b, 987a247)

Other¶

• Add explicit dependencies on the scons build step for scons test and scons install (70e1063, #432)
• Fix reproducibility of add_species_sequential test (11a0727, #433)
• Disable linking to external SUNDIALS libraries when building the Matlab toolbox (c125878, #431, #456)
• Switch SourceForge links in the docs to point to GitHub (d920f2e, #442, #455)
• Fix typos in documentation (05809bb, fec6c34, 35ac1ac, af4ccae, #449)
• Easier debugging of NumPy import error messages during build (3f69f6a)
• Use Trusty Tahr and system Python 3 on TravisCI Linux builds (9e5da87, 45891a2)
• Fix parallel builds of the Matlab toolbox (8312396, #483)
• Remove outdated MacPorts installation instructions (46f8ef5, #496)
• Fix wrong environment variable MATLAB_PATH -> MATLABPATH (d86a7c1, #501)
• Fix broken links in README, clarify PR template, add Gitter, add badges (e052a44, 8de267f, de3ec3d, 0120f2f, #505, #506, #513)
• Fix installing dependencies on Appveyor (39c4103, 0b8f028, b1a010e, #517, #529)
• Add update of git submodules to code checkout instructions (66ba4b5)
• Remove blank documentation page (84acdb1, #518)
• Fix notation for mixture-averaged diffusion coefficient (df6ecb1)
• Fix compilier warning about m_Faraday_dim (55490de)
• Fix catching exceptions when checking git commit during build (3fac5f2, c830537)
• Fix display of information from errors in Python callbacks (d3f49e7)
• Clean the correct folder after building the minimal Python interface (ff91457)
• Fix building MSI for Python 3.7 module (af51a61)

Changes to existing capabilities¶

Thermo/Species/Elements¶

• PDSS objects store their own data (50ed3f2)
• Remove VPSSMgr and merge into VPStandardStateTP (b39537b, #428)
• Simplify aqueous phase creation in VPStandardStateTP (3ea2a6c)
• Allow instantiation of ThermoPhase derived classes without XML (86dca05, 507a3a9, 19c17d1, db1f1af, 5efea12, 3c771de, b033d44, 31d54c3, 95a52b2, f8ef4a8, a6ac446, bfdc2b9, f69ef44, d744bd9, 3676672, aa02d24, e3afaf5, 3790115, 4c630fc, a520f78)
• Clean up and test RedlichKwongMFTP implementation and remove broken "sanity checks" (ecbd819, dd521de, f9d5f16, #267, #436, #438)
• Move common PDSS functions into the the PDSS_Nondimensional class (574462f)
• Remove unused thermodynamics models from ThermoFactory (6154e1b)
• Deprecate several unused/untested classes. See the deprecation list for details. (2b73fe2, 6d22be2, #267)
• Remove unimplemented options from DebyeHuckel (afafa34)
• Charge transfer reactions can be set for surface_reactions, not just edge_reactions (51f419f, #439)
• Remove unused members from some thermo classes (4818c87, 6bfd82e, 90d18dd, c85ba58, cfc3b72, 6ca7820, d07908f, 4b69c7f, 572af61)
• Store several class properties as shared_ptrs (04f1097, 4856d13)
• Remove debug exception from Phase::entropyElement298 (d433824, #467)
• Explicitly assume that the solvent species is always the first species in the phase (e33fe69)
• Move implementation of HMWSoln to a single file (e9f08fc)
• Try to look up standard entropy when adding undefined elements (0ca788b)
• Always use PDSS_ConstVol for constant volume standard state and remove the implementation from PDSS_SSVol (822cdc7)
• Make adding undefined elements the default behavior (d035557)
• set_equivalence_ratio now supports sulfur oxidation (48eaedb, acbd65d, aac8eb9, #474)
• Relax warning threshold for heat capacity discontinuities (a68c048)

Equilibrium Solvers¶

• Various clean ups, refactoring, and simplifications to the VCS solver (ee323bb, 08726b0, da801f4, 8522095, bba0d8e, 1eebd3e, da3ba35, 4e53c89, 7eb939d, 739d4e4)
• Improve control of logging in the ChemEquil solver (5b4a977)
• Don't use saved element potentials as an initial guess and deprecate getter/setter methods (74167cc, 3c978cd, #538)

Transport¶

• Allow construction of Transport derived classes without XML (4b5af64, 7020fa7)
• Move simpleTransport test to GTest suite (4934079)

0-D Reactors¶

• Make all reactor-related objects non-copyable (d9418bb)

1-D Flames¶

• Make all 1-D-related objects non-copyable (279c5c8)
• Deprecate FreeFlow and AxiStagnFlow classes by moving the relevant functions into the StFlow class (c1067aa, 3ade333, a54ab2f, #546, #548)

CTI/XML/Input Files¶

• Make searches for child nodes case insensitive (1bd950f)
• Improve error messages for invalid (floating point) geometry flags (6bf74d1, #446, #454)

Examples/Samples¶

• Remove verbose output from f77 demo wrapper (172e9ff)

Documentation¶

• Note requirement to use modifySpecies and modifyReaction (4b4128a, #394, #542)
• Clarify the values returned by getFwdRateConstants (831b92d)
• Move most content from the old documentation to the new website (7b6d04c, cc9c8e5, 71072c4, e81cac9, e7f346c, 7a69386, d57f1d1, b68a87d, 21db5d8, 3052701, 2a7aed8, e8d28b0, dbc3df1, 2f3a012, 9670c5d, 3fae1c1, 4ea9d35, 5494636, d225203, c28bc02, d33e67c, 7e1b6a1, 3384041, 0d55977, b84d3e3, 053267e, 1864e8f, 5f556ac, 045f3d3, 1ca6c5e, 323c737, #544)

Other¶

• Move MixMaster into a separate repository (886d7b7)
• Propagation of environment variables in SCons is more sensible (e5edc31, 3c82c3a, eae9250, 66998a5)
• Remove deprecated code (7673f7c, 3accd41)
• Print error messages from and pass flags to GTest (fca22d9, 461b63e)
• Remove the requirement for clients to have Boost headers installed when building against the Cantera library (713b9cc, f8d1832, 686250e, 87a7deb, 83ffd84, #480)
• Update to GTest 1.8.0 (60d2075, #482)
• Remove HAS_NO_PYTHON configuration variable (16fd183, #483)
• Change the options to build the Python interface, since SCons can be run by Python 3 (94ea9b5, 2bc4d09, 6ca67b4, 11943bb, 7054a7b, f824b20, 43b42e9, c233ddc, 9f4590b, 9c9ee9e, 5d599bb, 4e6af27, 3e39a0b, #483, #486, #488)
• Check for 3to2 during build by importing the library, rather than running a script (77ee76c, #483)
• Use std::sort to eliminate need for vcs_optMax (07eed36)
• Google Test suite can be disabled entirely (fb4a36b, 9bad354, 333d388, #535)
• Improve behavior of Matlab test suite (bdaabc0, 677efd8, b5b542d)

Additions¶

Thermo/Species/Elements¶

• Allow synonyms for Factory model names (c28ca48)
• Add electron to the built-in elements (974bbc7, #443)
• Identify unspecified electrochemical reactions (04be988, #452)
• Make activity coefficients and activities available (a5b0bdf)
• Add regression tests for some thermo classes (338b216)
• Create a default constructor for PDSS objects and avoid unnecessary arguments in the initializers (04cac2b)
• Show values in setDensity/setTemperature exceptions (ebc478f)
• Add Cython function to access species viscosity (cc93ce6, #527)
• Add get_equivalence_ratio function (a9ad75e, #521)
• Add newSubstance method to create pure fluid objects by name (62c67e4)
• Allow surface_reactions (not just edge_reactions) to be charge transfer reactions (51f419f, #439)

Transport¶

• Add unity Lewis number transport model (d38d9da, 29a3c19, 3c3ef10, d4492f3, a1c12b4, #510)
• Add ion gas transport model (b7e32e4, 3a0f46e, eeb27d8, f7852ad, fa9b937, 1245a69, 5c783c7, #539)

1-D Flames¶

• Add access to current solution resdiuals (6a52908)
• Allow user to pass the locations where temperature is set during flame initialization (2a38b0a, #447)
• Add ability to simulate ionized flames using the IonFlow class and the BurnerIonFlame and `(3b12c6d, e2f718c, 9dd0134, 6b6d758, 1057d20, 1be8374, a8cbfd2, 2472e08, a99004d, 24940ae, c3ba264, a5762ea, ac8612f, #441, #471, #546, #548)
• Add function to get the refine criteria used in a flame (bce4210, 4b44c66, c88ddce, #469)
• Add a more general CounterFlowDiffusionFlame to Matlab, replacing npflame_init (43bd96b, c092484, #450)
• Allow access to and disabling of callbacks for 1-D problems (4b35275, 7a314d3, #489)
• Automatically detect when the domain width is too narrow or the flame has blown off the burner (dfd4b7e, 7eb4eaa, 4911539, #489)
• Add BurnerIonFlame class (2527869, 5082a21, ee633f3, 1662498, #548)

CTI/Input files¶

• Allow negative reaction orders (8f02c77, 4771874, 501b5fd, #485)
• Add support for parsing species with specific site occupancies (89bca5f, #444)
• Improve error message reporting during failed ck2cti conversions (4b5a37a, 9c3b500, 4affcd1, 411be3e, #497)
• Allow convertMech function to be called multiple times (277aa0b, #528, #536)

Other¶

• Add methods for getting the git commit (8e89bbb, 7979a2b)
• Add class AnyMap (56022e8, 9c084d5, 7fab7f3, #443)
• Add compatiblity with Cython >=0.26 (8d953a9, #465, #467)
• Add compatibility with fmt 4.0.0 (ea69a01, #470)
• Building now supports SCons 3.0.0 and Python 3 runnning SCons (7d0bc71, 684262e, #477, #478, #481)
• Allow building and testing with msvc-12.0 (e921cb8, 6844e52, #479)
• Add setup_cantera.csh for use with csh/tcsh (4a4886f, #453)
• Add conda GCC compilers to the check for C compilers during building (07409de, #486)
• Many documentation updates related to Cantera joining NumFOCUS (e846505, e6b4761, af4a78d, ec5aecd, 419a09c, 581cfb7, 8caf5e5, 977a1c7, 0d20b50, c78a11b, 2abc57e, 05fa4df, 8195403, 1a394a3, c29fbc8, 66597b7, a0ac2b0, #502)
• Add support for SUNDIALS 3.0.0 and 3.1.0 (50a3fec, 9c50f75, 82c959d, 322b1fc, #503)
• Upgrade Eigen submodule to 3.3.4 (20f891f)
• Add links to old versions of the documentation (b26dc65)
• Upgrade fmtlib submodule to 5.0.0 (6b3c912, 99d4972, 3be3f7d, e42b952, 51d0d43, 309871a, dab7390, #540)

Examples/Samples¶

• Add C++ OpenMP example (78d5809)
• Add NonIdealShockTube example (2a601c1, e78aac7, 26216e9, #473, #483)
• Add example of PSR/WSR that replaces combustor.py (dc5ec06, #550)
• Add example of using a time-dependent mass flow into a reactor (2f67c99, #550)