Skip to content

Commit 02e7443

Browse files
committed
docs: document DAEProblem constructor
1 parent 5cfb1b6 commit 02e7443

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/src/systems/ODESystem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ jacobian_sparsity
6262
ODEFunction(sys::ModelingToolkit.AbstractODESystem, args...)
6363
ODEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
6464
SteadyStateProblem(sys::ModelingToolkit.AbstractODESystem, args...)
65+
DAEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
6566
```
6667

6768
## Expression Constructors

src/systems/diffeqs/abstractodesystem.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -936,6 +936,8 @@ DiffEqBase.DAEProblem{iip}(sys::AbstractODESystem, du0map, u0map, tspan,
936936
937937
Generates a DAEProblem from an ODESystem and allows for automatically
938938
symbolically calculating numerical enhancements.
939+
940+
Note: Solvers for DAEProblems like DFBDF, DImplicitEuler, DABDF2 are generally slower than the ones for ODEProblems. If possible, it is recommended to formulate your problem in terms of an ODEProblem and use the corresponding ODE Solvers.
939941
"""
940942
function DiffEqBase.DAEProblem(sys::AbstractODESystem, args...; kwargs...)
941943
DAEProblem{true}(sys, args...; kwargs...)
@@ -946,7 +948,7 @@ function DiffEqBase.DAEProblem{iip}(sys::AbstractODESystem, du0map, u0map, tspan
946948
warn_initialize_determined = true,
947949
check_length = true, eval_expression = false, eval_module = @__MODULE__, kwargs...) where {iip}
948950
if !iscomplete(sys)
949-
error("A completed system is required. Call `complete` or `structural_simplify` on the system before creating a `DAEProblem`")
951+
error("A completed system is required. Call `complete` or `structural_simplify` on the system before creating a `DAEProblem`.")
950952
end
951953
f, du0, u0, p = process_SciMLProblem(DAEFunction{iip}, sys, u0map, parammap;
952954
implicit_dae = true, du0map = du0map, check_length,

0 commit comments

Comments
 (0)