docs SSPRK

SciML · Aug 11, 2024 · 0e6c11f · 0e6c11f
1 parent e645e44
commit 0e6c11f
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 4 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -37,7 +37,8 @@ makedocs(sitename = "OrdinaryDiffEq.jl",
             "explicit/HighOrderRK.md",
             "explicit/Verner.md",
             "explicit/Feagin.md",
-            "explicit/LowStorageRK.md"
+            "explicit/LowStorageRK.md",
+            "explicit/SSPRK.md"
         ],
         "Standard Non-Stiff ODEProblem Solvers" => [
             "nonstiff/explicitrk.md",

diff --git a/docs/src/explicit/SSPRK.md b/docs/src/explicit/SSPRK.md
@@ -0,0 +1,32 @@
+# OrdinaryDiffEqSSPRK
+
+Solvers specialized on certain PDE types.
+
+```@eval
+first_steps = evalfile("./common_first_steps.jl")
+first_steps("OrdinaryDiffEqSSPRK", "SSPRK22")
+```
+
+## Full list of solvers
+
+```@docs
+SSPRK22
+SSPRK33
+SSPRK53
+KYKSSPRK42
+SSPRK53_2N1
+SSPRK53_2N2
+SSPRK53_H
+SSPRK63
+SSPRK73
+SSPRK83
+SSPRK43
+SSPRK432
+SSPRKMSVS43
+SSPRKMSVS32
+SSPRK932
+SSPRK54
+SSPRK104
+SHLDDRK_2N
+SHLDDRK52
+```
diff --git a/lib/OrdinaryDiffEqSSPRK/src/algorithms.jl b/lib/OrdinaryDiffEqSSPRK/src/algorithms.jl
@@ -320,7 +320,7 @@ function SSPRK33(stage_limiter!, step_limiter! = trivial_limiter!)
         step_limiter!, False())
 end
 
-@doc explicit_rk_docstring("TBD", "SHLDDRK_2N")
+@doc explicit_rk_docstring("To be done", "SHLDDRK_2N")
 Base.@kwdef struct SHLDDRK_2N{StageLimiter, StepLimiter, Thread} <: OrdinaryDiffEqAlgorithm
     stage_limiter!::StageLimiter = trivial_limiter!
     step_limiter!::StepLimiter = trivial_limiter!
@@ -333,7 +333,7 @@ function SHLDDRK_2N(stage_limiter!, step_limiter! = trivial_limiter!)
         False())
 end
 
-@doc explicit_rk_docstring("TBD",
+@doc explicit_rk_docstring("To be done",
     "KYKSSPRK42")
 Base.@kwdef struct KYKSSPRK42{StageLimiter, StepLimiter, Thread} <: OrdinaryDiffEqAlgorithm
     stage_limiter!::StageLimiter = trivial_limiter!
@@ -347,7 +347,7 @@ function KYKSSPRK42(stage_limiter!, step_limiter! = trivial_limiter!)
         False())
 end
 
-@doc explicit_rk_docstring("TBD", "SHLDDRK52")
+@doc explicit_rk_docstring("To be done", "SHLDDRK52")
 Base.@kwdef struct SHLDDRK52{StageLimiter, StepLimiter, Thread} <: OrdinaryDiffEqAlgorithm
     stage_limiter!::StageLimiter = trivial_limiter!
     step_limiter!::StepLimiter = trivial_limiter!