Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
efaulhaber committed Feb 6, 2024
1 parent dc6c48b commit b050939
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/src/callbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ will yield the following plot:
* The [`VisualizationCallback`](@ref) can be used for in-situ visualization. See
[Visualizing results during a simulation](@ref).
* The [`TrivialCallback`](@ref) does nothing and can be used to easily disable some callbacks
via [`trixi_include`](@ref).
via [`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}).

### Equation-specific callbacks
Some callbacks provided by Trixi.jl implement specific features for certain equations:
Expand Down
10 changes: 6 additions & 4 deletions docs/src/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,12 @@ Trixi.jl is distributed with several examples in the form of elixirs, small
Julia scripts containing everything to set up and run a simulation. Working
interactively from the Julia REPL with these scripts can be quite convenient
while for exploratory research and development of Trixi.jl. For example, you
can use the convenience function [`trixi_include`](@ref) to `include` an elixir
with some modified arguments. To enable this, it is helpful to use a consistent
naming scheme in elixirs, since [`trixi_include`](@ref) can only perform simple
replacements. Some standard variables names are
can use the convenience function
[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString})
to `include` an elixir with some modified arguments. To enable this, it is
helpful to use a consistent naming scheme in elixirs, since
[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString})
can only perform simple replacements. Some standard variables names are

- `polydeg` for the polynomial degree of a solver
- `surface_flux` for the numerical flux at surfaces
Expand Down
2 changes: 1 addition & 1 deletion src/auxiliary/special_elixirs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Run `iterations` Trixi.jl simulations using the setup given in `elixir` and comp
the experimental order of convergence (EOC) in the ``L^2`` and ``L^\\infty`` norm.
In each iteration, the resolution of the respective mesh will be doubled.
Additional keyword arguments `kwargs...` and the optional module `mod` are passed directly
to [`trixi_include`](@ref).
to [`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}).
This function assumes that the spatial resolution is set via the keywords
`initial_refinement_level` (an integer) or `cells_per_dimension` (a tuple of
Expand Down
4 changes: 2 additions & 2 deletions src/callbacks_step/trivial.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"""
TrivialCallback()
A callback that does nothing. This can be useful to disable some callbacks
easily via [`trixi_include`](@ref).
A callback that does nothing. This can be useful to disable some callbacks easily via
[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}).
"""
function TrivialCallback()
DiscreteCallback(trivial_callback, trivial_callback,
Expand Down

0 comments on commit b050939

Please sign in to comment.