Skip to content
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

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Conversation

schmoelder
Copy link
Contributor

@schmoelder schmoelder commented May 6, 2024

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

  • DG doc review
  • github and website citing section (HL for example was confused on how to cite cadet. (JB: 1) emphasize one single paper 2) get rid of selected applications section, since this a) is about citing cadet and the models/methods implemented and b) will get out of hand quickly. Maybe move it somewhere else like a highlighted use-case section on the website 3) instead add a modelling section with e.g. crystallization, mct paper?)
  • Fix surface diffusion salt state dependency documentation
  • Fix boundary model documentation for FV (only 1 and 2 are allowed but 0,1,2,3 are documented)
  • The following open reviews were moved to a new issue Review documentation #298 :
  • radial flow doc review: end of modelling section of GRM, LRM, LRMP and interface at interface/unit_operations/radial_flow_models.html
  • mct doc review at modelling/unit_operations/multi_channel_transport_model.html and interface/unit_operations/multi_channel_transport_model.html
  • Michaelis Menten kinetics at modelling/reaction/michaelis_menten_kinetics.html#michaelis-menten-kinetics-model and interface/reaction/michaelis_menten_kinetics.html

@jbreue16
Copy link
Contributor

jbreue16 commented May 6, 2024

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.
Ive decided to use $\rho$ as the radial coordinate of the column since we are already using $r$ for the particle coordinates.
Thats also why I chose $P_c$ and $P$ for the inner and outer column radius, i.e. capital rho.

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).
The doc can be found under interface/unit_operations/radial_flow_models.html . I just thought its a little too hidden and we should probably add a reference to that page in the documentation of the unit operation interfaces.

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

@jbreue16 jbreue16 changed the title Update radial flow documentation Update documentation May 21, 2024
@jbreue16
Copy link
Contributor

jbreue16 commented May 23, 2024

I think we should use this PR to have a look at the documentation in general, including radial flow and DG.
We should also consider the developer guide (issue #166, PR #181)
and maybe fix #194, but the latter could also be addressed later when a general CADET landing page is created and CADET-Core gets a separate page and documentation

@jbreue16 jbreue16 added this to the v5.0.0 "CADET-Core" milestone Jun 2, 2024
@jbreue16 jbreue16 force-pushed the fix/update_radial_flow_documentation branch from cde11da to 7e1d335 Compare June 18, 2024 11:21
@jbreue16
Copy link
Contributor

jbreue16 commented Jun 18, 2024

doxygen build is addressed in PR #89 and will also help guide developers.

Geometry sensitivities not supported by DG units: double check documentation and add the comment that these can also be computed with FD, or forward using cadet-fv units, as mentioned in #214

@jbreue16
Copy link
Contributor

@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
Copy link
Contributor

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.
Copy link
Contributor

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.

@jbreue16 jbreue16 force-pushed the fix/update_radial_flow_documentation branch from 5575676 to 79528a9 Compare August 20, 2024 10:53
Copy link

github-actions bot commented Aug 20, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@lieres
Copy link
Member

lieres commented Aug 20, 2024

  • The CADET maintainers know my real name.

At least one of the following two applies:

  • The CADET maintainers know my current employer.

  • I am not making this contribution on behalf of my current employer.

@lieres
Copy link
Member

lieres commented Aug 20, 2024

I have read the CLA Document and I hereby sign the CLA.

@jbreue16 jbreue16 force-pushed the fix/update_radial_flow_documentation branch from 282b953 to 59d758f Compare August 21, 2024 20:06
@jbreue16 jbreue16 force-pushed the fix/update_radial_flow_documentation branch from 8e56e16 to 383b822 Compare October 23, 2024 12:53
* 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>
@jbreue16 jbreue16 force-pushed the fix/update_radial_flow_documentation branch from 383b822 to 1531555 Compare October 23, 2024 13:57
@jbreue16 jbreue16 merged commit b2c66b4 into master Oct 23, 2024
4 checks passed
@jbreue16 jbreue16 deleted the fix/update_radial_flow_documentation branch October 23, 2024 14:07
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants