Give (non-type) global constants upper case names (#534)

* Give (non-type) global constants upper case names and fixes issue #535
* Remove parametric type `T` from structs
This is always set at Float64. Supporting parametric precision could be part of a separate PR (if we want to support this), including which structs would need type parameters.



---------

Co-authored-by: Willem van Verseveld <[email protected]>

Author: SouthEndMusic

server/src/bmi_service.jl

@@ -88,7 +88,7 @@ end
 struct GetValue
     fn::String
     name::String
-    dest::Vector{Wflow.Float}
+    dest::Vector{Float64}
 end
 
 struct GetValuePtr
@@ -99,21 +99,21 @@ end
 struct GetValueAtIndices
     fn::String
     inds::Vector{Int}
-    dest::Vector{Wflow.Float}
+    dest::Vector{Float64}
     name::String
 end
 
 struct SetValue
     fn::String
     name::String
-    src::Vector{Wflow.Float}
+    src::Vector{Float64}
 end
 
 struct SetValueAtIndices
     fn::String
     inds::Vector{Int}
     name::String
-    src::Vector{Wflow.Float}
+    src::Vector{Float64}
 end
 
 struct GetGridType
@@ -134,13 +134,13 @@ end
 struct GetGridX
     fn::String
     grid::Int
-    x::Vector{Wflow.Float}
+    x::Vector{Float64}
 end
 
 struct GetGridY
     fn::String
     grid::Int
-    y::Vector{Wflow.Float}
+    y::Vector{Float64}
 end
 
 struct GetGridNodeCount

server/src/server.jl

@@ -1,5 +1,5 @@
 # map JSON function name to Struct (bmi_service.jl)
-const map_structs = Dict(
+const MAP_STRUCTS = Dict(
     "initialize" => Initialize,
     "get_component_name" => GetComponentName,
     "get_input_item_count" => GetInputItemCount,
@@ -65,7 +65,7 @@ end
 
 "Validate JSON request against mapped Struct"
 function valid_request(json)
-    for f in fieldnames(map_structs[json.fn])
+    for f in fieldnames(MAP_STRUCTS[json.fn])
         if f ∉ keys(json)
             return f
             break
@@ -154,10 +154,10 @@ function start(port::Int)
             json = JSON3.read(req; allow_inf = true)
             @info "Received request to run function `$(json.fn)`..."
 
-            if haskey(map_structs, json.fn)
+            if haskey(MAP_STRUCTS, json.fn)
                 v = valid_request(json)
                 if isnothing(v)
-                    f = StructTypes.constructfrom(map_structs[json.fn], json)
+                    f = StructTypes.constructfrom(MAP_STRUCTS[json.fn], json)
                     wflow_bmi(socket, handler, f)
                 else
                     err = (

server/test/client.jl

@@ -59,7 +59,7 @@ zi_size = 0
 vwc_1_size = 0
 @testset "variable information and get and set functions" begin
     @test request((fn = "get_var_itemsize", name = "subsurface_water__volume_flow_rate")) ==
-          Dict("var_itemsize" => sizeof(Wflow.Float))
+          Dict("var_itemsize" => sizeof(Float64))
     @test request((fn = "get_var_units", name = "river_water__volume_flow_rate")) ==
           Dict("var_units" => "m3 s-1")
     @test request((fn = "get_var_location", name = "river_water__volume_flow_rate")) ==
@@ -125,15 +125,15 @@ vwc_1_size = 0
         name = "soil_layer~1_water__volume_fraction",
         dest = fill(0.0, vwc_1_size),
     )
-    @test mean(request(msg)["value"]) ≈ 0.18600013563085036f0
+    @test mean(request(msg)["value"]) ≈ 0.18602528294012882
     msg = (
         fn = "get_value_at_indices",
         name = "soil_layer~1_water__volume_fraction",
         dest = [0.0, 0.0, 0.0],
         inds = [1, 2, 3],
     )
     @test request(msg)["value_at_indices"] ≈
-          [0.12089607119560242f0, 0.11968416924304527f0, 0.14602328618707333f0]
+          [0.12089607119560242, 0.11968416924304527, 0.14602328618707333]
     msg = (
         fn = "set_value",
         name = "soil_layer~1_water__volume_fraction",
@@ -145,7 +145,7 @@ vwc_1_size = 0
         name = "soil_layer~1_water__volume_fraction",
         dest = fill(0.0, vwc_1_size),
     )
-    @test mean(request(msg)["value"]) ≈ 0.3f0
+    @test mean(request(msg)["value"]) ≈ 0.3
     msg = (
         fn = "get_value_at_indices",
         name = "soil_layer~1_water__volume_fraction",

src/Wflow.jl

@@ -54,10 +54,9 @@ using Statistics: mean, median, quantile!, quantile
 using TerminalLoggers
 using TOML: TOML
 
-const Float = Float64
 const CFDataset = Union{NCDataset, NCDatasets.MFDataset}
 const CFVariable_MF = Union{NCDatasets.CFVariable, NCDatasets.MFCFVariable}
-const version =
+const VERSION =
     VersionNumber(TOML.parsefile(joinpath(@__DIR__, "..", "Project.toml"))["version"])
 
 mutable struct Clock{T}
@@ -145,6 +144,16 @@ Base.show(io::IO, ::AbstractModel{T}) where {T} = print(io, "model of type ", T)
 
 include("forcing.jl")
 include("parameters.jl")
+include("vegetation/rainfall_interception.jl")
+include("vegetation/canopy.jl")
+include("snow/snow_process.jl")
+include("snow/snow.jl")
+include("glacier/glacier_process.jl")
+include("glacier/glacier.jl")
+include("surfacewater/runoff.jl")
+include("soil/soil.jl")
+include("soil/soil_process.jl")
+include("sbm.jl")
 include("groundwater/connectivity.jl")
 include("groundwater/aquifer.jl")
 include("groundwater/boundary_conditions.jl")
@@ -156,16 +165,6 @@ include("routing/surface_kinwave.jl")
 include("routing/surface_local_inertial.jl")
 include("routing/surface_routing.jl")
 include("routing/routing_process.jl")
-include("vegetation/rainfall_interception.jl")
-include("vegetation/canopy.jl")
-include("snow/snow_process.jl")
-include("snow/snow.jl")
-include("glacier/glacier_process.jl")
-include("glacier/glacier.jl")
-include("surfacewater/runoff.jl")
-include("soil/soil.jl")
-include("soil/soil_process.jl")
-include("sbm.jl")
 include("demand/water_demand.jl")
 include("sbm_model.jl")
 include("sediment/erosion/erosion_process.jl")
@@ -216,7 +215,7 @@ function run(tomlpath::AbstractString; silent = nothing)
     fews_run = get(config, "fews_run", false)::Bool
     logger, logfile = init_logger(config; silent)
     with_logger(logger) do
-        @info "Wflow version `v$version`"
+        @info "Wflow version `v$VERSION`"
         # to catch stacktraces in the log file a try-catch is required
         try
             run(config)

src/bmi.jl

@@ -3,7 +3,7 @@
 
 # Mapping of grid identifier to a key, to get the active indices of the model domain.
 # See also function active_indices(network, key::AbstractString).
-const grids = Dict{Int, String}(
+const GRIDS = Dict{Int, String}(
     0 => "reservoir",
     1 => "lake",
     2 => "drain",
@@ -211,11 +211,7 @@ function BMI.get_time_step(model::Model)
     return Float64(model.config.time.timestepsecs)
 end
 
-function BMI.get_value(
-    model::Model,
-    name::String,
-    dest::Vector{T},
-) where {T <: AbstractFloat}
+function BMI.get_value(model::Model, name::String, dest::Vector{Float64})
     dest .= copy(BMI.get_value_ptr(model, name))
     return dest
 end
@@ -241,39 +237,34 @@ end
 function BMI.get_value_at_indices(
     model::Model,
     name::String,
-    dest::Vector{T},
+    dest::Vector{Float64},
     inds::Vector{Int},
-) where {T <: AbstractFloat}
+)
     dest .= BMI.get_value_ptr(model, name)[inds]
     return dest
 end
 
 """
-    BMI.set_value(model::Model, name::String, src::Vector{T}) where T<:AbstractFloat
+    BMI.set_value(model::Model, name::String, src::Vector{Float64})
 
 Set a model variable `name` to the values in vector `src`, overwriting the current contents.
 The type and size of `src` must match the model's internal array.
 """
-function BMI.set_value(
-    model::Model,
-    name::String,
-    src::Vector{T},
-) where {T <: AbstractFloat}
+function BMI.set_value(model::Model, name::String, src::Vector{Float64})
     return BMI.get_value_ptr(model, name) .= src
 end
 
 """
-    BMI.set_value_at_indices(model::Model, name::String, inds::Vector{Int}, src::Vector{T})
-    where T<:AbstractFloat
+    BMI.set_value_at_indices(model::Model, name::String, inds::Vector{Int}, src::Vector{Float64})
 
     Set a model variable `name` to the values in vector `src`, at indices `inds`.
 """
 function BMI.set_value_at_indices(
     model::Model,
     name::String,
     inds::Vector{Int},
-    src::Vector{T},
-) where {T <: AbstractFloat}
+    src::Vector{Float64},
+)
     return BMI.get_value_ptr(model, name)[inds] .= src
 end
 
@@ -295,32 +286,32 @@ function BMI.get_grid_rank(model::Model, grid::Int)
     end
 end
 
-function BMI.get_grid_x(model::Model, grid::Int, x::Vector{T}) where {T <: AbstractFloat}
+function BMI.get_grid_x(model::Model, grid::Int, x::Vector{Float64})
     (; reader, network) = model
     (; dataset) = reader
-    sel = active_indices(network, grids[grid])
+    sel = active_indices(network, GRIDS[grid])
     inds = [sel[i][1] for i in eachindex(sel)]
     x_nc = read_x_axis(dataset)
     x .= x_nc[inds]
     return x
 end
 
-function BMI.get_grid_y(model::Model, grid::Int, y::Vector{T}) where {T <: AbstractFloat}
+function BMI.get_grid_y(model::Model, grid::Int, y::Vector{Float64})
     (; reader, network) = model
     (; dataset) = reader
-    sel = active_indices(network, grids[grid])
+    sel = active_indices(network, GRIDS[grid])
     inds = [sel[i][2] for i in eachindex(sel)]
     y_nc = read_y_axis(dataset)
     y .= y_nc[inds]
     return y
 end
 
 function BMI.get_grid_node_count(model::Model, grid::Int)
-    return length(active_indices(model.network, grids[grid]))
+    return length(active_indices(model.network, GRIDS[grid]))
 end
 
 function BMI.get_grid_size(model::Model, grid::Int)
-    return length(active_indices(model.network, grids[grid]))
+    return length(active_indices(model.network, GRIDS[grid]))
 end
 
 function BMI.get_grid_edge_count(model::Model, grid::Int)