Skip to content

Commit

Permalink
fix typo and hyperlinks in docs (trixi-framework#1401)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaLampert authored Apr 18, 2023
1 parent c2aef2d commit cc2cda4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions docs/src/time_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ are the following. Further documentation can be found in the
`CarpenterKennedy2N54(thread=OrdinaryDiffEq.True(), williamson_condition=false)`.
For more information on using thread-based parallelism in Trixi.jl, please refer to
[Shared-memory parallelization with threads](@ref).
- If you use error-based step size control (see also see also the section on
[error-based adaptive step sizes](https://trixi-framework.github.io/Trixi.jl/stable/tutorials/time_stepping/#Error-based-adaptive-step-sizes))
together with MPI, you need to pass `internalnorm=ode_norm` and you should pass
`unstable_check=ode_unstable_check` to OrdinaryDiffEq's [`solve`](https://docs.sciml.ai/DiffEqDocs/latest/basics/common_solver_opts/),
which are both included in [`ode_default_options`](@ref).
- If you use error-based step size control (see also the section on
[error-based adaptive step sizes](@ref adaptive_step_sizes) together with MPI, you need to
pass `internalnorm=ode_norm` and you should pass `unstable_check=ode_unstable_check` to
OrdinaryDiffEq's [`solve`](https://docs.sciml.ai/DiffEqDocs/latest/basics/common_solver_opts/), which are both
included in [`ode_default_options`](@ref).

!!! note "Number of `rhs!` calls"
If you use explicit Runge-Kutta methods from [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl),
Expand Down
4 changes: 2 additions & 2 deletions src/auxiliary/mpi.jl
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You must pass this function as a keyword argument
to OrdinaryDiffEq.jl's `solve` when using error-based step size control with MPI
parallel execution of Trixi.jl.
See [`https://diffeq.sciml.ai/stable/basics/common_solver_opts/#advanced_adaptive_stepsize_control`](https://diffeq.sciml.ai/stable/basics/common_solver_opts/#advanced_adaptive_stepsize_control)
See the "Advanced Adaptive Stepsize Control" section of the [documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
"""
ode_norm(u::Number, t) = @fastmath abs(u)
function ode_norm(u::AbstractArray, t)
Expand Down Expand Up @@ -137,6 +137,6 @@ You should pass this function as a keyword argument
to OrdinaryDiffEq.jl's `solve` when using error-based step size control with MPI
parallel execution of Trixi.jl.
See [`https://diffeq.sciml.ai/stable/basics/common_solver_opts/#Miscellaneous`](https://diffeq.sciml.ai/stable/basics/common_solver_opts/#Miscellaneous)
See the "Miscellaneous" section of the [documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
"""
ode_unstable_check(dt, u, semi, t) = isnan(dt)
2 changes: 1 addition & 1 deletion src/auxiliary/special_elixirs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ providing examples with sensible default values for users.
Before replacing assignments in `elixir`, the keyword argument `maxiters` is inserted
into calls to `solve` and `Trixi.solve` with it's default value used in the SciML ecosystem
for ODEs, see https://diffeq.sciml.ai/stable/basics/common_solver_opts/#Miscellaneous.
for ODEs, see the "Miscellaneous" section of the [documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
# Examples
Expand Down

0 comments on commit cc2cda4

Please sign in to comment.