add the docstring explaining dt_opt

trixi-framework · Oct 20, 2024 · 06e0415 · 06e0415
1 parent 5ee106a
commit 06e0415
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl b/src/time_integration/paired_explicit_runge_kutta/methods_PERK2.jl
@@ -117,7 +117,9 @@ 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` (`Float64`): Optimal time step size for the simulation setup.
+    - `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`.
     - `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