Skip to content

Enable AveragedSpecifiedTimes to be used in output writers #4876

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 13 commits into
base: main
Choose a base branch
from
Open

Enable AveragedSpecifiedTimes to be used in output writers #4876

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5fcbcfa
first commit for array averagedspecifiedtimes
xkykai Oct 21, 2025
5457bc5
allow window to be arrays
xkykai Oct 21, 2025
96872aa
Enhance AveragedSpecifiedTimes to support vector windows and add vali…
xkykai Oct 22, 2025
61d29ac
Refactor AveragedSpecifiedTimes to ensure non-overlapping windows and…
xkykai Oct 22, 2025
c20c9b0
Fix AveragedSpecifiedTimes to use sorted times for averaging windows
xkykai Oct 22, 2025
35c41a5
Remove debug logging from AveragedSpecifiedTimes function
xkykai Oct 22, 2025
6d16825
update commented out method
xkykai Oct 22, 2025
6ea30f5
Refactor AveragedSpecifiedTimes to support varying window types and i…
xkykai Oct 22, 2025
56e6e55
Refactor AveragedTimeInterval struct to support generic types for int…
xkykai Oct 22, 2025
b3f1541
make averagedspecifiedtimes concrete
xkykai Oct 22, 2025
ed15fd6
Merge branch 'main' into xk/enable-array-averagedtimeinterval
xkykai Oct 22, 2025
0efdbc8
change dispatch method
xkykai Oct 24, 2025
3ab8e0e
change to fallback
xkykai Oct 24, 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
48 changes: 20 additions & 28 deletions src/OutputWriters/windowed_time_average.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ using Oceananigans.Diagnostics: AbstractDiagnostic
using Oceananigans.OutputWriters: fetch_output
using Oceananigans.Utils: AbstractSchedule, prettytime
using Oceananigans.TimeSteppers: Clock
using Dates: Period

import Oceananigans: run_diagnostic!
import Oceananigans.Utils: TimeInterval, SpecifiedTimes
Expand Down Expand Up @@ -102,63 +103,54 @@ Base.copy(sch::AveragedTimeInterval) = AveragedTimeInterval(sch.interval, window

A schedule for averaging over windows that precede SpecifiedTimes.
"""
mutable struct AveragedSpecifiedTimes{W <: Union{Float64, Vector{Float64}}} <: AbstractSchedule
mutable struct AveragedSpecifiedTimes{W} <: AbstractSchedule
specified_times :: SpecifiedTimes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since SpecifiedTimes is not a concrete type, this should also be a type parameter

window :: W
stride :: Int
collecting :: Bool
end

const VaryingWindowAveragedSpecifiedTimes = AveragedSpecifiedTimes{Vector{Float64}}
const VaryingWindowAveragedSpecifiedTimes = AveragedSpecifiedTimes{<:Vector}

AveragedSpecifiedTimes(specified_times::SpecifiedTimes; window, stride=1) =
AveragedSpecifiedTimes(specified_times, window, stride, false)

AveragedSpecifiedTimes(times; window, kw...) = AveragedSpecifiedTimes(times, window; kw...)

function AveragedSpecifiedTimes(times, window::Vector{Float64}; kw...)
function determine_epsilon(eltype)
if eltype <: AbstractFloat
return eps(eltype)
elseif eltype <: Period
return Second(0)
else
return 0
end
end
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
function determine_epsilon(eltype)
if eltype <: AbstractFloat
return eps(eltype)
elseif eltype <: Period
return Second(0)
else
return 0
end
end
determine_epsilon(eltype) = 0
determine_epsilon(eltype::AbstractType) = eps(eltype)
determine_epsilon(::Period) = Second(0)

the name of the function is slightly problematic

Copy link
Collaborator Author

@xkykai xkykai Oct 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you meant

Oceananigans.jl/src/OutputWriters/windowed_time_average.jl

Lines 120 to 122 in 0efdbc8

determine_epsilon(eltype) = 0
determine_epsilon(::Type{T}) where T <: AbstractFloat = eps(T)
determine_epsilon(::Period) = Second(0)

right?

I agree the name is terrible, but I haven't figured out a better alternative...


function AveragedSpecifiedTimes(times, window::Vector; kw...)
length(window) == length(times) || throw(ArgumentError("When providing a vector of windows, its length $(length(window)) must match the number of specified times $(length(times))."))
perm = sortperm(times)
sorted_times = times[perm]
sorted_window = window[perm]
time_diff = diff(vcat(0, sorted_times))

any(time_diff .- sorted_window .< -eps(eltype(window))) && throw(ArgumentError("Averaging windows overlap. Ensure that for each specified time tᵢ, tᵢ - windowᵢ ≥ tᵢ₋₁."))
epsilon = determine_epsilon(eltype(window))
any(time_diff .- sorted_window .< -epsilon) && throw(ArgumentError("Averaging windows overlap. Ensure that for each specified time tᵢ, tᵢ - windowᵢ ≥ tᵢ₋₁."))

return AveragedSpecifiedTimes(SpecifiedTimes(sorted_times); window=sorted_window, kw...)
end

function AveragedSpecifiedTimes(times, window::Float64; kw...)
function AveragedSpecifiedTimes(times, window::Union{<:Number, <:Period}; kw...)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
function AveragedSpecifiedTimes(times, window::Union{<:Number, <:Period}; kw...)
function AveragedSpecifiedTimes(times, window; kw...)

can this be the fallback?

sorted_times = sort(times)
time_diff = diff(vcat(0, sorted_times))

any(time_diff .- window .< -eps(typeof(window))) && throw(ArgumentError("Averaging window $window is too large and causes overlapping windows. Ensure that for each specified time tᵢ, tᵢ - window ≥ tᵢ₋₁."))
epsilon = determine_epsilon(typeof(window))

any(time_diff .- window .< -epsilon) && throw(ArgumentError("Averaging window $window is too large and causes overlapping windows. Ensure that for each specified time tᵢ, tᵢ - window ≥ tᵢ₋₁."))

return AveragedSpecifiedTimes(SpecifiedTimes(times); window, kw...)
end

# function AveragedSpecifiedTimes(times; window, kw...)
# perm = sortperm(times)
# sorted_times = times[perm]
# time_diff = diff(vcat(0, sorted_times))

# if window isa Vector{Float64}
# length(window) == length(times) || throw(ArgumentError("When providing a vector of windows, its length $(length(window)) must match the number of specified times $(length(times))."))

# sorted_window = window[perm]
# @info "timediff", time_diff
# @info "sortedwindow", sorted_window

# any(time_diff .- sorted_window .< -eps(eltype(window))) && throw(ArgumentError("Averaging windows overlap. Ensure that for each specified time tᵢ, tᵢ - windowᵢ ≥ tᵢ₋₁."))
# return AveragedSpecifiedTimes(SpecifiedTimes(sorted_times); window=sorted_window, kw...)
# elseif window isa Number
# any(time_diff .- window .< -eps(typeof(window))) && throw(ArgumentError("Averaging window $window is too large and causes overlapping windows. Ensure that for each specified time tᵢ, tᵢ - window ≥ tᵢ₋₁."))
# return AveragedSpecifiedTimes(SpecifiedTimes(times); window, kw...)
# else
# throw(ArgumentError("window must be a Float64 or a Vector{Float64}, got $(typeof(window))"))
# end
# end

get_next_window(schedule::VaryingWindowAveragedSpecifiedTimes) = schedule.window[schedule.specified_times.previous_actuation + 1]
get_next_window(schedule::AveragedSpecifiedTimes) = schedule.window

Expand Down
Loading