Quick fix *SDEProblem docs (proper fix requires update in StochasticI…

…ntegrators).
JuliaGNI · Mar 4, 2024 · b7fcb62 · b7fcb62
1 parent 80d7a45
commit b7fcb62
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,6 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+GeometricBase = "9a0b12b7-583b-4f04-aa1f-d8551b6addc9"
 GeometricEquations = "c85262ba-a08a-430a-b926-d29770767bf2"
 GeometricIntegrators = "dcce2d33-59f6-5b8d-9047-0defad88ae06"
 GeometricProblems = "18cb22b4-ad41-5c80-9c5f-710df63fbdc9"

diff --git a/docs/src/problems.md b/docs/src/problems.md
@@ -698,6 +698,9 @@ Markdown.parse(GeometricEquations.sde_equations)
 
 ```@example
 using GeometricIntegrators # hide
+using GeometricBase # hide
+struct WienerProcess <: GeometricBase.AbstractStochasticProcess end # hide
+
 function v(t, q, v, params)
     v[1] = + params.λ * q[2]
     v[2] = - params.λ * q[1]
@@ -714,7 +717,7 @@ tspan = (0.0, 1.0)
 tstep = 0.01
 q₀ = [0.5, 0.0]
 
-prob = SDEProblem(v, B, tspan, tstep, q₀; parameters = (λ=2.0, μ=1.0))
+prob = SDEProblem(v, B, WienerProcess(), tspan, tstep, q₀; parameters = (λ=2.0, μ=1.0))
 ```
 
 
@@ -729,6 +732,9 @@ Markdown.parse(GeometricEquations.psde_equations)
 
 ```@example
 using GeometricIntegrators # hide
+using GeometricBase # hide
+struct WienerProcess <: GeometricBase.AbstractStochasticProcess end # hide
+
 function v(v, t, q, p, params)
     v[1] = + params.λ * p[1]
 end
@@ -750,7 +756,7 @@ tstep = 0.01
 q₀ = [0.5]
 p₀ = [0.0]
 
-prob = PSDEProblem(v, f, B, G, tspan, tstep, q₀, p₀; parameters = (λ=2.0, μ=1.0))
+prob = PSDEProblem(v, f, B, G, WienerProcess(), tspan, tstep, q₀, p₀; parameters = (λ=2.0, μ=1.0))
 ```
 
 
@@ -765,6 +771,9 @@ Markdown.parse(GeometricEquations.spsde_equations)
 
 ```@example
 using GeometricIntegrators # hide
+using GeometricBase # hide
+struct WienerProcess <: GeometricBase.AbstractStochasticProcess end # hide
+
 function v(v, t, q, p, params)
     v[1] = + params.λ * p[1]
 end
@@ -794,5 +803,5 @@ tstep = 0.01
 q₀ = [0.5]
 p₀ = [0.0]
 
-prob = SPSDEProblem(v, f1, f2, B, G1, G2, tspan, tstep, q₀, p₀; parameters = (λ=2.0, μ=1.0))
+prob = SPSDEProblem(v, f1, f2, B, G1, G2, WienerProcess(), tspan, tstep, q₀, p₀; parameters = (λ=2.0, μ=1.0))
 ```