add DiffEqJump Wrapper to docs

rveltz · Oct 2, 2019 · ece2ddb · ece2ddb
1 parent 101944b
commit ece2ddb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/src/problem.md b/docs/src/problem.md
@@ -37,6 +37,10 @@ We then need to provide the way the jumps affect the state variable. There are t
 - `PDMPProblem(F,R,nu,xc0,xd0,p,tspan)` when ones does not want to provide the function `Delta`
 - `PDMPProblem(F,R,Delta,reaction_number::Int64,xc0,xd0,p,tspan)` when ones does not want to provide the transition matrix `nu`. The length `reaction_number` of the rate vector must then be provided.
 
+We also provide a wrapper to [DiffEqJump.jl](https://github.com/JuliaDiffEq/DiffEqJump.jl). This is quite similar to how a `JumpProblem` would be created.
+
+- `PDMPProblem(prob, jumps...)` where `prob` can be an `ODEProblem`. For an example, please consider `example/examplediffeqjumpwrapper.jl`.
+
 ### Fields
 - `F`: the function of the ODE
 - `R`: the function to compute the transition rates

diff --git a/docs/src/solver.md b/docs/src/solver.md
@@ -54,4 +54,7 @@ To simulate a PDMP, one uses `solve(prob::PDMPProblem, alg; kwargs)`. The field
 - `ind_save_c`: which indices of `xc` should be saved
 - `ind_save_d`: which indices of `xd` should be saved
 - `save_rate = true`: requires the solver to save the total rate. Can be useful when estimating the rate bounds in order to use the Rejection algorithm as a second try.
--  `X_extended = zeros(Tc, 1 + 1)`: (advanced use) options used to provide the shape of the extended array in the [CHV algorithm](https://arxiv.org/abs/1504.06873). Can be useful in order to use `StaticArrays.jl` for example.
+-  `X_extended = zeros(Tc, 1 + 1)`: (advanced use) options used to provide the shape of the extended array in the [CHV algorithm](https://arxiv.org/abs/1504.06873). Can be useful in order to use `StaticArrays.jl` for example.
+
+!!! note "Solvers for the `DiffEqJump` wrapper"
+    We provide a basic wrapper that should work for `VariableJumps` (the other types of jumps have not been thoroughly tested). You can use `CHV` for this type of problems. The `Rejection` solver is not functional yet.