Skip to content

rft: heterogeneous ice nucleation #699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haakon-e merged 2 commits into from
Mar 22, 2026
Merged

rft: heterogeneous ice nucleation #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9250e2c
docs: update API.md
haakon-e Mar 19, 2026
69c2434
rft: heterogeneous ice nucleation
haakon-e Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 71 additions & 88 deletions docs/src/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ Microphysics0M.remove_precipitation
Microphysics0M.∂remove_precipitation_∂q_tot
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = ["Microphysics0M.jl", "Microphysics0MParams.jl"]
```

# 1-moment precipitation microphysics

```@docs
Expand All @@ -48,12 +55,26 @@ Microphysics1M.snow_melt
Microphysics1M.∂snow_melt_∂q_sno
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = ["Microphysics1M.jl", "Microphysics1MParams.jl"]
```

# 2-moment precipitation microphysics

```@docs
Microphysics2M
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = ["Microphysics2M.jl", "Microphysics2MParams.jl"]
```

## Size distributions

### Parameters
Expand Down Expand Up @@ -252,6 +273,27 @@ AerosolModel.Mode_κ
AerosolModel.AerosolDistribution
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = [
"AerosolATD.jl",
"AerosolAsianDust.jl",
"AerosolDesertDust.jl",
"AerosolDust.jl",
"AerosolFeldspar.jl",
"AerosolFerrihydrite.jl",
"AerosolIllite.jl",
"AerosolKaolinite.jl",
"AerosolMiddleEasternDust.jl",
"AerosolSaharanDust.jl",
"AerosolSeasalt.jl",
"AerosolSulfate.jl",
"Aerosol_H2SO4_Solution.jl",
]
```

# Aerosol activation

```@docs
Expand All @@ -264,6 +306,13 @@ AerosolActivation.total_N_activated
AerosolActivation.total_M_activated
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = ["AerosolActivation.jl", "AerosolModalNucleation.jl"]
```

# Artifact calling

```@docs
Expand All @@ -285,6 +334,13 @@ HetIceNucleation.INP_concentration_frequency
HetIceNucleation.INP_concentration_mean
```

## Parameters

```@autodocs
Modules = [Parameters]
Pages = ["IceNucleation.jl"]
```

# Homogeneous ice nucleation

```@docs
Expand All @@ -304,6 +360,21 @@ CloudDiagnostics.effective_radius_Liu_Hallet_97
CloudDiagnostics.effective_radius_2M
```

# Common Parameters

General parameters for thermodynamics, the environment, and base types that are shared across different microphysics parameterizations.

```@autodocs
Modules = [Parameters]
Pages = [
"Parameters.jl",
"AbstractTypes.jl",
"AirProperties.jl",
"WaterProperties.jl",
"TerminalVelocity.jl",
]
```

# Utilities

Lightweight numerical utility functions shared across modules.
Expand Down Expand Up @@ -336,94 +407,6 @@ Common.volume_sphere_R
Common.ventilation_factor
```

# Parameters

```@docs
Parameters
Parameters.ParametersType
Parameters.AerosolType
Parameters.AerosolDistributionType
Parameters.CloudCondensateType
Parameters.PrecipitationType
Parameters.TerminalVelocityType
Parameters.Precipitation2MType
Parameters.AirProperties
Parameters.WaterProperties
Parameters.ArizonaTestDust
Parameters.DesertDust
Parameters.AsianDust
Parameters.MiddleEasternDust
Parameters.SaharanDust
Parameters.Illite
Parameters.Kaolinite
Parameters.Feldspar
Parameters.Ferrihydrite
Parameters.Dust
Parameters.Seasalt
Parameters.Sulfate
Parameters.AerosolActivationParameters
Parameters.IceNucleationParameters
Parameters.Frostenberg2023
Parameters.H2SO4SolutionParameters
Parameters.Mohler2006
Parameters.Koop2000
Parameters.H2S04NucleationParameters
Parameters.OrganicNucleationParameters
Parameters.MixedNucleationParameters
Parameters.Parameters0M
Parameters.ParticlePDFSnow
Parameters.ParticlePDFIceRain
Parameters.ParticleMass
Parameters.ParticleArea
Parameters.SnowAspectRatio
Parameters.Ventilation
Parameters.Acnv1M
Parameters.CloudLiquid
Parameters.CloudIce
Parameters.Rain
Parameters.Snow
Parameters.CollisionEff
Parameters.KK2000
Parameters.AcnvKK2000
Parameters.AccrKK2000
Parameters.B1994
Parameters.AcnvB1994
Parameters.AccrB1994
Parameters.TC1980
Parameters.AcnvTC1980
Parameters.AccrTC1980
Parameters.LD2004
Parameters.VarTimescaleAcnv
Parameters.SB2006
Parameters.RainParticlePDF_SB2006
Parameters.RainParticlePDF_SB2006_limited
Parameters.RainParticlePDF_SB2006_notlimited
Parameters.CloudParticlePDF_SB2006
Parameters.AcnvSB2006
Parameters.AccrSB2006
Parameters.SelfColSB2006
Parameters.BreakupSB2006
Parameters.EvaporationSB2006
Parameters.NumberAdjustmentHorn2012
Parameters.Blk1MVelType
Parameters.Blk1MVelTypeRain
Parameters.Blk1MVelTypeSnow
Parameters.StokesRegimeVelType
Parameters.SB2006VelType
Parameters.Chen2022VelType
Parameters.Chen2022VelTypeSmallIce
Parameters.Chen2022VelTypeLargeIce
Parameters.Chen2022VelTypeRain
Parameters.TerminalVelocityParams
Parameters.Microphysics0MParams
Parameters.CloudPhaseParams1M
Parameters.PrecipPhaseParams1M
Parameters.Microphysics1MParams
Parameters.WarmRainParams2M
Parameters.P3IceParams
Parameters.Microphysics2MParams
```

# Precipitation susceptibility

```@docs
Expand Down
Loading
Loading