Properly extend default_included_properties(::SeaIceModel) (#107)

* default_included_properties wasn't extended properly?

* bump patch release

* tuple -> Vector{Symbol}

Author: navidcy

Project.toml

@@ -1,7 +1,7 @@
 name = "ClimaSeaIce"
 uuid = "6ba0ff68-24e6-4315-936c-2e99227c95a4"
 authors = ["Climate Modeling Alliance and contributors"]
-version = "0.4.1"
+version = "0.4.2"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

src/SeaIceThermodynamics/SeaIceThermodynamics.jl

@@ -1,6 +1,6 @@
 module SeaIceThermodynamics
 
-export SlabSeaIceThermodynamics, 
+export SlabSeaIceThermodynamics,
        PhaseTransitions,
        MeltingConstrainedFluxBalance,
        PrescribedTemperature,
@@ -81,7 +81,7 @@ The latent heat of fusion ``ℒ(T)`` (more simply just "latent heat") is
 a function of temperature ``T`` via
 
 ```math
-ρᵢ ℒ(T) = ρᵢ ℒ₀ + (ρ_ℓ c_ℓ - ρᵢ cᵢ) (T - T₀)    
+ρᵢ ℒ(T) = ρᵢ ℒ₀ + (ρ_ℓ c_ℓ - ρᵢ cᵢ) (T - T₀)
 ```
 
 where ``ρᵢ`` is the `ice_density`, ``ρ_ℓ`` is the liquid density,
@@ -110,7 +110,7 @@ and that temperature is degrees Celsius.
 end
 
 @inline function latent_heat(thermo::PhaseTransitions, T)
-    T₀ = thermo.reference_temperature    
+    T₀ = thermo.reference_temperature
     ℒ₀ = thermo.reference_latent_heat
     ρᵢ = thermo.ice_density
     ρℓ = thermo.liquid_density
@@ -140,7 +140,6 @@ using Oceananigans.Fields: field, Field, Center, ZeroField, ConstantField
 import Oceananigans: fields, prognostic_fields
 import Oceananigans.Fields: set!
 import Oceananigans.Models: AbstractModel
-import Oceananigans.OutputWriters: default_included_properties
 import Oceananigans.Simulations: reset!, initialize!, iteration
 import Oceananigans.TimeSteppers: time_step!, update_state!
 

src/sea_ice_model.jl

@@ -13,6 +13,7 @@ using ClimaSeaIce.SeaIceThermodynamics.HeatBoundaryConditions: flux_summary
 
 import Oceananigans.Architectures: architecture
 import Oceananigans.Models: update_model_field_time_series!
+import Oceananigans.OutputWriters: default_included_properties
 
 @inline instantiate(T::DataType) = T()
 @inline instantiate(T) = T
@@ -202,7 +203,7 @@ end
 
 reset!(::SIM) = nothing
 initialize!(::SIM) = nothing
-default_included_properties(::SIM) = tuple(:grid)
+default_included_properties(::SIM) = [:grid]
 checkpointer_address(::SeaIceModel) = "SeaIceModel"
 
 # Fallback

validation/ice_ocean_model/ice_ocean_model.jl

@@ -41,13 +41,13 @@ iteration(model::IOM) = model.clock.iteration
 timestepper(::IOM) = nothing
 reset!(::IOM) = nothing
 initialize!(::IOM) = nothing
-default_included_properties(::IOM) = tuple()
+default_included_properties(::IOM) = Symbol[]
 update_state!(::IOM) = nothing
 prognostic_fields(cm::IOM) = nothing
 fields(::IOM) = NamedTuple()
 
 function IceOceanModel(ice, ocean; clock = Clock{Float64}(0, 0, 1))
-    
+
     previous_ice_thickness = deepcopy(ice.model.ice_thickness)
     previous_ice_concentration = deepcopy(ice.model.ice_concentration)
 
@@ -183,12 +183,12 @@ function time_step!(coupled_model::IceOceanModel, Δt; callbacks=nothing)
     #   accurate flux computation?
     # - Or, input "excess heat flux" into ocean after the ice melts
     # - Currently, non-conservative for heat due bc we don't account for excess
-        
+
     # TODO after ice time-step:
     #   - Adjust ocean temperature if the ice completely melts?
-   
+
     tick!(coupled_model.clock, Δt)
-    
+
     return nothing
 end
 
@@ -236,7 +236,7 @@ end
 
         # Update surface salinity flux.
         # Note: the Δt below is the ocean time-step, eg.
-        # ΔS = ⋯ - ∮ Qˢ dt ≈ ⋯ - Δtₒ * Qˢ 
+        # ΔS = ⋯ - ∮ Qˢ dt ≈ ⋯ - Δtₒ * Qˢ
         Qˢ[i, j, 1] = Δh / Δt * (Sᵢ[i, j, 1] - Sₒ[i, j, Nz])
 
         # Update previous ice thickness
@@ -294,10 +294,10 @@ end
 
         # Melting / freezing temperature at the surface of the ocean
         Tₘ = melting_temperature(liquidus, Sᴺ)
-                                 
+
         # Conditions for non-zero ice-ocean flux:
         #   - the ocean is below the freezing temperature, causing formation of ice.
-        freezing = Tᴺ < Tₘ 
+        freezing = Tᴺ < Tₘ
 
         #   - We are at the surface and the cell is covered by ice.
         icy_surface_cell = (k == Nz) & icy_cell
@@ -314,7 +314,7 @@ end
         #
         #   - When Tᴺ > Tₘ and we are in a surface cell covered by ice, we assume equilibrium
         #     and cool the ocean by injecting excess heat into the ice.
-        # 
+        #
         δEₒ = adjust_temperature * ρₒ * cₒ * (Tₘ - Tᴺ)
 
         # Perform temperature adjustment
@@ -329,7 +329,7 @@ end
         # A negative value δQ < 0 implies that heat is fluxed from the ice into
         # the ocean, cooling the ice and heating the ocean (δEₒ > 0). This occurs when
         # frazil ice is formed within the ocean.
-        
+
         δQ -= δEₒ * Δz / Δt
     end