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.

Sign up for GitHub

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

Jump to bottom

Improve Docs for new Users #1911

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Improve Docs for new Users #1911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03a1a83
Additional descriptions for new users
DanielDoehring Apr 23, 2024
4e7ad40
Merge branch 'main' into ImproveDocs
DanielDoehring Apr 23, 2024
f922b97
Update docs/src/overview.md
DanielDoehring Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/src/meshes/structured_mesh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/meshes/tree_mesh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
8 changes: 8 additions & 0 deletions docs/src/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
Loading