Revert "add a prescribed ocean"

This reverts commit 5be36f5.

Author: simone-silvestri

experiments/flux_climatology/flux_climatology.jl

@@ -115,6 +115,32 @@ end
 ##### A prescribed ocean...
 #####
 
+struct PrescribedOcean{A, G, C, U, T, F} <: AbstractModel{Nothing}
+    architecture :: A       
+    grid :: G        
+    clock :: Clock{C}
+    velocities :: U
+    tracers :: T
+    timeseries :: F
+end
+
+function PrescribedOcean(timeseries; 
+                         grid, 
+                         clock=Clock{Float64}(time = 0)) 
+
+    τx = Field{Face, Center, Nothing}(grid)
+    τy = Field{Center, Face, Nothing}(grid)
+    Jᵀ = Field{Center, Center, Nothing}(grid)
+    Jˢ = Field{Center, Center, Nothing}(grid)
+
+    u = XFaceField(grid,  boundary_conditions=FieldBoundaryConditions(grid, (Face,   Center, Center), top = FluxBoundaryCondition(τx)))
+    v = YFaceField(grid,  boundary_conditions=FieldBoundaryConditions(grid, (Center, Face,   Center), top = FluxBoundaryCondition(τy)))
+    T = CenterField(grid, boundary_conditions=FieldBoundaryConditions(grid, (Center, Center, Center), top = FluxBoundaryCondition(Jᵀ)))
+    S = CenterField(grid, boundary_conditions=FieldBoundaryConditions(grid, (Center, Center, Center), top = FluxBoundaryCondition(Jˢ)))
+
+    PrescribedOcean(architecture(grid), grid, clock, (; u, v, w=ZeroField()), (; T, S), timeseries)
+end
+
 # ...with prescribed velocity and tracer fields
 version = ECCO4Monthly()
 dates   = all_ECCO_dates(version)[1:24]
@@ -131,6 +157,35 @@ grid = ECCO.ECCO_immersed_grid(arch)
 ocean_model = PrescribedOcean((; u, v, T, S); grid)
 ocean = Simulation(ocean_model, Δt=3hour, stop_time=365days)
 
+#####
+##### Need to extend a couple of methods
+#####
+
+function time_step!(model::PrescribedOcean, Δt; callbacks=[], euler=true)
+    tick!(model.clock, Δt)
+    time = Time(model.clock.time)
+
+    possible_fts = merge(model.velocities, model.tracers)
+    time_series_tuple = extract_field_time_series(possible_fts)
+
+    for fts in time_series_tuple
+        update_field_time_series!(fts, time)
+    end
+
+    parent(model.velocities.u) .= parent(model.timeseries.u[time])
+    parent(model.velocities.v) .= parent(model.timeseries.v[time])
+    parent(model.tracers.T)    .= parent(model.timeseries.T[time])
+    parent(model.tracers.S)    .= parent(model.timeseries.S[time])
+
+    return nothing
+end
+
+update_state!(::PrescribedOcean) = nothing
+timestepper(::PrescribedOcean) = nothing
+
+reference_density(ocean::Simulation{<:PrescribedOcean}) = 1025.6
+heat_capacity(ocean::Simulation{<:PrescribedOcean}) = 3995.6
+
 #####
 ##### A prescribed atmosphere...
 #####

src/ClimaOcean.jl

@@ -41,16 +41,6 @@ using DataDeps
 using Oceananigans.OutputReaders: GPUAdaptedFieldTimeSeries, FieldTimeSeries
 using Oceananigans.Grids: node
 
-# Does not really matter if there is no model
-reference_density(::Nothing) = 0
-heat_capacity(::Nothing) = 0
-
-reference_density(unsupported) =
-    throw(ArgumentError("Cannot extract reference density from $(typeof(unsupported))"))
-
-heat_capacity(unsupported) =
-    throw(ArgumentError("Cannot deduce the heat capacity from $(typeof(unsupported))"))
-
 const SomeKindOfFieldTimeSeries = Union{FieldTimeSeries,
                                         GPUAdaptedFieldTimeSeries}
 

src/OceanSeaIceModels/OceanSeaIceModels.jl

@@ -22,6 +22,7 @@ using ClimaSeaIce: SeaIceModel
 using ClimaSeaIce.SeaIceThermodynamics: melting_temperature
 
 using ClimaOcean: stateindex
+
 using KernelAbstractions: @kernel, @index
 using KernelAbstractions.Extras.LoopInfo: @unroll
 

src/OceanSeaIceModels/ocean_sea_ice_model.jl

@@ -73,6 +73,25 @@ function initialize!(model::OSIM)
     return nothing
 end
 
+reference_density(unsupported) =
+    throw(ArgumentError("Cannot extract reference density from $(typeof(unsupported))"))
+
+heat_capacity(unsupported) =
+    throw(ArgumentError("Cannot deduce the heat capacity from $(typeof(unsupported))"))
+
+reference_density(ocean::Simulation) = reference_density(ocean.model.buoyancy.formulation)
+reference_density(buoyancy_formulation::SeawaterBuoyancy) = reference_density(buoyancy_formulation.equation_of_state)
+reference_density(eos::TEOS10EquationOfState) = eos.reference_density
+reference_density(sea_ice::SeaIceSimulation) = sea_ice.model.ice_thermodynamics.phase_transitions.ice_density
+
+heat_capacity(ocean::Simulation) = heat_capacity(ocean.model.buoyancy.formulation)
+heat_capacity(buoyancy_formulation::SeawaterBuoyancy) = heat_capacity(buoyancy_formulation.equation_of_state)
+heat_capacity(sea_ice::SeaIceSimulation) = sea_ice.model.ice_thermodynamics.phase_transitions.ice_heat_capacity
+
+# Does not really matter if there is no model
+reference_density(::Nothing) = 0
+heat_capacity(::Nothing) = 0
+
 function heat_capacity(::TEOS10EquationOfState{FT}) where FT
     cₚ⁰ = SeawaterPolynomials.TEOS10.teos10_reference_heat_capacity
     return convert(FT, cₚ⁰)

src/OceanSimulations/OceanSimulations.jl

@@ -1,6 +1,6 @@
 module OceanSimulations
 
-export ocean_simulation, PrescribedOceanModel
+export ocean_simulation
 
 using Oceananigans
 using Oceananigans.Units
@@ -21,15 +21,6 @@ using Oceananigans.BuoyancyFormulations: g_Earth
 using Oceananigans.Coriolis: Ω_Earth
 using Oceananigans.Operators
 
-import ClimaOcean: reference_density, heat_capacity
-
-reference_density(ocean::Simulation{<:HydrostaticFreeSurfaceModel}) = reference_density(ocean.model.buoyancy.formulation)
-reference_density(buoyancy_formulation::SeawaterBuoyancy) = reference_density(buoyancy_formulation.equation_of_state)
-reference_density(eos::TEOS10EquationOfState) = eos.reference_density
-
-heat_capacity(ocean::Simulation{<:HydrostaticFreeSurfaceModel}) = heat_capacity(ocean.model.buoyancy.formulation)
-heat_capacity(buoyancy_formulation::SeawaterBuoyancy) = heat_capacity(buoyancy_formulation.equation_of_state)
-
 struct Default{V}
     value :: V
 end
@@ -50,6 +41,5 @@ default_or_override(override, alternative_default=nothing) = override
 
 include("barotropic_potential_forcing.jl")
 include("ocean_simulation.jl")
-include("prescribed_ocean_model.jl")
 
 end # module

src/OceanSimulations/prescribed_ocean_model.jl

@@ -20,11 +20,6 @@ using ClimaSeaIce.SeaIceThermodynamics: IceWaterThermalEquilibrium
 
 using ClimaOcean.OceanSimulations: Default
 
-import ClimaOcean: reference_density, heat_capacity
-
-reference_density(sea_ice::SeaIceSimulation) = sea_ice.model.ice_thermodynamics.phase_transitions.ice_density
-heat_capacity(sea_ice::SeaIceSimulation) = sea_ice.model.ice_thermodynamics.phase_transitions.ice_heat_capacity
-
 function sea_ice_simulation(grid;
                             Δt = 5minutes,
                             ice_salinity = 0, # psu

src/SeaIceSimulations.jl

@@ -100,24 +100,5 @@ using ClimaSeaIce.Rheologies
             true
         end
     end
-
-    @testset "Test a prescribed ocean model" begin 
-        grid = LatitudeLongitudeGrid(size = (10, 10, 10), latitude = (20, 30), longitude = (40, 50), z = (-100, 0))
-        T = ECCOFieldTimeSeries(:temperature, grid; time_indices_in_memory = 2)
-        S = ECCOFieldTimeSeries(:salinity, grid; time_indices_in_memory = 2)
-        ocean_model = PrescribedOcean((; T, S); grid)
-
-        time_step!(ocean_model, T.times[2])
-
-        @test ocean_model.clock.time == T.times[2]
-        @test ocean_model.tracers.T.data == T[2].data
-        @test ocean_model.tracers.S.data == S[2].data
-
-        time_step!(ocean_model, 10days)
-
-        @test ocean_model.clock.time == 10days
-        @test T.backend.start == 2
-        @test ocean_model.tracers.T.data != T[3].data 
-    end
 end