polaris.ocean.ice_shelf.SshAdjustment

class polaris.ocean.ice_shelf.SshAdjustment(component, mesh_filename, forward, indir=None, name='ssh_adjust')[source]

A step for iteratively adjusting the pressure from the weight of the ice shelf to match the sea-surface height as part of ice-shelf 2D test cases

__init__(component, mesh_filename, forward, indir=None, name='ssh_adjust')[source]

Create the step

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

  • mesh_filename (str) – the mesh filename (relative to the base work directory)

  • forward (polaris.Step) – the step that produced the state which will be adjusted

  • indir (str, optional) – the directory the step is in, to which name will be appended

  • name (str, optional) – the name of this step

Methods

__init__(component, mesh_filename, forward)

Create the step

add_dependency(step[, name])

Add step as a dependency of this step (i.e.

add_input_file([filename, target, database, ...])

Add an input file to the step (but not necessarily to the MPAS model).

add_output_file(filename[, validate_vars])

Add the output file that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.

constrain_resources(available_resources)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

process_inputs_and_outputs()

Process the inputs to and outputs from a step added with polaris.Step.add_input_file() and polaris.Step.add_output_file().

run()

Adjust the sea surface height or land-ice pressure to be dynamically consistent with one another.

runtime_setup()

Update attributes of the step at runtime before calling the run() method.

set_resources([cpus_per_task, ...])

Update the resources for the subtask.

set_shared_config(config[, link])

Replace the step's config parser with the shared config parser

setup()

Set up the task in the work directory, including downloading any dependencies.

validate_baselines()

Compare variables between output files in this step and in the same step from a baseline run if one was provided.