Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mateuszbaran committed Sep 3, 2024
1 parent 74b8cb3 commit 7cadf45
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions src/ManifoldDiffEq.jl
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,13 @@ Type parameter `T` denotes scalar floating point type of the solution
Fields:
* `u`: the representation of the ODE solution. Uses a nested power manifold representation.
* `t`: time point at which values in `u` were calculated.
* `t`: time points at which values in `u` were calculated.
* `k`: the representation of the `f` function evaluations at time points `k`. Uses a nested
power manifold representation.
* `prob`: original problem that was solved.
* `alg`: [`AbstractManifoldDiffEqAlgorithm`](@ref) used to obtain the solution.
* `interp` [`ManifoldInterpolationData`](@ref)
* `interp` [`ManifoldInterpolationData`](@ref). It is used for calculating solution values
at times `t` other then the ones at which it was saved.
* `dense`: `true` if ODE solution is saved at every step and `false` otherwise.
* `stats`: [`DEStats`](https://docs.sciml.ai/DiffEqDocs/stable/basics/solution/#SciMLBase.DEStats) of the solver
* `retcode`: [`ReturnCode`](https://docs.sciml.ai/SciMLBase/stable/interfaces/Solutions/#retcodes) of the solution.
Expand Down Expand Up @@ -191,6 +192,9 @@ alg_extrapolates(::AbstractManifoldDiffEqAlgorithm) = false

struct DefaultInit end


# Adapted from OrdinaryDiffEq.jl:
# https://github.com/SciML/OrdinaryDiffEq.jl/blob/1eef9db17600766bb71e7dce0cb105ae5f99b2a5/lib/OrdinaryDiffEqCore/src/solve.jl#L11
function SciMLBase.__init(
prob::ManifoldODEProblem,
alg::AbstractManifoldDiffEqAlgorithm,
Expand Down
4 changes: 2 additions & 2 deletions src/interpolation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"""
struct ManifoldInterpolationData end
Inspired by `OrdinaryDiffEq.OrdinaryDiffEqInterpolation`.
Inspired by [`OrdinaryDiffEq.InterpolationData`](https://github.com/SciML/OrdinaryDiffEq.jl/blob/41333beef24655d43d370af19b37efd9888179f6/lib/OrdinaryDiffEqCore/src/interp_func.jl#L4).
The main difference is using on-manifold interpolation instead of the Euclidean one.
"""
struct ManifoldInterpolationData{F,uType,tType,kType,cacheType,TM}
f::F
Expand Down

0 comments on commit 7cadf45

Please sign in to comment.