Skip to content
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

Make CheckInit more informative #886

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Make CheckInit more informative #886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8636420
Make CheckInit more informative
Ickaser Dec 3, 2024
3ae7b69
Update initialization.jl
ChrisRackauckas Dec 3, 2024
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
2 changes: 2 additions & 0 deletions src/SciMLBase.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -835,6 +835,8 @@ export ODEFunction, DiscreteFunction, ImplicitDiscreteFunction, SplitFunction, D

export OptimizationFunction, MultiObjectiveOptimizationFunction

export CheckInit

export EnsembleThreads, EnsembleDistributed, EnsembleSplitThreads, EnsembleSerial

export EnsembleAnalysis, EnsembleSummary
Expand Down
22 changes: 19 additions & 3 deletions src/initialization.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,27 @@ function get_initial_values end
struct CheckInitFailureError <: Exception
normresid::Any
abstol::Any
isdae::Bool
end

function Base.showerror(io::IO, e::CheckInitFailureError)
print(io,
"CheckInit specified but initialization not satisfied. normresid = $(e.normresid) > abstol = $(e.abstol)")
"DAE initialization failed: your u0 did not satisfy the initialization requirements,
normresid = $(e.normresid) > abstol = $(e.abstol)."
)

if isdae
print(io, " If you wish for the system to
automatically change the algebraic variables to satisfy the algebraic constraints,
please pass `initializealg = BrownBasicInit()` to solve (this option will require
`using OrdinaryDiffEqNonlinearSolve`). If you wish to perform an initialization on the
complete u0, please pass initializealg = ShampineCollocationInit() to solve. Note that
initialization can be a very difficult process for DAEs and in many cases can be
numerically intractable without symbolic manipulation of the system. For an automated
system that will generate numerically stable initializations, see ModelingToolkit.jl
structural simplification for more details."
)
end
end

struct OverrideInitMissingAlgorithm <: Exception end
Expand Down Expand Up @@ -134,7 +150,7 @@ function get_initial_values(
normresid = isdefined(integrator.opts, :internalnorm) ?
integrator.opts.internalnorm(tmp, t) : norm(tmp)
if normresid > abstol
throw(CheckInitFailureError(normresid, abstol))
throw(CheckInitFailureError(normresid, abstol, true))
end
return u0, p, true
end
Expand All @@ -151,7 +167,7 @@ function get_initial_values(
integrator.opts.internalnorm(resid, t) : norm(resid)

if normresid > abstol
throw(CheckInitFailureError(normresid, abstol))
throw(CheckInitFailureError(normresid, abstol, false))
end
return u0, p, true
end
Expand Down