compass.ocean.tests.tides.init.calculate_wave_drag.CalculateWaveDrag

class compass.ocean.tests.tides.init.calculate_wave_drag.CalculateWaveDrag(test_case, mesh)[source]

A step for calculating wave drag information

Variables:

  • bathy_file (str) – File name for the blended RTopo/GEBCO pixel file

  • mesh_file (str) – File name for the culled mesh from the mesh test case

  • bouy_file (str) – File name for the WOA bouyancy data

  • output_file (str) – File name for the output file containing wave drag information

__init__(test_case, mesh)[source]

Create the step

Parameters:

test_case (compass.ocean.tests.tides.init.Init) –

The test case this step belongs to

meshcompass.ocean.tests.tides.mesh.Mesh

The test case the produces the mesh for this case

Methods

__init__(test_case, mesh)

Create the step

add_input_file([filename, target, database, ...])

Add an input file to the step (but not necessarily to the MPAS model).

add_model_as_input()

make a link to the model executable and add it to the inputs

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_namelist_options(options[, out_name, mode])

Add the namelist replacements to be parsed when generating a namelist file if and when the step gets set up.

add_output_file(filename)

Add the output file that must be produced by this step and may be made available as an input to steps, perhaps in other test cases.

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.

calc_stats(xlon_nn, ylat_nn, near, ...)

Calculate the mean bathymetry slopes/gradients and stadard deviation

constrain_resources(available_resources)

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

fix_nans(data, mesh_nc)

Replace NaN values with average of surrounding (non-NaN) values

interpolate_data_to_grid(grid_file, ...)

Interpolate a variable from a data file to an the MPAS grid

make_nn_lists(ylat_nn, xlon_nn, near, i, j)

Create the nearest neighbor lists

map_to_r3(xlon, ylat, head, tail)

Map lon-lat coordinates to XYZ points.

polyfit2d(X, Y, Z)

Calculate linear least squares fit for standard deviation calculation

process_inputs_and_outputs()

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

run()

Run the step to calculate wave drag information

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.

setup()

Set up the test case in the work directory, including downloading any dependencies.

update_namelist_at_runtime(options[, out_name])

Update an existing namelist file with additional options.

update_namelist_pio([out_name])

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

update_streams_at_runtime(package, streams, ...)

Update the streams files during the run phase of this step using the given template and replacements.