Complete Unit Test Suite for the Matlab Toolbox

[ssun30]

Changes proposed in this pull request

• Added Kinetics class tests for all methods and properties currently implemented

If applicable, fill in the issue number this pull request is fixing

Updates to Cantera/enhancements#177

If applicable, provide an example illustrating new features this pull request is introducing

Added tests for rates of progress, rate constants, species rates, and thermodynamic values.

Checklist

• The pull request includes a clear description of this code change
• Commit messages have short titles and reference relevant issues
• Build passes (scons build & scons test) and unit tests address code coverage
• Style & formatting of contributed code follows contributing guidelines
• The pull request is ready for review

[ischoegl]

@ssun30 and @rwest ... what are the current plans on this PR and Cantera/enhancements#177? With the old MATLAB toolbox removed, the next Cantera version will only provide for the experimental toolbox.

[ssun30]

@ssun30 and @rwest ... what are the current plans on this PR and Cantera/enhancements#177? With the old MATLAB toolbox removed, the next Cantera version will only provide for the experimental toolbox.

Hi Ingmar, finishing the test suite is back on our to-do list and we were aiming to complete it by the end of the month. There is a slight delay so maybe the first week of July we shall have all the unit tests ready.

[ssun30]

After a year of hiatus this PR is finally ready for review. Thanks to support from Mathworks the plan to make the Matlab toolbox official is back on track.

[ssun30]

Checklist for all unit tests (that can be implemented in MATLAB)

• ThermoPhase
• Pure Fluid Phases
• Kinetics
• Transport
• Functors
• Equilibrium
• Mixture
• Reactors and Reactor Networks
• 1D domains

[ssun30]

@ischoegl @speth It seems that I don't have write access to the repo and thus could not request reviews for this PR. Could you check whether that's true and grant me access?

[ischoegl]

Hi @ssun30 ... thanks for getting back to this! From my side, this looks mostly good to go (despite a minor nit that some newlines at file endings are missing). I did notice that the MATLAB CI run wasn't completed successfully, though.

Overall, it's great to have some of this covered, especially as the plan is to move towards replacing the current CLib with an autogenerated CLib (see Cantera/enhancements#220). Once this is in place, it will be relatively easy to expose parts that are currently missing from the MATLAB API (e.g. Reaction, Species, ReactionRate, SolutionArray, etc.). One thing that may also be necessary is a MATLAB equivalent to AnyMap to access the serialization interface - I believe that there's a new dictionary that was introduced in R2022b.