polaris.seaice.tasks.single_column.forward.Forward
- class polaris.seaice.tasks.single_column.forward.Forward(component, name='forward', indir=None)[source]
A step for staging a mesh for “single column” test cases
- __init__(component, name='forward', indir=None)[source]
Create the step
- Parameters:
component (polaris.Component) – The component the step belongs to
name (str, optional) – The name of the step
indir (str, optional) – the directory the step is in, to which
name
will be appended
Methods
__init__
(component[, name, indir])Create the step
add_dependency
(step[, name])Add step as a dependency of this step (i.e. this step can't run until the dependency has finished).
add_input_file
([filename, target, database, ...])Add an input file to the step (but not necessarily to the MPAS model).
add_model_config_options
(options[, config_model])Add the replacement model config options to be parsed when generating a namelist or yaml file if and when the step gets set up.
add_namelist_file
(package, namelist)Add a file with updates to namelist options to the step to be parsed when generating a complete namelist file if and when the step gets set up.
add_output_file
(filename[, validate_vars])Add the output file that must be produced by this step and may be made available as an input to steps, perhaps in other tasks.
add_streams_file
(package, streams[, ...])Add a streams file to the step to be parsed when generating a complete streams file if and when the step gets set up.
add_yaml_file
(package, yaml[, ...])Add a file with updates to yaml config options to the step to be parsed when generating a complete yaml file if and when the step gets set up.
constrain_resources
(available_resources)Constrain
cpus_per_task
andntasks
based on the number of cores available to this stepdynamic_model_config
(at_setup)Add model config options, namelist, streams and yaml files using config options or template replacements that need to be set both during step setup and at runtime
map_yaml_configs
(configs, config_model)A mapping between model config options from different models.
map_yaml_options
(options, config_model)A mapping between model config options from different models.
map_yaml_streams
(streams, config_model)A mapping between model streams from different models.
map_yaml_to_namelist
(options)A mapping from yaml model config options to namelist options.
partition
([graph_file])Partition the domain for the requested number of tasks
process_inputs_and_outputs
()Process the model as an input, then call the parent class' version
run
()Run the step.
runtime_setup
()Update PIO namelist options, make graph file, and partition graph file (if any of these are requested)
set_model_resources
([ntasks, min_tasks, ...])Update the resources for the step.
set_resources
([cpus_per_task, ...])Update the resources for the subtask.
set_shared_config
(config[, link])Replace the step's config parser with the shared config parser
setup
()Setup the command-line arguments
update_namelist_pio
()Modify the namelist so the number of PIO tasks and the stride between them consistent with the number of nodes and cores (one PIO task per node).
validate_baselines
()Compare variables between output files in this step and in the same step from a baseline run if one was provided.