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

Improve documentation #144

Open
4 tasks
JoshuaLampert opened this issue Aug 18, 2024 · 2 comments
Open
4 tasks

Improve documentation #144

JoshuaLampert opened this issue Aug 18, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JoshuaLampert
Copy link
Owner

JoshuaLampert commented Aug 18, 2024

Up to now we only have one overview page in the documentation, which tries to cover everything in the package. I think it would be nice to split this up in several parts focusing on different aspects (e.g. pages about more theoretical aspects and more tutorial-like pages). Ideas for tutorials:

  • Basic introductory example (also explain about SBP operators)
  • Compare different equations applied to the Dingemans setup
  • Compare different SBP solvers: Especially upwind vs central (upwind leads to higher resolution), but also FD vs. DG vs. CG vs. Fourier: Maybe make this two separate tutorials?
  • Explain influence of using relaxation (exact preservation of nonlinear invariant, quadratic vs. linear error growth)

In addition, it would be nice to have a page explaining the implementation strategy and the interplay between different building blocks (mesh, equations, solver, semidiscretization, ODE solver, callbacks), maybe similar to the diagram in https://trixi-framework.github.io/Trixi.jl/stable/overview/#overview-semidiscretizations.

@JoshuaLampert JoshuaLampert added the documentation Improvements or additions to documentation label Aug 18, 2024
@JoshuaLampert
Copy link
Owner Author

If you have any other ideas, feel free to add or change the above comment.

@ranocha
Copy link
Collaborator

ranocha commented Aug 19, 2024

Sounds nice! We should also point out the general interface idea (abstract SWEs etc.).

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
Projects
None yet
Development

No branches or pull requests

2 participants