Update docs of tabular back-ends for mixture utilization#3239
Conversation
There was a problem hiding this comment.
I commited this trailing white-space removal on accident. Are these white-spaces intended? If yes I can readd again
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
Web/coolprop/Tabular.rst (1)
7-15: 🎯 Functional Correctness | 🟠 Major | ⚖️ Poor tradeoffClarify SVDSBTL's pure-fluid-only limitation in the backend overview.
The documentation at line 11 presents SVDSBTL as a third general tabular backend alongside BICUBIC and TTSE, but the upstream factory code (
src/AbstractState.cpp:252-267) enforces that "SVDSBTL backend is pure-fluid only; expected exactly one fluid name". This creates a misleading impression that SVDSBTL supports mixtures, which directly contradicts the new Mixtures section below and will confuse users trying to apply the mixture workflow to SVDSBTL.Add a qualifier at line 11 or in the seealso note that SVDSBTL is pure-fluid only and not applicable to mixtures. The Mixtures section should also explicitly note that SVDSBTL does not support mixtures.
📝 Proposed clarification
At line 11, revise to:
-There are three backends implemented for tabular interpolation, ``BICUBIC``, ``TTSE`` and ``SVDSBTL``. ``BICUBIC`` and ``TTSE`` consume the same gridded tabular data that is stored to your user home directory in the folder ``HOME/.CoolProp/Tables``. +There are three backends implemented for tabular interpolation, ``BICUBIC``, ``TTSE`` and ``SVDSBTL``. ``BICUBIC`` and ``TTSE`` support both pure fluids and mixtures and consume the same gridded tabular data that is stored to your user home directory in the folder ``HOME/.CoolProp/Tables``. ``SVDSBTL`` is pure-fluid only.And in the Mixtures section (around line 232), add:
Tabular backends work with multi-component mixtures. The workflow differs from pure fluids in two ways: + +.. note:: + SVDSBTL does not support mixtures; use ``BICUBIC`` or ``TTSE`` instead.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@Web/coolprop/Tabular.rst` around lines 7 - 15, Clarify the tabular backend overview in Tabular.rst by explicitly stating that SVDSBTL is pure-fluid only and cannot be used with mixtures, since the backend selection logic in AbstractState enforces a single fluid name; update the sentence listing BICUBIC, TTSE, and SVDSBTL to add this qualifier, and also add the same limitation to the Mixtures section so users do not assume SVDSBTL applies there.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@Web/coolprop/Tabular.rst`:
- Around line 7-15: Clarify the tabular backend overview in Tabular.rst by
explicitly stating that SVDSBTL is pure-fluid only and cannot be used with
mixtures, since the backend selection logic in AbstractState enforces a single
fluid name; update the sentence listing BICUBIC, TTSE, and SVDSBTL to add this
qualifier, and also add the same limitation to the Mixtures section so users do
not assume SVDSBTL applies there.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 13540f43-45eb-4574-bba3-ba1587bb16c1
📒 Files selected for processing (1)
Web/coolprop/Tabular.rst
1 participant
Resolve #3236
Summary by CodeRabbit
SVDSBTLbackend alongsideBICUBICandTTSE.