polaris.ocean.tasks.internal_wave.rpe.Rpe
- class polaris.ocean.tasks.internal_wave.rpe.Rpe(component, indir, init, config, vadv_method='standard')[source]
The internal wave reference potential energy (RPE) test case performs a 20-day integration of the model forward in time at 5 different values of the viscosity at the given resolution.
- Variables:
resolution (float) – The resolution of the test case in km
init (polaris.ocean.tasks.baroclinic_channel.init.Init) – A shared step for creating the initial state
- __init__(component, indir, init, config, vadv_method='standard')[source]
Create the test case
- Parameters:
component (polaris.ocean.Ocean) – The ocean component that this task belongs to
indir (str) – The directory the task is in, to which
name
will be appendedinit (polaris.ocean.tasks.baroclinic_channel.init.Init) – A shared step for creating the initial state
config (polaris.config.PolarisConfigParser) – A shared config parser
vadv_method (str, optional) – The vertical advection method, ‘standard’ or ‘vlr’
Methods
__init__
(component, indir, init, config[, ...])Create the test case
add_step
([step, subdir, symlink, run_by_default])Add a step to the task and component (if not already present)
Modify the configuration options for this 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