polaris.tasks.ocean.horiz_press_grad.resting_state_task.HorizPressGradRestingStateTask

class polaris.tasks.ocean.horiz_press_grad.resting_state_task.HorizPressGradRestingStateTask(component, name)

A two-column test of discrete hydrostatic consistency: conservative temperature and absolute salinity are horizontally uniform functions of pseudo-height, so specific volume is a function of pressure alone, isobars are level, and the true horizontal pressure-gradient acceleration (HPGA) is identically zero however the coordinate surfaces or the sea floor are tilted between the columns.

Whatever HPGA the model returns is therefore error. The task sweeps a tilt (z_tilde_bot_grad for a tilted coordinate, geom_z_bot_grad for a stepped sea floor) at each of several resolution pairs, and the analysis step measures the absolute error and the exponent with which it grows with tilt.

This is a sibling of HorizPressGradTask rather than a mode of it. That task pairs each horizontal resolution with one vertical resolution and keys its steps by horizontal resolution alone, so it cannot express the repeated horizontal resolutions this sweep needs.

Variables:

sweep_keys (list of tuple) – The (horiz_res, vert_res, tilt) triples in the sweep

__init__(component, name)

Create the test case

Parameters:

• component (polaris.tasks.ocean.Ocean) – The ocean component that this task belongs to

• name (str) – The name of the test case, which must have a corresponding <name>.cfg config file in the horiz_press_grad package that specifies the resting-state sweep.

Methods

__init__(component, name)	Create the test case
add_step([step, subdir, symlink, run_by_default])	Add a step to the task and component (if not already present)
configure()	Set config options for the test case
remove_step(step)	Remove the given step from this task and the component
set_shared_config(config[, link])	Replace the task's config parser with the shared config parser