polaris.ocean.tasks.inertial_gravity_wave.InertialGravityWave
- class polaris.ocean.tasks.inertial_gravity_wave.InertialGravityWave(component, config, refinement='both')[source]
The convergence test case for inertial gravity waves
- __init__(component, config, refinement='both')[source]
Create the test case
- Parameters:
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
config (polaris.config.PolarisConfigParser) – A shared config parser
refinement (str, optional) – Whether to refine in space, time or both space and time
Methods
__init__
(component, config[, refinement])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