SDE Problems
Mathematical Specification of a SDE Problem
To define an SDE Problem, you simply need to give the forcing function f, the noise function g, and the initial condition u₀ which define an SDE:
f and g should be specified as f(u,p,t) and g(u,p,t) respectively, and u₀ should be an AbstractArray whose geometry matches the desired geometry of u. Note that we are not limited to numbers or vectors for u₀; one is allowed to provide u₀ as arbitrary matrices / higher dimension tensors as well. A vector of gs can also be defined to determine an SDE of higher Ito dimension.
Problem Type
Wraps the data which defines an SDE problem
with initial condition u0.
Constructors
SDEProblem(f::SDEFunction,g,u0,tspan,p=nothing;noise=WHITE_NOISE,noise_rate_prototype=nothing)SDEProblem{isinplace}(f,g,u0,tspan,p=nothing;noise=WHITE_NOISE,noise_rate_prototype=nothing): Defines the SDE with the specified functions. The default noise isWHITE_NOISE.isinplaceoptionally sets whether the function is inplace or not. This is determined automatically, but not inferred.
Parameters are optional, and if not given then a NullParameters() singleton will be used which will throw nice errors if you try to index non-existent parameters. Any extra keyword arguments are passed on to the solvers. For example, if you set a callback in the problem, then that callback will be added in every solve call.
For specifying Jacobians and mass matrices, see the DiffEqFunctions page.
Fields
f: The drift function in the SDE.g: The noise function in the SDE.u0: The initial condition.tspan: The timespan for the problem.p: The optional parameters for the problem. Defaults toNullParameters.noise: The noise process applied to the noise upon generation. Defaults to Gaussian white noise. For information on defining different noise processes, see the noise process documentation pagenoise_rate_prototype: A prototype type instance for the noise rates, that is the outputg. It can be any type which overloadsA_mul_B!with itself being the middle argument. Commonly, this is a matrix or sparse matrix. If this is not given, it defaults tonothing, which means the problem should be interpreted as having diagonal noise.kwargs: The keyword arguments passed onto the solves.
Example Problems
Examples problems can be found in DiffEqProblemLibrary.jl.
To use a sample problem, such as prob_sde_linear, you can do something like:
#] add DiffEqProblemLibrary
using DiffEqProblemLibrary.SDEProblemLibrary
# load problems
SDEProblemLibrary.importsdeproblems()
prob = SDEProblemLibrary.prob_sde_linear
sol = solve(prob)Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_linear. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_2Dlinear. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_wave. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_lorenz. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_cubic. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_additive. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_additivesystem. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_nltest. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.oval2ModelExample. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_stiffquadstrat. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_stiffquadito. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.generate_stiff_stoch_heat. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_bistable. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_bruss. Check Documenter's build log for details.
Missing docstring for DiffEqProblemLibrary.SDEProblemLibrary.prob_sde_oscilreact. Check Documenter's build log for details.