Ray Speth
075d33b337
[Doc] Fix notation for natural log
...
Always write \log_{10} in the rare instances where that's what's
actually meant.
2023-08-07 17:56:56 -05:00
Ray Speth
cdaac33dea
[Doc] Fix obsolete references to SimpleThermo
2023-08-07 17:56:56 -05:00
Ray Speth
d95d28fb08
[Doc] Remove admonition about testing from MixtureFugacityTP
...
The classes derived from this (RedlichKwongMFTP and PengRobinson)
have adequate tests.
2023-08-07 17:56:56 -05:00
Ray Speth
373b3e0fb9
[Doc] Revise ThermoPhase documentation
...
Extract content from "thermoprops.dox" to populate the docstring for
the ThermoPhase class and the "thermoprops" group.
Fix numerous areas where this documentation was outdated or incorrect.
2023-08-07 17:56:56 -05:00
Ray Speth
7f5112239a
[Doc] Remove broken link to non-existent Electrochemical reaction type
2023-08-07 17:56:56 -05:00
Ray Speth
7bb1f09921
[Doc] Use Doxylink to link to C++ classes
...
No need to link directly to the "details" section since that now
appears close to the top of the page.
2023-08-07 17:56:56 -05:00
Ray Speth
1c0f5e458f
[Doc] Note version added for recent ThermoPhase models
2023-08-07 17:56:56 -05:00
Ray Speth
63f9bb04b3
[Doc] Fix alphabetization of phase models
2023-08-07 17:56:56 -05:00
Ray Speth
0b60e87918
Remove obsolete Doxygen options
...
These options generate warnings with Doxygen 1.9.6
2023-08-07 17:56:56 -05:00
Ray Speth
0a0087fc39
[CI] Build docs with Sphinx 5.1.1
...
Sphinx 3.x isn't compatible with our Nikola plugins, and the old
extension compatibility issues with 4.x no longer hold.
Sphinx 5.1.1 seems to be the most recent version that doesn't have
formatting issues for us.
Resolves Cantera/enhancements#175
2023-08-07 17:56:56 -05:00
Ingmar Schoegl
a900edfc48
Use C++17 attribute for deprecated types
2023-08-06 11:22:39 -05:00
Ingmar Schoegl
8ab42145a4
[CI] Skip pint on some runners
2023-08-06 11:18:02 -05:00
Ingmar Schoegl
a22fe7dc32
[unittest] Handle case where pint is not installed
2023-08-06 11:18:02 -05:00
Ingmar Schoegl
38b76a0476
Replace \log by \ln
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
d951bd5ee6
[docs] Fix new Doxygen warnings
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
ad251db8b5
[docs] Fix ConstCpPoly docstring
...
Use same syntax as on Cantera science section
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
bf98c1826a
[docs] Fix LaTeX log/ln/exp
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
5b6cf5fb84
Remove % in group definition string
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
855f239bb9
[docs] Add Doxygen eqnarray
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
070c226fba
[docs] Replace remaining Doxygen commands
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
d92d977ca9
[docs] Sort BibTeX entries alphabetically
2023-08-06 09:31:37 -05:00
Ray Speth
e2993793e2
[CI] Check for whitespace errors
2023-08-06 10:22:41 -04:00
Ray Speth
a23f2da352
[CI] Always run all linter steps
2023-08-06 10:22:41 -04:00
Ray Speth
2a0e4e95f3
[CI] Move lint checks to a separate workflow
2023-08-06 10:22:41 -04:00
Ray Speth
c86220ecfe
[CI] Add linter check for misleading Doxygen blocks
2023-08-06 10:22:41 -04:00
Ray Speth
3332319f85
[CI] Relax timeouts on for Intel compiler setup
2023-08-05 16:26:32 -04:00
Ray Speth
53396d4414
Clean up line wrapping and indentation
2023-08-05 16:26:32 -04:00
Ray Speth
c50b8b4faf
Fix Matlab toolbox compilation
...
This code isn't part of namespace Cantera, so can't use the
typedefs that are specified in that namespace.
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
25f6834da9
Improve formatting
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
64ade35c22
Using std::string
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
0df90be93e
Using std::map
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
ddd803c630
Using std::function
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
8f320c217c
Using std::pair
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
3dae4d458b
Using std::unique_ptr
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
e482e13ca2
Using std::shared_ptr
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
1b81689d40
Using std::vector
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
c09611b165
Using std::make_shared
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
86b2a139c7
Replace doublereal
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
845a551277
Replace vector_fp
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
9adc594593
Replace vector_int
2023-08-05 16:26:32 -04:00
Ray Speth
e0a2f112f7
[Reactor] Fix getting sensitivities after calls to advance
...
Previously, values would be returned for the sensitivity at the
last internal timestep of the integrator, rather than being interpolated
to the user-specified integration time.
2023-08-04 14:47:58 -05:00
Ray Speth
222b0ebcf6
Mark Reactor/ReactorNet methods as const
2023-08-04 14:47:58 -05:00
Ray Speth
e6c7030735
[Reactor] Improve CVODES error handling
...
Include the name of the return code flag, not just its numeric value,
and the CVODES-generated error message for all errors.
2023-08-04 14:47:58 -05:00
Ray Speth
3ec4577a86
[Reactor] Improve error message when advancing to past time
...
Resolves #1195
2023-08-04 14:47:58 -05:00
Ray Speth
0b80608642
[CI] Test Sundials 6.6
2023-08-04 14:47:58 -05:00
Ray Speth
ce797baffb
[Reactor] Always use "one step" mode with SUNDIALS integrators
...
Do the interpolation required for "advance" explicitly, rather
than relying on SUNDIALS to do it as part of the call to CVode() or
IDASolve().
This circumvents a change in behavior introduced in SUNDIALS 6.6.
Fixes #1554 .
2023-08-04 14:47:58 -05:00
Ingmar Schoegl
c9a6f818a1
Add instructions for std:: scope resolution
2023-08-04 15:47:40 -04:00
Ingmar Schoegl
fe67a191da
Update Doxygen style instructions
...
Additional guidance for Doxygen comments should help improve the
quality of generated documentation.
2023-08-04 15:47:40 -04:00
Ingmar Schoegl
5c0490b7b9
[docs] Create anchor for member section
...
See https://github.com/doxygen/doxygen/issues/8320#issuecomment-1230584554
2023-08-04 14:01:48 -04:00
Ingmar Schoegl
9c2441bcfe
[docs] Improve documentation of Kinetics derivatives
2023-08-04 14:01:48 -04:00
