Fix how NetCDFWriter outputs free surface height η
#4567
Conversation
This file contains hidden or 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
navidcy
reviewed
Jun 1, 2025
| # Kind of a hack because we want η to be a ReducedField. | ||
| free_surface_outputs = (; | ||
| η = Average(model.free_surface.η, dims=3), | ||
| η = model.free_surface.η, |
|
One of the tests fail at Oceananigans.jl/test/test_jld2_writer.jl Lines 169 to 172 in c8ff607 because of how the data is shaped now. Changing to wu = file["timeseries/wu/4"][3]
uv = file["timeseries/uv/4"][3]
wT = file["timeseries/wT/4"][3] allows the test to pass. But is this intentional? If so, there are more things that needed to be tweaked later in OutputReaders because FieldTimeSeries assume that all dimensions are present, even if with size = 1. |
|
Btw I've noticed that the changes in this PR affect also the JLD2 output writer; so perhaps the title needs updating? |
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.
Resolves #4384
I believe the changes in this PR do fix the main issue of NetCDF output for the free surface height not working. But I'm not quite happy with this solution so I've opened a draft PR for now.
While there should be better support for windowed field output, I ended up having to explicitly check for the free surface =/ Been also wondering if it's almost easier and cleaner to just special case the free surface just like how we do for
LagrangianParticles.NetCDF tests passed locally but I will revisit this PR soon with a fresh mind.
Some potential immediate changes/improvements: