CFHydrostatics

Documentation for CFHydrostatics.

CFHydrostatics.diagnosticsMethod
diags = diagnostics(model::HPE)

Return diags::CookBook containing recipes to compute standard diagnostics. This object is to be used as follows:

session = open(diags; model, state)
temp = session.temperature
...

with state the current state, obtained for instance from initial_HPE.

source
CFHydrostatics.initial_HPEMethod
state = initial_HPE(case, model)

Return an initial state for the hydrostatic model. case is expected to be a function with two methods:

surface_pressure, surface_geopotential = case(longitude, latitude)
geopotential, ulon, ulat = case(longitude, latitude, pressure)

If the hydrostatic model is for a binary fluid, the second method should return instead:

geopotential, ulon, ulat, q = case(longitude, latitude, pressure)
source