Detach ClimaOcean to ClimaCoupler#2039
Open
simone-silvestri wants to merge 5 commits into
Open
Conversation
hgpeterson
requested changes
Jul 21, 2026
hgpeterson
left a comment
hgpeterson
left a comment
Member
There was a problem hiding this comment.
Thanks @simone-silvestri, this looks good so far! I think most of the problems I caught have to do with the fact that you used v0.5.8 of NumericalEarth, but there were some important changes since then (like wiring in the clock/stop_time to the simulations, including mass fluxes, and a few other things). Once those get ported over, I think we're almost ready to merge.
| """ | ||
| simplified_ocean_closure(FT=Oceananigans.defaults.FloatType) | ||
|
|
||
| A minimal closure suitable for testing on memory-limited GPUs (e.g. P100). Uses `ConvectiveAdjustmentVerticalDiffusivity`with a background |
Member
There was a problem hiding this comment.
Suggested change
| A minimal closure suitable for testing on memory-limited GPUs (e.g. P100). Uses `ConvectiveAdjustmentVerticalDiffusivity`with a background | |
| A minimal closure suitable for testing on memory-limited GPUs (e.g. P100). Uses `ConvectiveAdjustmentVerticalDiffusivity` with a background |
Comment on lines
+1
to
+2
| # Ported from ClimaOcean v0.10.0, src/OceanConfigurations/{OceanConfigurations,one_degree_tripolar}.jl, | ||
| # and NumericalEarth v0.5.8, src/Oceans/ocean_simulation.jl |
Member
There was a problem hiding this comment.
Maybe just state this in the PR but don't need it in the code? Also, should we be using the latest NE version (0.6.0)?
| @@ -0,0 +1,442 @@ | |||
| # Ported from NumericalEarth v0.5.8, src/Oceans/{ocean_simulation,Oceans,barotropic_potential_forcing}.jl | |||
Comment on lines
+18
to
+19
| @inline default_gravitational_acceleration() = OC.defaults.gravitational_acceleration | ||
| @inline default_planet_rotation_rate() = OC.defaults.planet_rotation_rate |
Member
There was a problem hiding this comment.
Shouldn't these come from the Coupler somewhere?
Comment on lines
+420
to
+439
| # Only forward `clock` when supplied so the model keeps its own default otherwise. | ||
| clock_kw = isnothing(clock) ? NamedTuple() : (; clock) | ||
|
|
||
| ocean_model = OC.HydrostaticFreeSurfaceModel( | ||
| grid; | ||
| buoyancy, | ||
| closure, | ||
| biogeochemistry, | ||
| tracer_advection, | ||
| momentum_advection, | ||
| tracers, | ||
| timestepper, | ||
| free_surface, | ||
| coriolis, | ||
| forcing, | ||
| boundary_conditions, | ||
| clock_kw..., | ||
| ) | ||
|
|
||
| ocean = OC.Simulation(ocean_model; Δt, verbose) |
Member
There was a problem hiding this comment.
Suggested change
| # Only forward `clock` when supplied so the model keeps its own default otherwise. | |
| clock_kw = isnothing(clock) ? NamedTuple() : (; clock) | |
| ocean_model = OC.HydrostaticFreeSurfaceModel( | |
| grid; | |
| buoyancy, | |
| closure, | |
| biogeochemistry, | |
| tracer_advection, | |
| momentum_advection, | |
| tracers, | |
| timestepper, | |
| free_surface, | |
| coriolis, | |
| forcing, | |
| boundary_conditions, | |
| clock_kw..., | |
| ) | |
| ocean = OC.Simulation(ocean_model; Δt, verbose) | |
| ocean_model = OC.HydrostaticFreeSurfaceModel( | |
| grid; | |
| clock, | |
| buoyancy, | |
| closure, | |
| biogeochemistry, | |
| tracer_advection, | |
| momentum_advection, | |
| tracers, | |
| timestepper, | |
| free_surface, | |
| coriolis, | |
| forcing, | |
| boundary_conditions) | |
| ocean = OC.Simulation(ocean_model; Δt, stop_time, verbose) |
We lost the clock changes from NE v0.5.9 again!
Comment on lines
+123
to
+124
| kᴺ = size(ocean.model.grid, 3) | ||
| surface_ocean_salinity = OC.interior(ocean.model.tracers.S, :, :, kᴺ:kᴺ) |
Member
There was a problem hiding this comment.
Suggested change
| kᴺ = size(ocean.model.grid, 3) | |
| surface_ocean_salinity = OC.interior(ocean.model.tracers.S, :, :, kᴺ:kᴺ) | |
| surface_ocean_salinity = ocean_surface_salinity(ocean) |
And port over ocean_surface_salinity() from v0.6.0?
| # Build the sea ice model | ||
| sea_ice_model = CSI.SeaIceModel( | ||
| grid; | ||
| ice_salinity, |
Member
There was a problem hiding this comment.
Suggested change
| ice_salinity, | |
| clock, | |
| ice_salinity, |
| ) | ||
|
|
||
| verbose = false | ||
| sea_ice = OC.Simulation(sea_ice_model; Δt, verbose) |
Member
There was a problem hiding this comment.
Suggested change
| sea_ice = OC.Simulation(sea_ice_model; Δt, verbose) | |
| sea_ice = OC.Simulation(sea_ice_model; Δt, stop_time, verbose) |
Comment on lines
+195
to
+205
| # `ocean_surface_velocities(ocean)` is inlined here: the singleton vertical dimension is dropped, | ||
| # unlike the surface salinity slice in `sea_ice_simulation`, which keeps it. | ||
| if isnothing(ocean) | ||
| SSU = OC.Fields.ZeroField() | ||
| SSV = OC.Fields.ZeroField() | ||
| else | ||
| kᴺ = size(ocean.model.grid, 3) | ||
| SSU = view(ocean.model.velocities.u, :, :, kᴺ) | ||
| SSV = view(ocean.model.velocities.v, :, :, kᴺ) | ||
| end | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| # `ocean_surface_velocities(ocean)` is inlined here: the singleton vertical dimension is dropped, | |
| # unlike the surface salinity slice in `sea_ice_simulation`, which keeps it. | |
| if isnothing(ocean) | |
| SSU = OC.Fields.ZeroField() | |
| SSV = OC.Fields.ZeroField() | |
| else | |
| kᴺ = size(ocean.model.grid, 3) | |
| SSU = view(ocean.model.velocities.u, :, :, kᴺ) | |
| SSV = view(ocean.model.velocities.v, :, :, kᴺ) | |
| end | |
| SSU, SSV = ocean_surface_velocities(ocean) |
and port over ocean_surface_velocities() from v0.6.0
Comment on lines
+216
to
+217
| τua = OC.Field{OC.Face, OC.Center, Nothing}(grid) | ||
| τva = OC.Field{OC.Center, OC.Face, Nothing}(grid) |
Member
There was a problem hiding this comment.
No boundary_conditions like in NE?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
There are not too many lines we need to port over to completely detach ClimaCoupler from ClimaOcean and just depend on Oceananigans and ClimaSeaIce.
This PR does the initial port.