Better names for default constants (#660)

* better defaults

* no need to redefine

* import default_freshwater_density

* cleanup imports

Author: navidcy

src/OceanSeaIceModels/InterfaceComputations/InterfaceComputations.jl

@@ -18,7 +18,8 @@ export
     atmosphere_ocean_stability_functions,
     atmosphere_sea_ice_stability_functions
 
-using ..OceanSeaIceModels: default_gravitational_acceleration
+using ..OceanSeaIceModels: default_gravitational_acceleration,
+                           default_freshwater_density
 
 import ClimaOcean: stateindex
 

src/OceanSeaIceModels/InterfaceComputations/coefficient_based_turbulent_fluxes.jl

@@ -1,7 +1,5 @@
 using DocStringExtensions
 
-g_Earth = Oceananigans.defaults.gravitational_acceleration
-
 """
     struct CoefficientBasedFluxes{CD, CH, CQ, S}
 

src/OceanSeaIceModels/InterfaceComputations/component_interfaces.jl

@@ -27,8 +27,6 @@ using KernelAbstractions: @kernel, @index
 
 import Oceananigans.Simulations: initialize!
 
-g_Earth = Oceananigans.defaults.gravitational_acceleration
-
 #####
 ##### Container for organizing information related to fluxes
 #####
@@ -295,7 +293,7 @@ end
 """
     ComponentInterfaces(atmosphere, ocean, sea_ice=nothing;
                         radiation = Radiation(),
-                        freshwater_density = 1000,
+                        freshwater_density = default_freshwater_density,
                         atmosphere_ocean_fluxes = SimilarityTheoryFluxes(),
                         atmosphere_sea_ice_fluxes = SimilarityTheoryFluxes(eltype(ocean.model.grid)),
                         atmosphere_ocean_interface_temperature = BulkTemperature(),
@@ -307,11 +305,11 @@ end
                         sea_ice_temperature_units = DegreesCelsius(),
                         sea_ice_reference_density = reference_density(sea_ice),
                         sea_ice_heat_capacity = heat_capacity(sea_ice),
-                        gravitational_acceleration = g_Earth)
+                        gravitational_acceleration = default_gravitational_acceleration)
 """
 function ComponentInterfaces(atmosphere, ocean, sea_ice=nothing;
                              radiation = Radiation(),
-                             freshwater_density = 1000,
+                             freshwater_density = default_freshwater_density,
                              atmosphere_ocean_fluxes = SimilarityTheoryFluxes(eltype(ocean.model.grid)),
                              atmosphere_sea_ice_fluxes = SimilarityTheoryFluxes(eltype(ocean.model.grid)),
                              atmosphere_ocean_interface_temperature = BulkTemperature(),
@@ -325,7 +323,7 @@ function ComponentInterfaces(atmosphere, ocean, sea_ice=nothing;
                              sea_ice_temperature_units = DegreesCelsius(),
                              sea_ice_reference_density = reference_density(sea_ice),
                              sea_ice_heat_capacity = heat_capacity(sea_ice),
-                             gravitational_acceleration = g_Earth)
+                             gravitational_acceleration = default_gravitational_acceleration)
 
     ocean_grid = ocean.model.grid
     FT = eltype(ocean_grid)

src/OceanSeaIceModels/InterfaceComputations/interpolate_atmospheric_state.jl

@@ -79,7 +79,7 @@ function interpolate_atmosphere_state!(interfaces, atmosphere::PrescribedAtmosph
     time_indexing = ua.time_indexing
     t = clock.time
     time_interpolator = TimeInterpolator(ua.time_indexing, times, clock.time)
-    
+
     launch!(arch, grid, kernel_parameters,
             _interpolate_primary_atmospheric_state!,
             atmosphere_data,
@@ -250,4 +250,3 @@ end
     interp_atmos_time_series(ΣJ[2], args...) +
     interp_atmos_time_series(ΣJ[3], args...) +
     interp_atmos_time_series(ΣJ[4], args...)
-

src/OceanSeaIceModels/InterfaceComputations/sea_ice_ocean_fluxes.jl

@@ -6,12 +6,12 @@ function compute_sea_ice_ocean_fluxes!(coupled_model)
     ocean   = coupled_model.ocean
     sea_ice = coupled_model.sea_ice
 
-    sea_ice_ocean_fluxes = coupled_model.interfaces.sea_ice_ocean_interface.fluxes 
+    sea_ice_ocean_fluxes = coupled_model.interfaces.sea_ice_ocean_interface.fluxes
     melting_speed    = coupled_model.interfaces.sea_ice_ocean_interface.properties.characteristic_melting_speed
     ocean_properties = coupled_model.interfaces.ocean_properties
 
     compute_sea_ice_ocean_fluxes!(sea_ice_ocean_fluxes, ocean, sea_ice, melting_speed, ocean_properties)
-    
+
     return nothing
 end
 

src/OceanSeaIceModels/InterfaceComputations/similarity_theory_turbulent_fluxes.jl

@@ -2,19 +2,14 @@ using Oceananigans.Utils: prettysummary
 using Oceananigans.Grids: AbstractGrid
 
 using Adapt
-using Thermodynamics: Liquid
-
 using Printf
-using Thermodynamics: PhasePartition
+using Thermodynamics: Liquid, PhasePartition
 using KernelAbstractions.Extras.LoopInfo: @unroll
-
 using Statistics: norm
 
 import Thermodynamics as AtmosphericThermodynamics
 import Thermodynamics.Parameters: Rv_over_Rd
 
-g_Earth = Oceananigans.defaults.gravitational_acceleration
-
 #####
 ##### Bulk turbulent fluxes based on similarity theory
 #####

src/OceanSeaIceModels/InterfaceComputations/tabulated_albedo.jl

@@ -165,4 +165,3 @@ Base.show(io::IO, α::TabulatedAlbedo) = print(io, summary(α))
 
     return α
 end
-

src/OceanSeaIceModels/OceanSeaIceModels.jl

@@ -10,11 +10,10 @@ export
     SkinTemperature,
     BulkTemperature
 
-using Oceananigans
 using SeawaterPolynomials
 
+using Oceananigans
 using Oceananigans.Operators
-
 using Oceananigans.Utils: launch!, Time, KernelParameters
 using Oceananigans.Architectures: architecture
 using Oceananigans.BoundaryConditions: fill_halo_regions!, BoundaryCondition
@@ -37,8 +36,8 @@ function freshwater_flux end
 function reference_density end
 function heat_capacity end
 
-const default_gravitational_acceleration = 9.80665
-const default_freshwater_density = 1000
+const default_gravitational_acceleration = Oceananigans.defaults.gravitational_acceleration
+const default_freshwater_density = 1000 # kg m⁻³
 
 const SeaIceSimulation = Simulation{<:SeaIceModel}
 

src/OceanSeaIceModels/ocean_sea_ice_model.jl

@@ -3,7 +3,6 @@ using Oceananigans.TimeSteppers: Clock
 using Oceananigans: SeawaterBuoyancy
 using ClimaSeaIce.SeaIceThermodynamics: melting_temperature
 using KernelAbstractions: @kernel, @index
-
 using SeawaterPolynomials: TEOS10EquationOfState
 
 import Thermodynamics as AtmosphericThermodynamics
@@ -12,12 +11,11 @@ import Thermodynamics as AtmosphericThermodynamics
 import Oceananigans: fields, prognostic_fields
 import Oceananigans.Architectures: architecture
 import Oceananigans.Fields: set!
-import Oceananigans.Models: timestepper, NaNChecker, default_nan_checker
+import Oceananigans.Models: timestepper, NaNChecker, default_nan_checker, initialization_update_state!
 import Oceananigans.OutputWriters: default_included_properties
 import Oceananigans.Simulations: reset!, initialize!, iteration
 import Oceananigans.TimeSteppers: time_step!, update_state!, time
 import Oceananigans.Utils: prettytime
-import Oceananigans.Models: timestepper, NaNChecker, default_nan_checker, initialization_update_state!
 
 mutable struct OceanSeaIceModel{I, A, O, F, C, Arch} <: AbstractModel{Nothing, Arch}
     architecture :: Arch

src/OceanSimulations/OceanSimulations.jl

@@ -18,8 +18,8 @@ using Oceananigans.TurbulenceClosures.TKEBasedVerticalDiffusivities:
 
 using SeawaterPolynomials.TEOS10: TEOS10EquationOfState
 
-g_Earth = Oceananigans.defaults.gravitational_acceleration
-Ω_Earth = Oceananigans.defaults.planet_rotation_rate
+default_gravitational_acceleration = Oceananigans.defaults.gravitational_acceleration
+default_planet_rotation_rate = Oceananigans.defaults.planet_rotation_rate
 
 struct Default{V}
     value :: V