ClimaLand Abstract Models and Functions

abstract type AbstractModel{FT <: AbstractFloat}

An abstract type for all models.

AbstractExpModel{FT} <: AbstractModel{FT}

An abstract type for models which must be treated explicitly. This inherits all the default function definitions from AbstractModel, as well as a make_imp_tendency default.

AbstractImExModel{FT} <: AbstractModel{FT}

An abstract type for models which must be treated implicitly (and which may also have tendency terms that can be treated explicitly). This inherits all the default function definitions from AbstractModel, as well as make_imp_tendency and make_compute_imp_tendency defaults.

name(model::AbstractModel)

Returns a symbol of the model component name, e.g. :soil or :vegetation.

initialize(model::AbstractModel)

Creates the prognostic and auxiliary states structures, but with unset values; constructs and returns the coordinates for the model domain. We may need to consider this default more as we add diverse components and Simulations.

get_earth_param_set(model::AbstractModel)

A helper function which returns the earthparamset of the model.