pyshqg.preprocessing.vertical_parametrisation module

Submodule dedicated to the vertical parametrisation.

class pyshqg.preprocessing.vertical_parametrisation.VerticalParametrisation(rossby_radius_list)

Bases: object

Container class for the vertical parametrisation.

rossby_radius_list

List of Rossby radius for each level interface.

Type:

list of float

num_levels

Number of vertical levels.

Type:

int

__init__(rossby_radius_list)

Constructs the vertical parametrisation.

Parameters:

rossby_radius_list (list of float) – List of Rossby radius for each level interface.

precompute_coupling_matrix(scaling=1)

Pre-computes the vertical coupling matrix.

Parameters:

scaling (float) – Scaling of the matrix.

Returns:

coupling_matrix – The vertical coupling matrix.

Return type:

np.ndarray, shape (Nlevel, Nlevel)