From cdbec5556168b922d83a96a50c7521f24c118e29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Syver=20D=C3=B8ving=20Agdestein?= Date: Fri, 22 Nov 2024 16:18:46 +0100 Subject: [PATCH] docs: minor fix --- docs/make.jl | 1 + docs/src/manual/closure.md | 2 +- docs/src/manual/sciml.md | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index bd3bded31..cfdbfe92a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,6 +2,7 @@ localdev = haskey(ENV, "LOCALDEV") # Get access to example dependencies +# Those are required for running the examples and generating output push!(LOAD_PATH, joinpath(@__DIR__, "..", "examples")) using IncompressibleNavierStokes diff --git a/docs/src/manual/closure.md b/docs/src/manual/closure.md index efe31ddef..9d7777a90 100644 --- a/docs/src/manual/closure.md +++ b/docs/src/manual/closure.md @@ -1,6 +1,6 @@ # Neural closure models -!!! note "`NeuralClorusure`" +!!! note "`NeuralClosure`" These features are experimental, and require cloning IncompressibleNavierStokes from GitHub: ```sh diff --git a/docs/src/manual/sciml.md b/docs/src/manual/sciml.md index 203b69bfa..5d6acc82e 100644 --- a/docs/src/manual/sciml.md +++ b/docs/src/manual/sciml.md @@ -34,7 +34,7 @@ using IncompressibleNavierStokes ax = range(0, 1, 101) setup = Setup(; x = (ax, ax), Re = 500.0) psolver = default_psolver(setup) -f(u, p, t) = create_right_hand_side(setup, psolver) +f = create_right_hand_side(setup, psolver) u0 = random_field(setup) tspan = (0.0, 1.0) # time span where to solve. problem = ODEProblem(f, u0, tspan) #SciMLBase.ODEProblem @@ -46,7 +46,7 @@ Alternatively, it is also possible to use an [in-place formulation](https://docs ```@example du = similar(u) t = 0.0 -f(du,u,p,t) = right_hand_side!(du, u, Ref([setup, psolver]), t) +f!(du,u,p,t) = right_hand_side!(du, u, Ref([setup, psolver]), t) ``` that is usually faster than the out-of-place formulation.