polaris.tasks.ocean.overflow.init_utils.compute_initial_density

polaris.tasks.ocean.overflow.init_utils.compute_initial_density(config, ds, logger=None)[source]

Compute the in-situ density of the initial state on a geometric vertical coordinate (z-star or sigma), at the hydrostatic pressure of the resting state with zero surface pressure.

Parameters:

config (polaris.config.PolarisConfigParser) – Configuration with the equation-of-state options.
ds (xarray.Dataset) – The initial state, with layerThickness, temperature and salinity.
logger (logging.Logger, optional) – A logger for the equation-of-state iterations.

Returns:

xarray.DataArray – The in-situ density (kg m-3) at layer midpoints.