-
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 documentation #193
Update documentation #193
Conversation
Ive documented the radial flow as follows: The modelling documentation for unit operation that supports radial flow now has a subsection with the corresponding equations. The radial flow interface is documented separately and only contains the changes that need to be made to get the radial flow variant of the corresponding model (changes are the same for all units). A brief documentation for the parametert dependencies was added under interface/parameter_dependencies. Note that this feature is still work in progress and only a few dependencies are available as of now |
I think we should use this PR to have a look at the documentation in general, including radial flow and DG. |
cde11da
to
7e1d335
Compare
@AntoniaBerger the section "spatial reconstruction methods" might be an interesting read for you and you can also give us some feedback while we're at it. |
|
||
Refinement strategy | ||
------------------- | ||
|
||
A common problem in numerical simulation is that the number of discrete points required to yield an accurate approximation within a specific tolerance is unknown. | ||
We thus recommend determining the approximation error via comparison with a refined reference approximation. | ||
Both the theoretical order of convergence and the EOC can be used to estimate the required number of discrete points. | ||
An EOC that is significantly lower than the theoretical order indicates that the problem is numerically underresolved. | ||
|
||
Note on DG solution vector |
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.
@eric asked to add a description to how thats done since this is not an option supported by cadet itself
In numerical simulation, smoothness indicators are often based on derivatives or moments of the solution. | ||
That is, strong gradients and high frequencies are used to identify non-smooth parts of the solution. | ||
That is, the occurrence of strong gradients and high frequencies are used to identify non-smooth parts of the solution. | ||
Godunov's order barrier theorem shows why the concept of smoothness plays a crucial role in the deployment of numerical methods. |
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.
@lieres asked for changes since the theorem is about linearity and order of the method. the problem with oscillations is subordinate and should be described separately.
5575676
to
79528a9
Compare
All contributors have signed the CLA ✍️ ✅ |
At least one of the following two applies:
|
I have read the CLA Document and I hereby sign the CLA. |
282b953
to
59d758f
Compare
8e56e16
to
383b822
Compare
* Add radial flow models documentation * Update DG documentation * Fix FV boundary model documentation * Fix surface diffusion salt dependence documentation * Update citing: Selected applications moved to website, only cite CADET-Core (extension) publications on github Co-authored-by: Eric von Lieres <e.von.lieres@fz-juelich.de>
383b822
to
1531555
Compare
Many PR's have been merged recently, with many people contributing to the respective documentation.
We should review and overhaul the new parts of the documentation with at least two people of our group together.
Todo
radial flow doc review: end of modelling section of GRM, LRM, LRMP and interface at interface/unit_operations/radial_flow_models.htmlmct doc review at modelling/unit_operations/multi_channel_transport_model.html and interface/unit_operations/multi_channel_transport_model.htmlMichaelis Menten kinetics at modelling/reaction/michaelis_menten_kinetics.html#michaelis-menten-kinetics-model and interface/reaction/michaelis_menten_kinetics.html