polaris.tasks.ocean.single_column.shortwave_pen.forward.ShortwavePenForward

class polaris.tasks.ocean.single_column.shortwave_pen.forward.ShortwavePenForward(component, init, extinction, name, indir, water_type, scheme, ntasks=None, min_tasks=None, openmp_threads=1, validate_vars=None)

A forward step for the shortwave_pen task that distributes the incident shortwave flux through the water column, either with MPAS-Ocean’s two-band Jerlov scheme or with Omega’s three-band penetrating-shortwave- radiation tendency term.

With scheme='jerlov' the two models are configured to absorb the flux identically, so their profiles can be compared directly. With scheme='manizza', which Omega alone supports, the red and blue bands are given distinct extinction coefficients to show what the third band changes.

Variables:

• water_type (int) – The Jerlov water type, between 1 (I) and 5 (III)

• scheme ({'jerlov', 'manizza'}) – Whether the red and blue bands share the Jerlov visible extinction coefficient or take distinct Manizza coefficients

__init__(component, init, extinction, name, indir, water_type, scheme, ntasks=None, min_tasks=None, openmp_threads=1, validate_vars=None)

Create the step

Parameters:

• component (polaris.Component) – The component the step belongs to

• init (polaris.Step) – The initial-condition step

• extinction (polaris.Step) – The step that creates the extinction-coefficient forcing file

• name (str) – The name of the step

• indir (str) – The directory the step is in

• water_type (int) – The Jerlov water type, between 1 (I) and 5 (III)

• scheme ({'jerlov', 'manizza'}) – The shortwave absorption scheme to configure

• ntasks (int, optional) – The number of tasks the step would ideally use

• min_tasks (int, optional) – The number of tasks the step requires

• openmp_threads (int, optional) – The number of OpenMP threads the step will use

• validate_vars (list, optional) – A list of variable names to compare with a baseline

Methods

__init__(component, init, extinction, name, ...)	Create the step
add_cf_check([filename])	Check an output file for CF compliance after the step runs.
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_horiz_mesh_input_file(**kwargs)	Add the horizontal-mesh input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
add_init_input_file(**kwargs)	Add the initial-condition input file using a placeholder that is resolved to the configured filename at process_inputs_and_outputs() time.
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 an output file, optionally resolving validate_class to a pre-defined list of variables from the Ocean component.
add_property_check(filename, check_properties)	Add a single conservation comparison for an output file
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_vert_coord_input_file([filename])	Add the vertical-coordinate input file.
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.
check_cf()	Check every file Omega wrote for CF compliance: the first file of each write stream in the step's omega.yml, since the files of a stream share their metadata.
check_properties()	Check conservation properties of the output files of this step
compute_cell_count()	Compute the approximate number of cells in the mesh, used to constrain resources
constrain_resources(available_cores)	Update the number of MPI tasks to use based on the estimated mesh size
dynamic_model_config(at_setup)	Set the model config options that control shortwave absorption
get_forcing_filename()	Get the configured local filename for the surface forcing file.
get_horiz_mesh_filename()	Get the configured local filename for the horizontal mesh file.
get_init_filename()	Get the configured local filename for the initial-condition file.
get_vert_coord_filename()	Get the configured local filename for the vertical coordinate file.
map_yaml_configs(configs, config_model)	A mapping between model sections and config options from MPAS-Ocean to Omega
map_yaml_options(options, config_model)	A mapping between model config options from MPAS-Ocean to Omega
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.
open_model_dataset(filename[, config, ...])	Open the given dataset, mapping variable and dimension names from Omega to MPAS-Ocean names if appropriate
partition([graph_file])	Partition the domain for the requested number of tasks
process_inputs_and_outputs()	Process the model and any configured model-input placeholders.
run()	Run the step.
runtime_setup()	Update IO task model config 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()	Add the extinction-coefficient forcing file, which only Omega reads
update_io_tasks_config([config_model])	Modify model config options so the number of IO tasks and the stride between them are consistent with how MPI tasks are distributed across nodes (one IO task per node).
update_namelist_eos()	Modify the namelist to make it consistent with eos config options
update_namelist_pio([config_model])	Deprecated alias for update_io_tasks_config().
validate_baselines()	Compare variables between output files in this step and in the same step from a baseline run if one was provided.
work_path(*filenames)	Get the absolute path to a file or directory in the step's work directory

Attributes

cores	the number of cores this step needs, in total
gpus	the number of GPUs this step needs, in total
may_span_nodes	whether this step's cores and GPUs may come from several nodes
min_cores	the number of cores this step needs in order to run at all
min_gpus	the number of GPUs this step requires, in total
component
config
input_data
logger