polaris.ocean.tasks.ice_shelf_2d.default.Default
- class polaris.ocean.tasks.ice_shelf_2d.default.Default(component, resolution, indir, init, config, include_viz=False, include_restart=False, include_tides=False)[source]
The default ice shelf 2d test case simply creates the mesh and initial condition, then performs a short forward run. Optionally, tidal forcing can be added or visualization and restart steps.
- __init__(component, resolution, indir, init, config, include_viz=False, include_restart=False, include_tides=False)[source]
Create the test case
- Parameters:
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
resolution (float) – The resolution of the test case in km
indir (str) – The directory the task is in, to which the test case name will be added
config (polaris.config.PolarisConfigParser) – The configuration for this task
include_viz (bool, optional) – Include VizMap and Viz steps for each resolution
include_restart (bool, optional) – Include restart and validation steps to test restart capabilities
include_tides (bool, optional) – Include tidal forcing in the forward step
Methods
__init__
(component, resolution, indir, init, ...)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
()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