Improve Docs for new Users (#1911)

* Additional descriptions for new users * Update docs/src/overview.md Co-authored-by: Michael Schlottke-Lakemper <[email protected]> --------- Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
trixi-framework · Apr 23, 2024 · 34b1b1e · 34b1b1e
1 parent dd05156
commit 34b1b1e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/docs/src/meshes/structured_mesh.md b/docs/src/meshes/structured_mesh.md
@@ -2,6 +2,8 @@
 
 The [`StructuredMesh`](@ref) is a structured, curvilinear, conforming
 mesh type available for one-, two-, and three-dimensional simulations.
+An application of the [`StructuredMesh`](@ref) using a user-defined mapping 
+is provided by [one of the tutorials](https://trixi-framework.github.io/Trixi.jl/stable/tutorials/structured_mesh_mapping/).
 
 Due to its curvilinear nature, (numerical) fluxes need to implement methods
 dispatching on the `normal::AbstractVector`. Rotationally invariant equations

diff --git a/docs/src/meshes/tree_mesh.md b/docs/src/meshes/tree_mesh.md
@@ -5,7 +5,7 @@ used in many parts of Trixi.jl. Often, the support for this mesh type is
 developed best since it was the first mesh type in Trixi.jl,
 and it is available in one, two, and three space dimensions.
 
-It is limited to hypercube domains but supports AMR via the [`AMRCallback`](@ref).
+It is limited to hypercube domains (that is, lines in 1D, squares in 2D and cubes in 3D) but supports AMR via the [`AMRCallback`](@ref).
 Due to its Cartesian nature, (numerical) fluxes need to implement methods
 dispatching on the `orientation::Integer` as described in the
 [conventions](@ref conventions).
diff --git a/docs/src/overview.md b/docs/src/overview.md
@@ -64,6 +64,14 @@ different features on different mesh types.
 
 ᵃ: quad = quadrilateral, hex = hexahedron
 
+Note that except for [`TreeMesh`](@ref) all meshes are of *curvilinear* type, 
+which means that a (unit) vector normal to the interface (`normal_direction`) needs to be supplied to the 
+numerical flux function.
+You can check the [reference](https://trixi-framework.github.io/Trixi.jl/stable/reference-trixi/) if a certain 
+numerical flux is implemented with a `normal_direction` 
+or if currently only the *Cartesian* version (for [`TreeMesh`](@ref)) exists.
+In this case, you can still use this flux on curvilinear meshes by rotating it, see [`FluxRotated`](@ref).
+
 ## Time integration methods
 
 Trixi.jl is compatible with the [SciML ecosystem for ordinary differential equations](https://diffeq.sciml.ai/latest/).