polaris.ocean.tasks.geostrophic.Geostrophic
- class polaris.ocean.tasks.geostrophic.Geostrophic(component, config, icosahedral, include_viz)[source]
A convergence test for a configuration in geostrophic balance
- Variables
- __init__(component, config, icosahedral, include_viz)[source]
Create the convergence test
- Parameters
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
config (polaris.config.PolarisConfigParser) – A shared config parser
icosahedral (bool) – Whether to use icosahedral, as opposed to less regular, JIGSAW meshes
include_viz (bool) – Include VizMap and Viz steps for each resolution
Methods
__init__
(component, config, icosahedral, ...)Create the convergence test
add_step
([step, subdir, symlink, run_by_default])Add a step to the task and component (if not already present)
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