mpas_tools.ocean.shift_barotropic_streamfunction

mpas_tools.ocean.shift_barotropic_streamfunction(bsf_vertex, lat_range, cells_on_vertex, lat_vertex, logger=None)[source]

Shift the barotropic streamfunction to be zero on average at the boundary over the given latitude range

Parameters:

  • bsf_vertex (xarray.DataArray) – The barotropic streamfunction in Sv on vertices

  • lat_range (list of float) – The latitude range in degrees over which to set the mean boundary value of the BSF to zero

  • cells_on_vertex (xarray.DataArray) – The zero-based cell indices on each vertex

  • lat_vertex (xarray.DataArray) – The latitude of each vertex in radians

  • logger (logging.Logger, optional) – A logger for the output

Returns:

bsf_shifted (xarray.DataArray) – The shifted barotropic streamfunction in Sv on vertices