Skip to content

Commit ee2452f

Browse files
Merge pull request #818 from SciML/ChrisRackauckas-patch-2
Update integrator_interface.jl with new interface information
2 parents 17f4548 + 774b944 commit ee2452f

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

src/integrator_interface.jl

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,18 +321,29 @@ end
321321
addsteps!(i::DEIntegrator, args...) = nothing
322322

323323
"""
324-
reeval_internals_due_to_modification!(integrator::DEIntegrator, continuous_modification=true)
324+
reeval_internals_due_to_modification!(integrator::DEIntegrator, continuous_modification::Bool=true;
325+
callback_initializealg = nothing)
325326
326327
Update DE integrator after changes by callbacks.
327328
For DAEs (either implicit or semi-explicit), this requires re-solving alebraic variables.
328329
If continuous_modification is true (or unspecified), this should also recalculate interpolation data.
329330
Otherwise the integrator is allowed to skip recalculating the interpolation.
331+
332+
# Arguments
333+
334+
- `continuous_modification`: determines whether the modification is due to a continuous change (continuous callback)
335+
or a discrete callback. For a continuous change, this can include a change to time which requires a re-evaluation
336+
of the interpolations.
337+
- `callback_initializealg`: the initialization algorithm provided by the callback. For DAEs, this is the choice for the
338+
initialization that is done post callback. The default value of `nothing` means that the initialization choice
339+
used for the DAE should be performed post-callback.
330340
"""
331341
function reeval_internals_due_to_modification!(
332-
integrator::DEIntegrator, continuous_modification)
342+
integrator::DEIntegrator, continuous_modification::Bool;
343+
callback_initializealg = nothing)
333344
reeval_internals_due_to_modification!(integrator::DEIntegrator)
334345
end
335-
reeval_internals_due_to_modification!(integrator::DEIntegrator) = nothing
346+
reeval_internals_due_to_modification!(integrator::DEIntegrator; callback_initializealg = nothing) = nothing
336347

337348
"""
338349
set_t!(integrator::DEIntegrator, t)

0 commit comments

Comments
 (0)