polaris.tasks.ocean.barotropic_gyre.BarotropicGyre

class polaris.tasks.ocean.barotropic_gyre.BarotropicGyre(component, subdir, test_name, boundary_condition, config, config_filename)

The convergence test case for inertial gravity waves

__init__(component, subdir, test_name, boundary_condition, config, config_filename)

Create the test case

Parameters:

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

• subdir (str) – The subdirectory for the task

• test_name (str) – The name of the test (e.g., ‘munk’)

• boundary_condition (str) – The type of boundary condition (‘free-slip’ or ‘no-slip’)

• config (PolarisConfigParser) – The configuration parser for the task

• config_filename (str) – The name of the configuration file

Methods

__init__(component, subdir, test_name, ...)	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