docs Linear

SciML · Aug 21, 2024 · 255379f · 255379f
1 parent 17f6a49
commit 255379f
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 26 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -31,7 +31,8 @@ makedocs(sitename = "OrdinaryDiffEq.jl",
         OrdinaryDiffEq.OrdinaryDiffEqPDIRK,
         OrdinaryDiffEq.OrdinaryDiffEqRosenbrock,
         OrdinaryDiffEq.OrdinaryDiffEqStabilizedIRK,
-        OrdinaryDiffEq.OrdinaryDiffEqBDF],
+        OrdinaryDiffEq.OrdinaryDiffEqBDF,
+        OrdinaryDiffEq.OrdinaryDiffEqLinear],
     warnonly = [:docs_block, :missing_docs, :eval_block],
     format = Documenter.HTML(analytics = "UA-90474609-3",
         assets = ["assets/favicon.ico"],
@@ -69,7 +70,7 @@ makedocs(sitename = "OrdinaryDiffEq.jl",
         ],
         "Semilinear ODE Solvers" => [
             "semilinear/exponential_rk.md",
-            "semilinear/magnus.md"
+            "semilinear/Linear.md"
         ],
         "Misc Solvers" => [
             "misc.md"

diff --git a/docs/src/misc.md b/docs/src/misc.md
@@ -1,5 +1,4 @@
 ```@docs
-LinearExponential
 SplitEuler
 CompositeAlgorithm
 PDIRK44

diff --git a/docs/src/semilinear/Linear.md b/docs/src/semilinear/Linear.md
@@ -0,0 +1,31 @@
+# OrdinaryDiffEqLinear
+
+Methods for semi-linear differential equations.
+
+```@eval
+first_steps = evalfile("./common_first_steps.jl")
+first_steps("OrdinaryDiffEqLinear", "LieRK4")
+```
+
+## Full list of solvers
+
+```@docs
+MagnusMidpoint
+MagnusLeapfrog
+LieEuler
+MagnusGauss4
+MagnusNC6
+MagnusGL6
+MagnusGL8
+MagnusNC8
+MagnusGL4
+RKMK2
+RKMK4
+LieRK4
+CG2
+CG3
+CG4a
+MagnusAdapt4
+CayleyEuler
+LinearExponential
+```
diff --git a/docs/src/semilinear/magnus.md b/docs/src/semilinear/magnus.md
diff --git a/lib/OrdinaryDiffEqLinear/src/OrdinaryDiffEqLinear.jl b/lib/OrdinaryDiffEqLinear/src/OrdinaryDiffEqLinear.jl
@@ -8,7 +8,8 @@ import OrdinaryDiffEqCore: alg_order, alg_extrapolates, dt_required,
                            OrdinaryDiffEqConstantCache,
                            initialize!, perform_step!, @unpack, unwrap_alg,
                            calculate_residuals!, get_fsalfirstlast,
-                           _vec, isdtchangeable, full_cache
+                           _vec, isdtchangeable, full_cache,
+                           generic_solver_docstring
 using LinearAlgebra: mul!, I
 using SciMLOperators: AbstractSciMLOperator
 using ExponentialUtilities

diff --git a/lib/OrdinaryDiffEqLinear/src/algorithms.jl b/lib/OrdinaryDiffEqLinear/src/algorithms.jl
@@ -17,18 +17,56 @@ for Alg in [
     :CG3,
     :CG4a
 ]
-    @eval struct $Alg <: OrdinaryDiffEqLinearExponentialAlgorithm
+    @eval begin
+        @doc generic_solver_docstring("description TBD",
+            $(string(Alg)),
+            "Semilinear ODE solver",
+            "ref TBD",
+            """
+            - `krylov`: TBD
+            - `m`: TBD
+            - `iop`: TBD
+            """,
+            """
+            krylov = false,
+            m = 30,
+            iop = 0,
+        """)
+        struct $Alg <: OrdinaryDiffEqLinearExponentialAlgorithm
         krylov::Bool
         m::Int
         iop::Int
+        end
     end
     @eval $Alg(; krylov = false, m = 30, iop = 0) = $Alg(krylov, m, iop)
 end
 
+@doc generic_solver_docstring("description TBD",
+    "MagnusAdapt4",
+    "Semilinear ODE solver",
+    "ref TBD", "", "")
 struct MagnusAdapt4 <: OrdinaryDiffEqAdaptiveAlgorithm end
 
+@doc generic_solver_docstring("description TBD",
+    "CayleyEuler",
+    "Semilinear ODE solver",
+    "ref TBD", "", "")
 struct CayleyEuler <: OrdinaryDiffEqAlgorithm end
 
+@doc generic_solver_docstring("description TBD",
+    "LinearExponential",
+    "Semilinear ODE solver",
+    "ref TBD",
+    """
+    - `krylov`: TBD
+    - `m`: TBD
+    - `iop`: TBD
+    """,
+    """
+    krylov = :off,
+    m = 10,
+    iop = 0,
+    """)
 struct LinearExponential <:
        OrdinaryDiffEqExponentialAlgorithm{1, false, Val{:forward}, Val{true}, nothing}
     krylov::Symbol