polaris.ocean.ice_shelf.IceShelfTask
- class polaris.ocean.ice_shelf.IceShelfTask(component, min_resolution, name, subdir, sshdir=None)[source]
A class for tasks with domains containing ice shelves
- Variables:
sshdir (string) – The directory to put the ssh_adjustment steps in
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
min_resolution (float) – The resolution of the test case in km
- __init__(component, min_resolution, name, subdir, sshdir=None)[source]
Construct ice shelf task
- Parameters:
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
min_resolution (float) – The resolution of the test case in km
name (string) – The name of the step
subdir (string) – The subdirectory for the step
sshdir (string, optional) – The directory to put the ssh_adjustment steps in. If None, defaults to subdir.
Methods
__init__
(component, min_resolution, name, subdir)Construct ice shelf task
add_step
([step, subdir, symlink, run_by_default])Add a step to the task and component (if not already present)
configure
()Modify the configuration options for this task.
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
setup_ssh_adjustment_steps
(mesh_filename, ...)Setup ssh_forward and ssh_adjustment steps for all iterations