polaris.tasks.ocean.mixed_layer_eddies.diagnostics.compute_model_stream_function

polaris.tasks.ocean.mixed_layer_eddies.diagnostics.compute_model_stream_function(config, ds_mesh, ds, edges, eddy_velocity)[source]

Recover the stream function a model’s parameterization computed on edges from its eddy velocity, which both models define as minus the difference of the stream function across a layer divided by the layer’s mean geometric thickness on the edge

Returns:

psi (numpy.ndarray) – The stream function (m2 s-1) at layer interfaces, with shape (len(edges), nVertLevels + 1)