Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate clib 'xyz_newFromFile' from CLib #199

Closed
ischoegl opened this issue Mar 31, 2024 · 1 comment · Fixed by Cantera/cantera#1773
Closed

Deprecate clib 'xyz_newFromFile' from CLib #199

ischoegl opened this issue Mar 31, 2024 · 1 comment · Fixed by Cantera/cantera#1773
Labels
feature-request New feature request

Comments

@ischoegl
Copy link
Member

ischoegl commented Mar 31, 2024

Abstract

Historically, ThermoPhase and Kinetics objects were instantiated in the clib API via thermo_newFromFile and kin_newFromFile. Cantera/cantera#1448 introduced access for Solution objects to clib, which can now be instantiated via soln_newSolution (and soln_newInterface).

The historic instantiation route was important for the (now removed) legacy MATLAB toolbox, but is also still actively used in the Fortran and .NET interfaces. The main advantage of the new clib API functions is that they (i) allow for handling that is consistent with other parts of Cantera, and (ii) take care of all configuration steps.

Motivation

Describe the need for the proposed change:

  • What problem is it trying to solve? ... make handling of Solution consistent across all interfaces
  • Who is affected by the change? ... users of clib and derived APIs (e.g .NET)
  • Why is this a good solution? ... removes legacy code

Edit: Fortran is not affected by CLib, as it reimplements the _newFromFile routines separately.

Possible Solutions

Remove all instances of thermo_newFromFile and kin_newFromFile, and replace them by single call to soln_newSolution. Inclusion of surface kinetics in .NET requires resolution of Cantera/cantera#1450.

References

@ischoegl ischoegl added the feature-request New feature request label Mar 31, 2024
@ischoegl ischoegl changed the title Deprecate clib 'xyz_newFromFile' Deprecate clib 'xyz_newFromFile' from CLib Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant