SDESystem
System Constructors
ModelingToolkit.SDESystem — Typestruct SDESystem <: ModelingToolkit.AbstractODESystemA system of stochastic differential equations.
Fields
eqsThe expressions defining the drift term.
noiseeqsThe expressions defining the diffusion term.
ivIndependent variable.
statesDependent (state) variables. Must not contain the independent variable.
psParameter variables. Must not contain the independent variable.
var_to_nameArray variables.
ctrlsControl parameters (some subset of
ps).observedObserved states.
tgradTime-derivative matrix. Note: this field will not be defined until
calculate_tgradis called on the system.
jacJacobian matrix. Note: this field will not be defined until
calculate_jacobianis called on the system.
ctrl_jacControl Jacobian matrix. Note: this field will not be defined until
calculate_control_jacobianis called on the system.
WfactWfactmatrix. Note: this field will not be defined untilgenerate_factorized_Wis called on the system.
Wfact_tWfact_tmatrix. Note: this field will not be defined untilgenerate_factorized_Wis called on the system.
nameName: the name of the system
systemsSystems: the internal systems. These are required to have unique names.
defaultsdefaults: The default values to use when initial conditions and/or parameters are not supplied in
ODEProblem.
connection_typetype: type of the system
Example
using ModelingToolkit
@parameters σ ρ β
@variables t x(t) y(t) z(t)
D = Differential(t)
eqs = [D(x) ~ σ*(y-x),
D(y) ~ x*(ρ-z)-y,
D(z) ~ x*y - β*z]
noiseeqs = [0.1*x,
0.1*y,
0.1*z]
de = SDESystem(eqs,noiseeqs,t,[x,y,z],[σ,ρ,β])To convert an ODESystem to an SDESystem directly:
ode = ODESystem(eqs,t,[x,y,z],[σ,ρ,β])
sde = SDESystem(ode, noiseeqs)Composition and Accessor Functions
get_eqs(sys)orequations(sys): The equations that define the SDE.get_states(sys)orstates(sys): The set of states in the SDE.get_ps(sys)orparameters(sys): The parameters of the SDE.get_iv(sys): The independent variable of the SDE.
Transformations
Missing docstring for structural_simplify. Check Documenter's build log for details.
Missing docstring for alias_elimination. Check Documenter's build log for details.
Analyses
Applicable Calculation and Generation Functions
calculate_jacobian
calculate_tgrad
calculate_factorized_W
generate_jacobian
generate_tgrad
generate_factorized_W
jacobian_sparsityProblem Constructors
SciMLBase.SDEFunction — Typefunction DiffEqBase.SDEFunction{iip}(sys::SDESystem, dvs = sys.states, ps = sys.ps;
version = nothing, tgrad=false, sparse = false,
jac = false, Wfact = false, kwargs...) where {iip}Create an SDEFunction from the SDESystem. The arguments dvs and ps are used to set the order of the dependent variable and parameter vectors, respectively.
SciMLBase.SDEProblem — Typefunction DiffEqBase.SDEProblem{iip}(sys::SDESystem,u0map,tspan,p=parammap;
version = nothing, tgrad=false,
jac = false, Wfact = false,
checkbounds = false, sparse = false,
sparsenoise = sparse,
skipzeros = true, fillzeros = true,
linenumbers = true, parallel=SerialForm(),
kwargs...)Generates an SDEProblem from an SDESystem and allows for automatically symbolically calculating numerical enhancements.