IceNucleation.jl

export IceNucleationParameters
export Frostenberg2023

"""
    Mohler2006{FT}

Parameters for ice nucleation from Mohler et al 2006
DOI: 10.5194/acp-6-3007-2006

# Fields
$(DocStringExtensions.FIELDS)
"""
Base.@kwdef struct Mohler2006{FT} <: ParametersType{FT}
    "max allowed supersaturation [-]"
    Sᵢ_max::FT
    "threshold temperature [K]"
    T_thr::FT
end

function Mohler2006(td::CP.AbstractTOMLDict)
    name_map = (;
        :Mohler2006_maximum_allowed_Si => :Sᵢ_max,
        :Mohler2006_threshold_T => :T_thr,
    )
    parameters = CP.get_parameter_values(td, name_map, "CloudMicrophysics")
    FT = CP.float_type(td)
    return Mohler2006{FT}(; parameters...)
end

"""
    Koop2000{FT}

Parameters for ice nucleation from Koop et al 2000
DOI: 10.1038/35020537

# Fields
$(DocStringExtensions.FIELDS)
"""
Base.@kwdef struct Koop2000{FT} <: ParametersType{FT}
    "min Δaw [-]"
    Δa_w_min::FT
    "max Δaw [-]"
    Δa_w_max::FT
    "coefficient [-]"
    c₁::FT
    "coefficient [-]"
    c₂::FT
    "coefficient [-]"
    c₃::FT
    "coefficient [-]"
    c₄::FT
    "coefficient [-]"
    linear_c₁::FT
    "coefficient [-]"
    linear_c₂::FT
end

function Koop2000(td::CP.AbstractTOMLDict)
    name_map = (;
        :Koop2000_min_delta_aw => :Δa_w_min,
        :Koop2000_max_delta_aw => :Δa_w_max,
        :Koop2000_J_hom_coeff1 => :c₁,
        :Koop2000_J_hom_coeff2 => :c₂,
        :Koop2000_J_hom_coeff3 => :c₃,
        :Koop2000_J_hom_coeff4 => :c₄,
        :Linear_J_hom_coeff1 => :linear_c₁,
        :Linear_J_hom_coeff2 => :linear_c₂,
    )
    parameters = CP.get_parameter_values(td, name_map, "CloudMicrophysics")
    FT = CP.float_type(td)
    return Koop2000{FT}(; parameters...)
end

"""
    MorrisonMilbrandt2014{FT}

Parameters for ice nucleation from  Morrison & Milbrandt 2014
DOI: 10.1175/JAS-D-14-0065.1

# Fields
$(DocStringExtensions.FIELDS)
"""
Base.@kwdef struct MorrisonMilbrandt2014{FT} <: ParametersType{FT}
    "Cutoff temperature for deposition nucleation [K]"
    T_dep_thres::FT
    "coefficient [-]"
    c₁::FT
    "coefficient [-]"
    c₂::FT
    "T₀"
    T₀::FT
    "heterogeneous freezing parameter a [°C^-1]"
    het_a::FT
    "heterogeneous freezing parameter B [cm^-3 s^-1]"
    het_B::FT
end

function MorrisonMilbrandt2014(td::CP.AbstractTOMLDict)
    name_map = (;
        :temperature_homogenous_nucleation => :T_dep_thres,
        :Thompson2004_c1_Cooper => :c₁,
        :Thompson2004_c2_Cooper => :c₂,
        :temperature_water_freeze => :T₀,
        :BarklieGokhale1959_a_parameter => :het_a,
        :BarklieGokhale1959_B_parameter => :het_B,
    )
    parameters = CP.get_parameter_values(td, name_map, "CloudMicrophysics")
    FT = CP.float_type(td)
    return MorrisonMilbrandt2014{FT}(; parameters...)
end

"""
    IceNucleationParameters{FT, DEP, HOM, P3_type}

Parameters for ice nucleation

# Fields
$(DocStringExtensions.FIELDS)
"""
struct IceNucleationParameters{FT, DEP, HOM, P3_type} <: ParametersType{FT}
    deposition::DEP
    homogeneous::HOM
    p3::P3_type
end

IceNucleationParameters(::Type{FT}) where {FT <: AbstractFloat} =
    IceNucleationParameters(CP.create_toml_dict(FT))

function IceNucleationParameters(toml_dict::CP.AbstractTOMLDict)
    deposition = Mohler2006(toml_dict)
    homogeneous = Koop2000(toml_dict)
    p3 = MorrisonMilbrandt2014(toml_dict)
    DEP = typeof(deposition)
    HOM = typeof(homogeneous)
    P3_type = typeof(p3)
    FT = CP.float_type(toml_dict)
    return IceNucleationParameters{FT, DEP, HOM, P3_type}(
        deposition,
        homogeneous,
        p3,
    )
end


"""
    Frostenberg2023{FT}

Parameters for frequency distribution of INP concentration
DOI: 10.5194/acp-23-10883-2023

# Fields
$(DocStringExtensions.FIELDS)
"""
Base.@kwdef struct Frostenberg2023{FT} <: ParametersType{FT}
    "standard deviation"
    σ::FT
    "coefficient"
    a::FT
    "coefficient"
    b::FT
end

Frostenberg2023(::Type{FT}) where {FT <: AbstractFloat} =
    Frostenberg2023(CP.create_toml_dict(FT))

function Frostenberg2023(td::CP.AbstractTOMLDict)
    name_map = (;
        :Frostenberg2023_standard_deviation => :σ,
        :Frostenberg2023_a_coefficient => :a,
        :Frostenberg2023_b_coefficient => :b,
    )
    parameters = CP.get_parameter_values(td, name_map, "CloudMicrophysics")
    FT = CP.float_type(td)
    return Frostenberg2023{FT}(; parameters...)
end