feat: add general show methods for param structs

Author: haakon-e

docs/src/API.md

@@ -430,3 +430,10 @@ Parameters.Microphysics2MParams
 PrecipitationSusceptibility.precipitation_susceptibility_autoconversion
 PrecipitationSusceptibility.precipitation_susceptibility_accretion
 ```
+
+
+# Developer docs
+
+```@autodocs
+Modules = [ShowMethods]
+```

src/CloudMicrophysics.jl

@@ -1,5 +1,7 @@
 module CloudMicrophysics
 
+include("show.jl")
+
 include("parameters/Parameters.jl")
 import .Parameters
 const CMP = Parameters

src/P3.jl

@@ -20,6 +20,7 @@ import CloudMicrophysics.Common as CO
 import CloudMicrophysics.DistributionTools as DT
 import CloudMicrophysics.HetIceNucleation as CM_HetIce
 import CloudMicrophysics.Microphysics2M as CM2
+import CloudMicrophysics: ShowMethods
 
 include("P3_particle_properties.jl")
 include("P3_size_distribution.jl")

src/P3_particle_properties.jl

@@ -25,6 +25,9 @@ $(FIELDS)
     "Rime density"
     ρ_rim::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", x::P3State) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+ShowMethods.field_units(::P3State) = (; L_ice = "kg/m³", N_ice = "1/m³", ρ_rim = "kg/m³")
 
 """
     get_state(params; L_ice, N_ice, F_rim, ρ_rim)
@@ -51,10 +54,21 @@ Create a [`P3State`](@ref) from [`CMP.ParametersP3`](@ref) and rime state parame
  julia> params = CMP.ParametersP3(FT);
 
  julia> state = P3.get_state(params; F_rim = FT(0.5), ρ_rim = FT(916.7))
- P3State{Float32}
- ├── params = {MassPowerLaw, AreaPowerLaw, SlopePowerLaw, VentilationFactor}
- ├── F_rim = 0.5 [-]
- └── ρ_rim = 916.7 [kg/m^3]
+ P3State
+ ├─ params: ParametersP3
+ │  ├─ mass: MassPowerLaw(α_va = 0.018537706f0 [kg m^(-β_va)], β_va = 1.9f0 [-])
+ │  ├─ area: AreaPowerLaw(γ = 0.2285f0 [μm^(2-σ)], σ = 1.88f0 [-])
+ │  ├─ slope: SlopePowerLaw(a = 0.00191f0 [m^b], b = 0.8f0 [-], c = 2.0f0 [-], μ_max = 6.0f0 [-])
+ │  ├─ vent: VentilationFactor(aᵥ = 0.78f0 [-], bᵥ = 0.308f0 [-])
+ │  ├─ ρ_rim_local: LocalRimeDensity(a = 51.0f0 [-], b = 114.0f0 [-], c = -5.5f0 [-], ρ_ice = 916.7f0 [kg m⁻³])
+ │  ├─ τ_wet = 100.0 [s]
+ │  ├─ ρ_i = 916.7 [kg m⁻³]
+ │  ├─ ρ_l = 1000.0 [kg m⁻³]
+ │  └─ T_freeze = 273.15 [K]
+ ├─ L_ice = 0.3
+ ├─ N_ice = 1.0e6
+ ├─ F_rim = 0.5
+ └─ ρ_rim = 916.7
  ```
 """
 function get_state(params::CMP.ParametersP3; L_ice, N_ice, F_rim, ρ_rim)
@@ -408,19 +422,3 @@ function ϕᵢ(params::CMP.ParametersP3, F_rim, ρ_rim, D)
 
     return ifelse(D == 0, FT(0), ϕ_ob)
 end
-
-### ----------------- ###
-### ----- UTILS ----- ###
-### ----------------- ###
-
-function Base.show(io::IO, state::P3State)
-    FT = eltype(state)
-    _name(state, field) = typeof(getfield(state.params, field)).name.name
-    param_types = join(_name.(state, (:mass, :area, :slope, :vent)), ", ")
-    println(io, "P3State{$FT}")
-    println(io, "├── params = {$param_types}")
-    println(io, "├── L_ice = $(state.L_ice) [kg/m³]")
-    println(io, "├── N_ice = $(state.N_ice) [1/m³]")
-    println(io, "├── F_rim = $(state.F_rim) [-]")
-    println(io, "└── ρ_rim = $(state.ρ_rim) [kg/m³]")
-end

src/parameters/AbstractTypes.jl

@@ -9,6 +9,10 @@ abstract type ParametersType end
 # Temporary fallback until we stop checking eltype from the parameters
 Base.eltype(p::ParametersType) = fieldcount(typeof(p)) > 0 ? eltype(getfield(p, 1)) : Any
 Base.broadcastable(x::ParametersType) = tuple(x)
+Base.show(io::IO, x::ParametersType) =
+    ShowMethods.parseable_show_with_fields_no_type_header(io, x; with_module_prefix = false)
+Base.show(io::IO, mime::MIME"text/plain", x::ParametersType) =
+    ShowMethods.show_type_and_fields(io, mime, x)
 
 """
     AerosolType

src/parameters/AirProperties.jl

@@ -11,12 +11,14 @@ $(DocStringExtensions.FIELDS)
 @kwdef struct AirProperties{FT} <: ParametersType
     "thermal conductivity of air [w/m/K]"
     K_therm::FT
-    "diffusivity of water vapor [m2/s]"
+    "diffusivity of water vapor [m²/s]"
     D_vapor::FT
-    "kinematic viscosity of air [m2/s]"
+    "kinematic viscosity of air [m²/s]"
     ν_air::FT
 end
 
+ShowMethods.field_units(::AirProperties) =
+    (; K_therm = "W/m/K", D_vapor = "m²/s", ν_air = "m²/s")
 
 function AirProperties(td::CP.ParamDict)
     name_map = (;

src/parameters/Microphysics1M.jl

@@ -52,6 +52,7 @@ $(DocStringExtensions.FIELDS)
     "pre-computed gamma(me + Δm + 1) for performance [-]"
     gamma_coeff::FT
 end
+ShowMethods.field_units(::ParticleMass) = (; r0 = "m", m0 = "kg")
 
 """
     ParticleArea{FT}
@@ -65,7 +66,7 @@ a(r) = a0 χa (r/r0)^(ae + Δa)
 $(DocStringExtensions.FIELDS)
 """
 @kwdef struct ParticleArea{FT} <: ParametersType
-    "cross section size relation coefficient [m2]"
+    "cross section size relation coefficient [m²]"
     a0::FT
     "cross section size relation coefficient [-]"
     ae::FT
@@ -74,6 +75,7 @@ $(DocStringExtensions.FIELDS)
     "cross section size relation coefficient [-]"
     χa::FT
 end
+ShowMethods.field_units(::ParticleArea) = (; a0 = "m²")
 
 """
     Ventilation{FT}
@@ -133,13 +135,15 @@ $(DocStringExtensions.FIELDS)
 @kwdef struct CloudLiquid{FT} <: CloudCondensateType
     "condensation evaporation non_equil microphysics relaxation timescale [s]"
     τ_relax::FT
-    "water density [kg/m3]"
+    "water density [kg/m³]"
     ρw::FT
     "effective radius [m]"
     r_eff::FT
-    "assumed number concentration for cloud sedimentation [1/m3]"
+    "assumed number concentration for cloud sedimentation [1/m³]"
     N_0::FT
 end
+ShowMethods.field_units(::CloudLiquid) =
+    (; τ_relax = "s", ρw = "kg/m³", r_eff = "m", N_0 = "1/m³")
 
 function CloudLiquid(toml_dict::CP.ParamDict)
     name_map = (;
@@ -171,13 +175,15 @@ $(DocStringExtensions.FIELDS)
     r_ice_snow::FT
     "deposition sublimation non_equil microphysics relaxation timescale [s]"
     τ_relax::FT
-    "cloud ice apparent density [kg/m3]"
+    "cloud ice apparent density [kg/m³]"
     ρᵢ::FT
     "effective radius [m]"
     r_eff::FT
-    "assumed number concentration for cloud sedimentation [1/m3]"
+    "assumed number concentration for cloud sedimentation [1/m³]"
     N_0::FT
 end
+ShowMethods.field_units(::CloudIce) =
+    (; r0 = "m", r_ice_snow = "m", τ_relax = "s", ρᵢ = "kg/m³", r_eff = "m", N_0 = "1/m³")
 
 function CloudIce(toml_dict::CP.ParamDict)
     name_map = (;
@@ -232,6 +238,7 @@ $(DocStringExtensions.FIELDS)
     "particle length scale [m]"
     r0::FT
 end
+ShowMethods.field_units(::Rain) = (; r0 = "m")
 
 function Rain(toml_dict::CP.ParamDict)
     name_map = (;

src/parameters/Microphysics1MParams.jl

@@ -14,6 +14,9 @@ Parameters for cloud-phase (non-precipitating) hydrometeors in 1-moment scheme.
     ice::ICL
 end
 
+Base.show(io::IO, mime::MIME"text/plain", x::CloudPhaseParams1M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     PrecipPhaseParams1M{FT, RAI, SNO}
 
@@ -28,6 +31,9 @@ Parameters for precipitating hydrometeors in 1-moment scheme.
     snow::SNO
 end
 
+Base.show(io::IO, mime::MIME"text/plain", x::PrecipPhaseParams1M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     Microphysics1MParams{FT, CP, PP, CE, AP, VL, VA}
 
@@ -62,6 +68,8 @@ mp_with_2M = CMP.Microphysics1MParams(Float64; with_2M_autoconv = true)
     autoconv_2M::VA
     prescribed_Nc::FT
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Microphysics1MParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 """
     Microphysics1MParams(toml_dict::CP.ParamDict; with_2M_autoconv = false)

src/parameters/Microphysics2M.jl

@@ -324,6 +324,9 @@ RainParticlePDF_SB2006(toml_dict::CP.ParamDict; is_limited = true) =
     RainParticlePDF_SB2006_limited(toml_dict) :
     RainParticlePDF_SB2006_notlimited(toml_dict)
 
+Base.show(io::IO, mime::MIME"text/plain", x::RainParticlePDF_SB2006) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     RainParticlePDF_SB2006_limited
 

src/parameters/Microphysics2MParams.jl

@@ -20,6 +20,9 @@ WarmRainParams2M(toml_dict::CP.ParamDict; is_limited = true) =
         air_properties = AirProperties(toml_dict),
     )
 
+Base.show(io::IO, mime::MIME"text/plain", x::WarmRainParams2M) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
+
 """
     P3IceParams
 
@@ -37,6 +40,8 @@ Parameters for P3 ice-phase processes (optional).
     cloud_pdf::PDc
     rain_pdf::PDr
 end
+Base.show(io::IO, mime::MIME"text/plain", x::P3IceParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 P3IceParams(toml_dict::CP.ParamDict; is_limited = true) =
     P3IceParams(;
@@ -73,6 +78,8 @@ mp_p3 = CMP.Microphysics2MParams(Float64; with_ice = true)
     warm_rain::WR
     ice::ICE
 end
+Base.show(io::IO, mime::MIME"text/plain", x::Microphysics2MParams) =
+    ShowMethods.verbose_show_type_and_fields(io, mime, x)
 
 """
     Microphysics2MParams(toml_dict::CP.ParamDict; with_ice = false, is_limited = true)