trixi-framework / Trixi.jl

Trixi.jl: Adaptive high-order numerical simulations of conservation laws in Julia
https://trixi-framework.github.io/Trixi.jl
MIT License
505 stars 98 forks source link

Improve Docs for new Users #1911

Closed DanielDoehring closed 2 months ago

DanielDoehring commented 2 months ago

This aims to tackle some of the feedback from #1907.

In particular, I seek to address

  1. This overview however does not mention which type of fluxes (i.e. dispatching on normals or integer directions) are needed for which grid

  2. Similarly, links [...] for the Structured Mesh to the "Structured mesh with curvilinear mapping" would also be helpful

  3. Finally, I haven't seen it explicitly mentioned that TreeMesh makes the domain square?

github-actions[bot] commented 2 months ago

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

Code quality

Documentation

Testing

Performance

Verification

Created with :heart: by the Trixi.jl community.

knstmrd commented 2 months ago

Looks good to me! Thanks!