Skip to content

explicit RK docstrings #1866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 12, 2023
Merged

explicit RK docstrings #1866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b50390f
start docstring overhaul
ArnoStrouwen Feb 6, 2023
c74f508
continue docstring
ArnoStrouwen Jul 17, 2023
4a31605
finish explicit rk docstring keywords
ArnoStrouwen Aug 7, 2023
e80344c
format
ArnoStrouwen Aug 7, 2023
41246bb
@kwdef backwards compatibility
ArnoStrouwen Aug 7, 2023
3157b0f
fix RK46NL docstring
ArnoStrouwen Aug 7, 2023
0ab7a08
fix PFRK87 docstring
ArnoStrouwen Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ Manifest.toml
profile.pb.gz
.*.swp
LocalPreferences.toml

docs/build
1 change: 1 addition & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"

[compat]
Documenter = "0.27"
3 changes: 3 additions & 0 deletions src/OrdinaryDiffEq.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,10 @@ import Preferences
DEFAULT_PRECS(W, du, u, p, t, newW, Plprev, Prprev, solverdata) = nothing, nothing

include("misc_utils.jl")

include("algorithms.jl")
include("algorithms/explicit_rk.jl")

include("alg_utils.jl")

include("nlsolve/type.jl")
Expand Down
1 change: 1 addition & 0 deletions src/alg_utils.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,7 @@ Return the SSP coefficient of the ODE algorithm `alg`. If one time step of size
with step sizes `cᵢ * dt`, the SSP coefficient is the minimal value of `1/cᵢ`.

# Examples

```julia-repl
julia> ssp_coefficient(SSPRK104())
6
Expand Down
4,936 changes: 1,809 additions & 3,127 deletions src/algorithms.jl
View file
Open in desktop

Large diffs are not rendered by default.

Loading