Skip to content

Add call_at_end and save_positions to callbacks #345

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add call_at_end and save_positions to callbacks #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 34 additions & 6 deletions src/Callbacks.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,15 @@ Trigger `f!(integrator)` every `Δt` simulation time.

If `atinit=true`, then `f!` will additionally be triggered at initialization. Otherwise
the first trigger will be after `Δt` simulation time.

If `call_at_end==true`, then `f!` will be triggered at the end of the time span. Otherwise
there is no guaranteed call to `f!` at the end of the time span.

The boolean tuple `save_positions` determines whether to save before or after `f!`.
"""
function EveryXSimulationTime(f!, Δt; atinit = false)
function EveryXSimulationTime(f!, Δt; atinit = false, call_at_end = false, save_positions = (true, true))
t_next = zero(Δt)
@assert Δt ≠ Inf "Adding callback that never gets called!"

function _initialize(c, u, t, integrator)
t_next = Δt
Expand All @@ -111,14 +117,22 @@ function EveryXSimulationTime(f!, Δt; atinit = false)
t_next += Δt
end
return true
elseif (call_at_end && t == integrator.sol.prob.tspan[2])
return true
else
return false
end
end
if isdefined(DiffEqBase, :finalize!)
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize, finalize = _finalize)
SciMLBase.DiscreteCallback(
condition,
f!;
initialize = _initialize,
finalize = _finalize,
save_positions = save_positions,
)
else
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize)
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize, save_positions = save_positions)
end
end

Expand All @@ -131,10 +145,16 @@ Trigger `f!(integrator)` every `Δsteps` simulation steps.

If `atinit==true`, then `f!` will additionally be triggered at initialization. Otherwise
the first trigger will be after `Δsteps`.

If `call_at_end==true`, then `f!` will be triggered at the end of the time span. Otherwise
there is no guaranteed call to `f!` at the end of the time span.

The boolean tuple `save_positions` determines whether to save before or after `f!`.
"""
function EveryXSimulationSteps(f!, Δsteps; atinit = false)
function EveryXSimulationSteps(f!, Δsteps; atinit = false, call_at_end = false, save_positions = (true, true))
steps = 0
steps_next = 0
@assert Δsteps ≠ Inf "Adding callback that never gets called!"

function _initialize(c, u, t, integrator)
steps = 0
Expand All @@ -154,15 +174,23 @@ function EveryXSimulationSteps(f!, Δsteps; atinit = false)
if steps >= steps_next
steps_next += Δsteps
return true
elseif (call_at_end && t == integrator.sol.prob.tspan[2])
return true
else
return false
end
end

if isdefined(DiffEqBase, :finalize!)
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize, finalize = _finalize)
SciMLBase.DiscreteCallback(
condition,
f!;
initialize = _initialize,
finalize = _finalize,
save_positions = save_positions,
)
else
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize)
SciMLBase.DiscreteCallback(condition, f!; initialize = _initialize, save_positions = save_positions)
end
end

Expand Down
24 changes: 22 additions & 2 deletions test/callbacks.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ using Test
using ClimaComms
using ClimaTimeSteppers, DiffEqBase
using ClimaTimeSteppers.Callbacks
import MPI
# import MPI
@static isdefined(ClimaComms, :device_type) && ClimaComms.@import_required_backends
device = ClimaComms.device()
comm_ctx = ClimaComms.context(device)
Expand All @@ -14,8 +14,9 @@ mutable struct MyCallback
initialized::Bool
calls::Int
finalized::Bool
last_t::Real
end
MyCallback() = MyCallback(false, 0, false)
MyCallback() = MyCallback(false, 0, false, -1.0)

function Callbacks.initialize!(cb::MyCallback, integrator)
cb.initialized = true
Expand All @@ -25,13 +26,20 @@ function Callbacks.finalize!(cb::MyCallback, integrator)
end
function (cb::MyCallback)(integrator)
cb.calls += 1
cb.last_t = integrator.t
end

cb1 = MyCallback()
cb2 = MyCallback()
cb3 = MyCallback()
cb4 = MyCallback()
cb5 = MyCallback()
cb6 = MyCallback()
cb7 = MyCallback()
cb8 = MyCallback()
cb9 = MyCallback()
cb10 = MyCallback()
cb11 = MyCallback()

cbs = CallbackSet(
EveryXSimulationTime(cb1, 1 / 4),
Expand All @@ -40,8 +48,15 @@ cbs = CallbackSet(
EveryXSimulationSteps(cb4, 4, atinit = true),
EveryXSimulationSteps(_ -> sleep(1 / 32), 1),
EveryXWallTimeSeconds(cb5, 0.49, comm_ctx),
EveryXSimulationTime(cb6, 0.49, call_at_end = true),
EveryXSimulationSteps(cb7, 3, call_at_end = true),
EveryXSimulationTime(cb8, 0.3, call_at_end = false),
EveryXSimulationSteps(cb9, 3, call_at_end = false),
)

@test_throws AssertionError EveryXSimulationTime(cb10, Inf)
@test_throws AssertionError EveryXSimulationSteps(cb11, Inf)

const_prob_inc = ODEProblem(
IncrementingODEFunction{true}((du, u, p, t, α = true, β = false) -> (du .= α .* p .+ β .* du)),
[0.0],
Expand All @@ -63,6 +78,11 @@ solve(const_prob_inc, LSRKEulerMethod(), dt = 1 / 32, callback = cbs)
@test cb4.calls == 9
@test cb5.calls >= 2

@test cb6.last_t == 1.0
@test cb7.last_t == 1.0
@test cb8.last_t == (1 / 32) * 29
@test cb9.last_t == (1 / 32) * 30

if isdefined(DiffEqBase, :finalize!)

@test cb1.finalized
Expand Down
Loading