polaris.tasks.ocean.realistic_global.init.pstar_init.RealisticPStarInitStep

class polaris.tasks.ocean.realistic_global.init.pstar_init.RealisticPStarInitStep(component, subdir, remap_woa23_step, cull_mesh_step, cull_topo_step)[source]

A step that jointly initializes the p-star vertical coordinate and WOA23-derived tracer fields for a global MPAS mesh, writing a model-neutral intermediate product that the downstream InitialStateStep can consume.

This is a concrete subclass of polaris.ocean.vertical.pstar_init.PStarInitStep. init_tracers() interpolates conservative temperature and absolute salinity from the pre-remapped WOA23 product (woa23_on_mesh.nc) vertically to the current p-star midpoints at each fixed-point iteration.

Variables:
__init__(component, subdir, remap_woa23_step, cull_mesh_step, cull_topo_step)[source]

Create the step.

Parameters:

  • component (polaris.tasks.ocean.Ocean) – The ocean component the step belongs to.

  • subdir (str) – The subdirectory for the step.

  • remap_woa23_step (polaris.Step) – The step that produces woa23_on_mesh.nc.

  • cull_mesh_step (polaris.Step) – The step that produces culled_ocean_mesh.nc.

  • cull_topo_step (polaris.Step) – The step that produces topography_culled.nc.

Methods

__init__(component, subdir, ...)

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_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 to the step

add_property_check(filename, check_properties)

Add a single conservation comparison for an output file

check_cf()

Check the files added with add_cf_check() for CF compliance.

check_properties()

Check conservation properties of the output files of this step.

constrain_resources(available_resources)

Constrain cpus_per_task and ntasks based on the number of cores available to this step

init_tracers(ds)

Interpolate conservative temperature and absolute salinity from the pre-remapped WOA23 depth levels to the current p-star midpoints.

process_inputs_and_outputs()

Process the inputs to and outputs from a step added with polaris.Step.add_input_file() and polaris.Step.add_output_file().

run()

Run the coupled p-star and tracer initialization from WOA23 hydrography, writing pstar_init.nc.

run_pstar_init(ds_mesh, geom_z_bot[, ...])

Run the fixed-point iteration that determines BottomPressure (and therefore the p-star coordinate) such that the recovered geometric water-column thickness matches the target within a configurable fractional tolerance.

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()

Declare input files from upstream steps.

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