Move SWRC to Soils module

src/Physics/Hydrology/Hydrology.jl

@@ -10,10 +10,6 @@ using IfElse
 using ModelParameters
 using Unitful
 
-export SWRC, VanGenuchten
-
-include("swrc.jl")
-
-# TODO: implement water fluxes
+include("water_bucket.jl")
 
 end

src/Physics/Soils/Soils.jl

@@ -24,6 +24,9 @@ import Flatten: @flattenable, flattenable
 export Soil, SoilParameterization, CharacteristicFractions, SoilProfile
 export soilcomponent, porosity, mineral, organic
 
+const Enthalpy = HeatConduction.Enthalpy
+const Temperature = HeatConduction.Temperature
+
 """
     SoilComposition
 
@@ -126,7 +129,32 @@ function CryoGrid.initialcondition!(::Heterogeneous, soil::Soil{<:Characteristic
     @. state.θo = soilcomponent(Val{:θo}(), χ, ϕ, θ, ω)
 end
 
+"""
+    mineral(soil::Soil, state, i)
+
+Retrieves the mineral content for the given layer at grid cell `i`, if provided.
+Defaults to using the scalar mineral content defined on `soil`.
+"""
+@inline mineral(soil::Soil, state, i) = Utils.getscalar(mineral(soil, state), i)
+"""
+    organic(soil::Soil, state, i)
+
+Retrieves the organic content for the given layer at grid cell `i`, if provided.
+Defaults to using the scalar organic content defined on `soil`.
+"""
+@inline organic(soil::Soil, state, i) = Utils.getscalar(organic(soil, state), i)
+"""
+    porosity(soil::Soil, state, i)
+
+Retrieves the porosity for the given layer at grid cell `i`, if provided.
+Defaults to using the scalar porosity defined on `soil`.
+"""
+@inline porosity(soil::Soil, state, i) = Utils.getscalar(porosity(soil, state), i)
+
+export SWRC, VanGenuchten
+include("sfcc/swrc.jl")
 export SFCC, DallAmico, Westermann, McKenzie, SFCCNewtonSolver, SFCCPreSolver
+include("sfcc/sfcc.jl")
 include("soilheat.jl")
 
 end

src/Physics/Soils/sfcc.jl → src/Physics/Soils/sfcc/sfcc.jl

@@ -49,12 +49,9 @@ CryoGrid.variables(::Soil, ::Heat, s::SFCCSolver) = ()
 
 Dall'Amico M, 2010. Coupled water and heat transfer in permafrost modeling. Ph.D. Thesis, University of Trento, pp. 43.
 """
-Base.@kwdef struct DallAmico{T,Θ,A,N,G,Tvg} <: SFCCFunction
+Base.@kwdef struct DallAmico{T,Θ,A,N,G,Tvg<:VanGenuchten} <: SFCCFunction
     Tₘ::T = Param(0.0, units=u"°C")
     θres::Θ = Param(0.0, bounds=(0,1))
-    # TODO: remove α and n from here since they are now in VanGenuchten
-    α::A = Param(4.0, bounds=(eps(),Inf), units=u"1/m")
-    n::N = Param(2.0, bounds=(1,Inf))
     g::G = 9.80665u"m/s^2" # acceleration due to gravity
     swrc::Tvg = VanGenuchten()
 end
@@ -64,12 +61,12 @@ sfccargs(f::DallAmico, soil::Soil, heat::Heat, state) = (
     heat.prop.Lf, # specific latent heat of fusion, L
     f.θres,
     f.Tₘ,
-    f.α,
-    f.n,
+    f.swrc.α,
+    f.swrc.n,
 )
 # pressure head at T
 @inline ψ(T,Tstar,ψ₀,Lf,g) = ψ₀ + Lf/(g*Tstar)*(T-Tstar)*heaviside(Tstar-T)
-@inline function (f::DallAmico)(T, θsat, θtot, Lf, θres=f.θres, Tₘ=f.Tₘ, α=f.α, n=f.n)
+@inline function (f::DallAmico)(T, θsat, θtot, Lf, θres=f.θres, Tₘ=f.Tₘ, α=f.swrc.α, n=f.swrc.n)
     let θsat = max(θtot, θsat),
         g = f.g,
         Tₘ = normalize_temperature(Tₘ),

src/Physics/Soils/soilheat.jl

-const Enthalpy = HeatConduction.Enthalpy
-const Temperature = HeatConduction.Temperature
-
 # === Thermal properties ===
 # We use methods with optional index arguments `i` to allow for implementations both
 # where these variables are treated as constants and as state variables.
 # In the latter case, specializations should override only the index-free form
 # and return a state vector instead of a scalar. The `getscalar` function will
 # handle both the scalar and vector case!
-"""
-    mineral(soil::Soil, state, i)
-
-Retrieves the mineral content for the given layer at grid cell `i`, if provided.
-Defaults to using the scalar mineral content defined on `soil`.
-"""
-@inline mineral(soil::Soil, state, i) = Utils.getscalar(mineral(soil, state), i)
-"""
-    organic(soil::Soil, state, i)
-
-Retrieves the organic content for the given layer at grid cell `i`, if provided.
-Defaults to using the scalar organic content defined on `soil`.
-"""
-@inline organic(soil::Soil, state, i) = Utils.getscalar(organic(soil, state), i)
-"""
-    porosity(soil::Soil, state, i)
-
-Retrieves the porosity for the given layer at grid cell `i`, if provided.
-Defaults to using the scalar porosity defined on `soil`.
-"""
-@inline porosity(soil::Soil, state, i) = Utils.getscalar(porosity(soil, state), i)
 # Functions for retrieving constituents and volumetric fractions
 @inline HeatConduction.thermalconductivities(soil::Soil, heat::Heat) = (heat.prop.kw, heat.prop.ki, heat.prop.ka, soil.prop.km, soil.prop.ko)
 @inline HeatConduction.heatcapacities(soil::Soil, heat::Heat) = (heat.prop.cw, heat.prop.ci, heat.prop.ca, soil.prop.cm, soil.prop.co)
@@ -42,9 +18,6 @@ Defaults to using the scalar porosity defined on `soil`.
     end
 end
 
-# SFCC
-include("sfcc.jl")
-
 """
 Initial condition for heat conduction (all state configurations) on soil layer w/ SFCC.
 """