Use Aliasing API for alias_u0
#2503
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ranocha
reviewed
Oct 27, 2024
lib/OrdinaryDiffEqCore/src/solve.jl
Outdated
Comment on lines
170
to
193
| # If alias kwarg is just default, use alias_u0, which is false by default, or is set by a kwarg to solve | ||
| # If alias_u0 is not nothing, use the alias_u0 provided by the user | ||
| if isnothing(alias.alias_u0) | ||
| alias = ODEAliases(alias_u0) | ||
| end |
There was a problem hiding this comment.
This is breaking since it does not do what is documented in older versions if users just set alias_u0.
There was a problem hiding this comment.
If users set alias_u0 in solve, and ODEAliases.alias_u0 is nothing, it uses the alias_u0 from the solve call. So the only way that the alias_u0 from the solve call isn't used is if an explicit ODEAliases with ODEAliases.alias_u0 either true or false is put in the call to solve.
lib/OrdinaryDiffEqCore/src/solve.jl
Outdated
| @@ -71,6 +71,7 @@ function DiffEqBase.__init( | |||
| initialize_integrator = true, | |||
| alias_u0 = false, | |||
| alias_du0 = false, | |||
| alias = ODEAliases(), | |||
There was a problem hiding this comment.
Suggested change
| alias = ODEAliases(), | |
| alias = ODEAliases(alias_u0 = alias_u0, alias_du0=false), |
It needs the deprecation path.
lib/OrdinaryDiffEqCore/src/solve.jl
Outdated
| @@ -119,6 +120,10 @@ function DiffEqBase.__init( | |||
| @warn("Dense output is incompatible with saveat. Please use the SavingCallback from the Callback Library to mix the two behaviors.") | |||
| end | |||
|
|
|||
| if !(alias isa ODEAliases) | |||
There was a problem hiding this comment.
Should check if the other alias kwargs are used and throw a depwarn in that case.
And we should allow / handle boolean alias specification as described in the higher level issue.
jClugstor
force-pushed
the
AliasingAPI
branch
from
62b60f1
to
d05bb41
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Additional context
This makes use of the Aliasing API in SciMLBase SciML/SciMLBase.jl#830
The default of
alias_u0is preserved here, and it isn't breaking because it still respects whenalias_u0is put in as a kwarg to solve.