multimodemodel.Parameter

class multimodemodel.Parameter(g=9.80665, H=array([1000.]), rho_0=1024.0, a_h=2000.0, gamma_h=None, gamma_v=None, free_slip=True, no_slip=False, coriolis_func=None, on_grid=None, f=None)

Class to organise all parameters.

The parameters may be constant in space and/or time. Note that the objects compute_f method needs to be called after creation to provide the coriolis parameter on all subgrids of a staggered grid instance.

Parameters:

• g (float, default 9.81) – Gravitational acceleration m/s^2

• H (float or Array, default 1000.0) – Depth of the fluid or thickness of the undisturbed layer in m

• rho_0 (float, default 1024.0) – Reference density of sea water in kg / m^3

• coriolis_func (Optional[CoriolisFunc], default None) – Function used to compute the coriolis parameter on each subgrid of a staggered grid. It is called with the y coordinate of the respective grid.

• on_grid (StaggeredGrid, default None) – StaggeredGrid object providing the necessary grid information if a parameter depends on space, such as the Coriolis parameter. Only required if such a parameter is part of the system to solve.

Variables:

f (dict[str, numpy.ndarray]) – Mapping of the subgrid names (e.g. “u”, “v”, “eta”) to the coriolis parameter on those grids

__init__(g=9.80665, H=array([1000.]), rho_0=1024.0, a_h=2000.0, gamma_h=None, gamma_v=None, free_slip=True, no_slip=False, coriolis_func=None, on_grid=None, f=None)

Initialize Parameter object.

Methods

__init__([g, H, rho_0, a_h, gamma_h, ...])	Initialize Parameter object.
merge(others, merger)	Merge Parameter's spatially varying data.
split(splitter)	Split Parameter's spatially dependent data.

Attributes

a_h
f	Getter of the dictionary holding the Coriolis parameter.
free_slip
g
no_slip
rho_0
H
gamma_h
gamma_v