-
-
Notifications
You must be signed in to change notification settings - Fork 409
Description
The Cantera codebase contains a number of classes that are potentially unused. They are not used internally within Cantera, have no test coverage, and have no examples available, making them essentially useless to any potential users. These classes are identified below, with notes from relevant commits. The status of each of these classes should be individually resolved in one of two ways:
- Add examples and tests
- Deprecate and remove
The current state of affairs is not sustainable, making it difficult for users to understand the code and creating unnecessary barriers to effectively maintaining and improving Cantera. Specific details about these classes are described below, based on looking through the commit history. This list excludes classes which have already been deprecated in Cantera 2.2.
ThermoPhasederivatives:-
SemiconductorPhase: Added in 8ee5b76 (2007). Untouched since then. No tests, and unconstructible byThermoFactory. Deprecated in 111b490. Removed in 2.3. -
MixtureFugacityTP/RedlichKwongMFTP- Tests added by @decaluwe in f9d5f16. -
MineralEQ3Added in 3afa913 (2008) no test cases or examples deprecated in 6d22be2 -
IonsFromNeutralVPSSTP, Added in 06276fb (2009) Regression tests added in 338b216 and 3a11938 -
MetalSHEelectronsAdded in 321d387 (2009) no test cases or examples deprecated in 6d22be2 -
PhaseCombo_InteractionAdded in 30d59b8 (2011) no test cases or examples deprecated in 6d22be2 -
MixedSolventElectrolyteAdded in ff7e66e (2011) no test cases or examples. Not constructible byThermoFactory. Deprecated in 2b73fe2. -
MolarityIonicVPSSTPAdded in b9c9f81 (2011) no test cases or examples deprecated in 6d22be2 -
RedlichKisterVPSSTPAdded in 5d1e555 (2011) Test case added in 1183479
-
- Other thermo classes
-
PDSS_SSVolAdded in 4826170 (2009) regression test added in a520f78 -
PDSS_IonsFromNeutralAdded in 06276fb (2009) Regression tests added in 338b216 and 3a11938 -
VPSSMgr_IdealGasAdded in e46b6f2 (2008) eliminated by refactoring in b39537b -
Adsorbate: Added in c438d58 (2007). Essentially untouched and apparently unused since then. No examples or tests. deprecated in 6d22be2 -
tpx::leekesler: Added in 3213a28 (2004). Untouched since with no documentation, tests, or examples. No integration withPureFluidPhase. Deprecated in 668634c. Removed in 2.3. -
tpx::RedlichKwong: Added in 7770f79 (2004). Untouched since with no documentation, tests, or examples. See Unable to instantiate PureFluidPhase using RedlichKwong equation of state #263. Deprecated in 668634c. Removed in 2.3.
-
- Kinetics
- Transport
-
LiquidTransport- Initially added in 0127285 (2009), with some ongoing work. Pending tests/examples from @jchewson. deprecated in 6d22be2 -
HighPressureGasTransport- Added in 14019cf (2014). No tests yet. Could probably use some notation as to its current state. -
SolidTransport- Predates the existing project history (pre-2003). Various updates over the years. Pending tests/examples from @jchewson. deprecated in 6d22be2 -
SimpleTransport- Initially added in 2009, with a few updates and one nearly-trivial regression test. deprecated in 6d22be2
-
- Other classes
-
DAE_SolverandIDA_Solver- Added in d5211ff (2006). An unused wrapper for the Sundials IDA solver. Retained in anticipation of use in PFR with surface reactions.DAE_Solverbase class removed andIDA_Solver(renamedIdasIntegrator) now in use and tested with non-homogeneousFlowReactorin FlowReactor with heterogeneous chemistry #1490. -
ResidJacEval- Used only inIDA_Solver, which is itself unused. Retained in anticipation of use in PFR with surface reactions. Deprecated in 10a3913. Removed in 3.1. -
RootFind- Added in 1644b1c (2010). Used only inRedlichKwongMFTPin the methodsdensSpinodalLiquidanddensSpinodalGaswhich are currently untested. Deprecated in fb9a4b1 (usage inRedlichKwongMFTP migrated to use Boost root finder). Removed in 2.3. -
Tortuosityand descendants - added in e8d545f (2010). Pending tests/examples from @jchewson. deprecated in 6d22be2
-