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

Missing documentation of source_terms #1925

Open
knstmrd opened this issue Apr 30, 2024 · 2 comments
Open

Missing documentation of source_terms #1925

knstmrd opened this issue Apr 30, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@knstmrd
Copy link

knstmrd commented Apr 30, 2024

The source_terms parameter of the SemidiscretizationHyperbolic is not really documented anywhere outside of the full Trixi.jl API page (briefly mentioned on the Behind the scenes of a simulation setup page), so how to add source terms to a simulation can be seen only from various examples relying on the method of manufactured solutions.
I feel like some explicit example of how source terms work would be helpful (and would also show up in various related searches, e.g. googling for "trixi.jl" "source term" mostly points to the full API reference page).

@DanielDoehring
Copy link
Contributor

This could probably done in conjunction with a page dedicated to how we measure convergence (method of manufactured solutions)

@DanielDoehring DanielDoehring added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 30, 2024
@ranocha
Copy link
Member

ranocha commented Apr 30, 2024

For people finding this issue, you can have a look at https://trixi-framework.github.io/Trixi.jl/stable/tutorials/custom_semidiscretization/. But we should definitely document it better - maybe a new tutorial after (or before) "Adding a new scalar conservation law" and "Adding a non-conservative equation"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants