polaris.tasks.ocean.realistic_global.init.jra55_map.Jra55MapStep
- class polaris.tasks.ocean.realistic_global.init.jra55_map.Jra55MapStep(component, subdir, stress_step, cull_mesh_step, mesh_name)[source]
A step for building the bilinear mapping file from the JRA55-do TL319 grid to MPAS cell centers.
This is the MPI (
mbtempestor ESMF) half of the JRA55-do remapping workflow;RemapJra55Stepapplies the resulting weights.The method is bilinear rather than conservative because the ocean responds to wind stress curl: first-order conservative remapping gives a piecewise-constant stress whose curl is grid-scale noise, and pyremap’s moab path hard-codes
--order 1so second-order conservative is not available.The weights are applied to the Cartesian components of the stress, which are scalars, so either
map_toolcan build them. ESMF’s default pole handling builds its pole point from the zonal average of the source’s outermost row, which would cancel a vector given in zonal and meridional components, since the local east/north basis rotates with longitude. See the wind-forcing section of theglobal_ocean_initdesign document.- __init__(component, subdir, stress_step, cull_mesh_step, mesh_name)[source]
Create the step.
- Parameters:
component (polaris.tasks.ocean.Ocean) – The ocean component the step belongs to.
subdir (str) – The subdirectory for the step.
stress_step (polaris.Step) – The step that produces the JRA55-do wind-stress product.
cull_mesh_step (polaris.tasks.e3sm.init.topo.cull.cull.CullMeshStep) – The step that produces the culled ocean mesh files.
mesh_name (str) – Name label for the MPAS mesh (used in the remapping weight filename).
Methods
__init__(component, subdir, stress_step, ...)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)Update ntasks from cell-count estimate before constraining.
process_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()Set up the source and destination grids, then build the mapping file.
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 and compute ntasks from the estimated mesh size.
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
coresthe number of cores this step needs, in total
gpusthe number of GPUs this step needs, in total
may_span_nodeswhether this step's cores and GPUs may come from several nodes
min_coresthe number of cores this step needs in order to run at all
min_gpusthe number of GPUs this step requires, in total