polaris.tasks.mesh.spherical.unified.sizing_field.BuildSizingFieldStep
- class polaris.tasks.mesh.spherical.unified.sizing_field.BuildSizingFieldStep(component, coastline_step, river_step, subdir)[source]
Build a unified sizing field on a shared lat-lon target grid.
The step reads the prepared coastline and river-network products for one mesh, delegates ocean-background construction to the mesh family, and writes a multi-variable sizing-field dataset to
sizing_field.nc.- Variables:
coastline_step (polaris.Step) – The shared coastline-preparation step whose outputs are consumed
river_step (polaris.Step) – The shared lat-lon river-network step whose masks are consumed
sizing_field_filename (str) – Name of the output sizing-field NetCDF file
- __init__(component, coastline_step, river_step, subdir)[source]
Create a new step.
- Parameters:
component (polaris.Component) – The component the step belongs to
coastline_step (polaris.Step) – The shared coastline-preparation step for the lat-lon grid
river_step (polaris.Step) – The shared lat-lon river-network step
subdir (str) – The subdirectory within the component work directory where the step runs
Methods
__init__(component, coastline_step, ...)Create a new 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_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.
check_properties()This method should be overridden to check properties of step outputs
constrain_resources(available_resources)Constrain
cpus_per_taskandntasksbased on the number of cores available to this stepprocess_inputs_and_outputs()Process the inputs to and outputs from a step added with
polaris.Step.add_input_file()andpolaris.Step.add_output_file().run()Build the sizing-field dataset and write it to NetCDF.
runtime_setup()Update attributes of the step at runtime before calling the
run()method.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()Link coastline and river products, configure the mesh family, and declare outputs.
validate_baselines()Compare variables between output files in this step and in the same step from a baseline run if one was provided.