polaris.ocean.init_state.add_quiescent_normal_velocity

polaris.ocean.init_state.add_quiescent_normal_velocity(ds, ds_mesh)[source]

Add a quiescent normalVelocity field (all zeros) to ds.

Parameters:

ds (xarray.Dataset) – Dataset to add the field to, with an nVertLevels dimension.
ds_mesh (xarray.Dataset) – Horizontal mesh dataset, used to determine nEdges.

Returns:

xarray.Dataset – Dataset with normalVelocity added.