Fix CSTR interface documentation and ensure backwards compatibility #286
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
schmoelder
approved these changes
Sep 10, 2024
There was a problem hiding this comment.
LGTM. If I could chose, I would probably have used INIT_VOLUME_LIQUID/SOLID but that's not really a deal breaker and just personal preference.
Edit: @jbreue16 You mentioned that we're adding more tests for the CSTR to better catch this in the future, right?
Yes, theres issue #125 and the meta issue #254 where many open ends for our testing suite are tracked, including |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #235 we changed the field "INIT_VOLUME" to "INIT_LIQUID_VOLUME" but forgot to update the documentation.
Also, Ive added backwards compatibility even though volume in the new CSTR refers to liquid volume only, since this unit operation is often used with constant volume and without a solid phase.
We can delete the backwards compatibility for the new interface version, i.e. for cadet-core v.6.0.0