polaris.ocean.vertical.partial_cells.alter_ssh

polaris.ocean.vertical.partial_cells.alter_ssh(config, ssh, refBottomDepth, minLevelCell)[source]

Alter ssh and maxLevelCell for full or partial top cells, if requested

Parameters:

config (polaris.config.PolarisConfigParser) – Configuration options with parameters used to construct the vertical grid
ssh (xarray.DataArray) – The sea surface height
refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level

Returns:

ssh (xarray.DataArray) – The sea surface height, after alteration
minLevelCell (xarray.DataArray) – The zero-based index of the top valid level, after alteration