diff --git a/docs/src/index.md b/docs/src/index.md index 38952533..599696bf 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -26,6 +26,32 @@ SurfaceFluxes.surface_conditions SurfaceFluxes.recover_profile ``` +# Parameters +Convenience constructors are provided for the `SurfaceFluxesParameters` and the various `UniversalFunctions` parameter structs. +To use them, you must first import CLIMAParameters: +```julia +import CLIMAParameters as CP +import SurfaceFluxes.Parameters as SFP +import SurfaceFluxes.UniversalFunctions as UF + +FT = Float64 + +# SurfaceFluxesParameters requires a float type and a UniversalFunctionsParameters type +SFP.SurfaceFluxesParameters(FT, UF.BusingerParams) + +# Or a TOML dict instead of a float type +toml_dict = CP.create_toml_dict(Float64) +SFP.SurfaceFluxesParameters(toml_dict, UF.GrachevParams) + +# UniversalFunctionsParameters only require a float type or a TOML dict. +UF.BusingerParams(FT) +UF.GryanikParams(FT) +UF.GrachevParams(FT) +UF.BeljaarsParams(toml_dict) +UF.ChengParams(toml_dict) +UF.HoltslagParams(toml_dict) +``` + ## Universal Functions ```@docs