From b050939ca8bcba1773420a4bb7f6f5e67145373e Mon Sep 17 00:00:00 2001 From: Erik Faulhaber <44124897+efaulhaber@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:29:10 +0100 Subject: [PATCH] Fix docs --- docs/src/callbacks.md | 2 +- docs/src/conventions.md | 10 ++++++---- src/auxiliary/special_elixirs.jl | 2 +- src/callbacks_step/trivial.jl | 4 ++-- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/src/callbacks.md b/docs/src/callbacks.md index f018bcf7c39..21e934b6278 100644 --- a/docs/src/callbacks.md +++ b/docs/src/callbacks.md @@ -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: diff --git a/docs/src/conventions.md b/docs/src/conventions.md index dab1b8533a5..e1a41502a35 100644 --- a/docs/src/conventions.md +++ b/docs/src/conventions.md @@ -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 diff --git a/src/auxiliary/special_elixirs.jl b/src/auxiliary/special_elixirs.jl index d0bdb26899a..355f5dfce0a 100644 --- a/src/auxiliary/special_elixirs.jl +++ b/src/auxiliary/special_elixirs.jl @@ -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 diff --git a/src/callbacks_step/trivial.jl b/src/callbacks_step/trivial.jl index a55b7d85b13..ab1f2ee6481 100644 --- a/src/callbacks_step/trivial.jl +++ b/src/callbacks_step/trivial.jl @@ -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,