Smart clib cabinets / add Solution to clib API

[ischoegl]

Changes proposed in this pull request

This PR required keeping track of shared pointers to core Cantera objects (ThermoPhase, Kinetics and Transport) after their construction. Several factory constructors and internal methods that previously used raw pointers or references are replaced by methods that use shared pointers, with the original methods being deprecated.

Modifications allowed for consistent tracking of objects behind the clib API, where a new SharedCabinet based on smart pointers is introduced. The new object is adopted for ThermoCabinet, KineticsCabinet and TransportCabinet.

Other details:

• Fix bugs in test_problems/clib_test/clib_test.c
• Implement SolutionCabinet based on SharedCabinet
• Implement clib tests based on googletests (run via scons test-clib-gtest), which now includes tests for ctonedim

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

Fixes #1447
Resolves Cantera/enhancements#158

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

Solution types can now be loaded directly, i.e.

int soln_newSolution(const char* infile, const char* name, const char* transport);
int soln_newInterface(const char* infile, const char* name, int na, const int* adjacent);

where parts are obtained as:

int soln_thermo(int n);
int soln_kinetics(int n);
int soln_transport(int n);

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

[codecov]

Codecov Report

Merging #1448 (90b19b4) into main (c54e429) will increase coverage by 0.08%.
The diff coverage is 66.91%.

@@            Coverage Diff             @@
##             main    #1448      +/-   ##
==========================================
+ Coverage   70.94%   71.02%   +0.08%     
==========================================
  Files         369      369              
  Lines       55259    55558     +299     
  Branches    18207    18378     +171     
==========================================
+ Hits        39201    39462     +261     
- Misses      13593    13607      +14     
- Partials     2465     2489      +24     

Impacted Files	Coverage Δ
include/cantera/base/Interface.h	100.00% <ø> (ø)
include/cantera/base/Solution.h	93.33% <ø> (ø)
include/cantera/kinetics/GasKinetics.h	100.00% <ø> (ø)
include/cantera/kinetics/InterfaceKinetics.h	85.71% <ø> (ø)
include/cantera/kinetics/Kinetics.h	31.85% <ø> (ø)
include/cantera/oneD/Boundary1D.h	61.76% <ø> (ø)
include/cantera/oneD/StFlow.h	100.00% <ø> (ø)
include/cantera/thermo/ThermoPhase.h	44.58% <ø> (ø)
src/clib/clib_utils.h	21.42% <ø> (ø)
src/clib/ctfunc.cpp	0.00% <ø> (ø)
... and 53 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[speth]

Thanks for the updates, @ischoegl. Besides the minor suggestions below, I think the one thing that still needs a little bit of work is the error handling for soln_kinetics, soln_transport, and soln_adjacent. I commented on that here: #1448 (comment), but GitHub is probably trying to hide that from you.

[ischoegl]

@speth ... thanks for the re-review! You probably noticed that I updated the reverse lookup table to prevent memory leaks (see c5bf0db). Otherwise, I believe the clib exception handling should now be addressed. I am stuck on the m_solution->registerChangedCallback crash (see #1448 (comment)), as I'm not sure why this is causing issues.

[speth]

Thanks @ischoegl, this looks good to me. The last commit I pushed took care of the callback-related errors, so I'll leave the final merge to you.

[ischoegl]

Thank you, @speth!