-
Notifications
You must be signed in to change notification settings - Fork 26
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
Update MCT Documentation #230
Conversation
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA. |
Mind that Fix spelling Mistake within Radial Flow Model (found by accident) was not the objective of this PR and maybe should be handled separately when merging. |
|
I have read the CLA Document and I hereby sign the CLA. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also provide links between modeling/interface like with the other models.
Ive added the general MCT equations to the documentation. |
So I had a look again at the Radial Flow Documentation that is currently up live on https://cadet.github.io/master/interface/unit_operations/radial_flow_models.html and spotted a few more Issues. I will correct them in this PR but it should probably be squashed separately during the merge. |
Theres actually another PR #193 in which we wanted to go through and fix the documentation, including radial flow.. glad you found and fixed those but no need to delve deeper into this here. I agree on making two separate master commits from this PR |
Ah sorry, I searched for a PR with the Radial Flow Doc and couldn't find one. Fixed the issues I mentioned an will just leave it at is now. |
Okay, with that last commit from my side this is ready to merge. Thanks a lot for contributing the equations! |
* Fix typos * Correct Links to Model Equations in Radial Flow Model Interface
* Adjust MCT interface doc * Add general MCT equations to modelling section * Add Link to Modelling from MCT Interface * Move tracer transport to own use-case subsection ------- Co-authored-by: Jan Breuer <[email protected]>
f8480b1
to
048459a
Compare
Should we explicitly mention the results of the forum discussion in the MCT documentation, i.e. that the exchange rates are used to calculate the exchange flow wrt the volume of the outflow/source channel? |
I think that's a good idea to highlight and deepen the understanding of the differences between the models. |
@schmoelder this PR is good to be merged from our side |
doc/interface/unit_operations/multi_channel_transport_model.rst
Outdated
Show resolved
Hide resolved
* Adjust MCT interface doc * Add general MCT equations to modelling section * Add Link to Modelling from MCT Interface * Move tracer transport to own use-case subsection ------- Co-authored-by: Jan Breuer <[email protected]>
9b9b50d
to
e48aaf9
Compare
* Adjust MCT interface doc * Add general MCT equations to modelling section * Add Link to Modelling from MCT Interface * Move tracer transport to own use-case subsection ------- Co-authored-by: Jan Breuer <[email protected]>
Fixes Issue #223
Throughout this PR we've also found and fixed some issues with the radial flow documentation, and updated the MCT interface so that
NCHANNEL
is not a discretization but model parameter. These changes will be put in separate commits.