From ef6d22df2325a586461d5c2c738dae804560e207 Mon Sep 17 00:00:00 2001 From: Warisa Date: Sun, 20 Oct 2024 23:19:07 +0200 Subject: [PATCH] update the docstring here to match the ones in PERK3 --- .../paired_explicit_runge_kutta/methods_PERK2.jl | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl b/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl index 185f550eed..6596c34a68 100644 --- a/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl +++ b/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl @@ -117,9 +117,8 @@ end - `base_path_monomial_coeffs` (`AbstractString`): Path to a file containing monomial coefficients of the stability polynomial of PERK method. The coefficients should be stored in a text file at `joinpath(base_path_monomial_coeffs, "gamma_$(num_stages).txt")` and separated by line breaks. - - `dt_opt` (`Union{Nothing, Float64}`): Optimal time step size for the simulation setup. - This can either be `nothing` or a float provided by the user. If it is a number, the user can use the function `calculate_cfl_number` and use the output of the function - in `StepsizeCallback`. + - `dt_opt` (`Float64`, optional): Optimal time step size for the simulation setup. Can be `nothing` if it is unknown. + In this case the optimal CFL number cannot be computed and the [`StepsizeCallback`](@ref) cannot be used. - `tspan`: Time span of the simulation. - `semi` (`AbstractSemidiscretization`): Semidiscretization setup. - `eig_vals` (`Vector{ComplexF64}`): Eigenvalues of the Jacobian of the right-hand side (rhs) of the ODEProblem after the