compass.ocean.vertical.partial_cells.alter_bottom_depth

compass.ocean.vertical.partial_cells.alter_bottom_depth(config, bottomDepth, refBottomDepth, maxLevelCell)[source]

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

Parameters

  • config (configparser.ConfigParser) – Configuration options with parameters used to construct the vertical grid

  • bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor

  • refBottomDepth (xarray.DataArray) – A 1D array of positive-down depths of the bottom of each z level

  • maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level

Returns

  • bottomDepth (xarray.DataArray) – The positive-down depth of the seafloor, after alteration

  • maxLevelCell (xarray.DataArray) – The zero-based index of the bottom valid level, after alteration