Skip to content

docs: Document DAEProblem constructor #3495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 7, 2025
Merged

docs: Document DAEProblem constructor #3495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ce7dac
docs: document DAEProblem constructor
vyudu Mar 25, 2025
c1bca74
fix lines
vyudu Mar 25, 2025
0f1c669
adjust docstring
vyudu Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/systems/ODESystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ jacobian_sparsity
ODEFunction(sys::ModelingToolkit.AbstractODESystem, args...)
ODEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
SteadyStateProblem(sys::ModelingToolkit.AbstractODESystem, args...)
DAEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
```

## Expression Constructors
Expand Down
6 changes: 5 additions & 1 deletion src/systems/diffeqs/abstractodesystem.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,10 @@ DiffEqBase.DAEProblem{iip}(sys::AbstractODESystem, du0map, u0map, tspan,

Generates a DAEProblem from an ODESystem and allows for automatically
symbolically calculating numerical enhancements.

Note: Solvers for DAEProblems like DFBDF, DImplicitEuler, DABDF2 are
generally slower than the ones for ODEProblems. We recommend trying
ODEProblem and its solvers for your problem first.
"""
function DiffEqBase.DAEProblem(sys::AbstractODESystem, args...; kwargs...)
DAEProblem{true}(sys, args...; kwargs...)
Expand All @@ -951,7 +955,7 @@ function DiffEqBase.DAEProblem{iip}(sys::AbstractODESystem, du0map, u0map, tspan
warn_initialize_determined = true,
check_length = true, eval_expression = false, eval_module = @__MODULE__, kwargs...) where {iip}
if !iscomplete(sys)
error("A completed system is required. Call `complete` or `structural_simplify` on the system before creating a `DAEProblem`")
error("A completed system is required. Call `complete` or `structural_simplify` on the system before creating a `DAEProblem`.")
end
f, du0, u0, p = process_SciMLProblem(DAEFunction{iip}, sys, u0map, parammap;
implicit_dae = true, du0map = du0map, check_length,
Expand Down
Loading