mom_diag_mediator mom_diag_mediator::axes_grp mom_diag_mediator::diag_ctrl mom_diag_mediator::diag_dsamp mom_diag_mediator::diag_grid_storage mom_diag_mediator::diag_grids_type mom_diag_mediator::diag_type mom_diag_mediator::diagcs_dsamp mom_diag_mediator::downsample_diag_field mom_diag_mediator::downsample_field mom_diag_mediator::downsample_mask mom_diag_mediator::post_data integer integer mom_diag_mediator::id_clock_diag_mediator id_clock_diag_mediator CPU clocks. diag_mediator_init post_data_0d post_data_1d_k post_data_2d post_data_3d integer integer mom_diag_mediator::id_clock_diag_remap id_clock_diag_remap CPU clocks. diag_mediator_init post_data_3d integer integer mom_diag_mediator::id_clock_diag_grid_updates id_clock_diag_grid_updates CPU clocks. diag_mediator_init diag_update_remap_grids integer integer mom_diag_mediator::psp psp =121 x:point,y:sum,z:point downsample_field_2d integer integer mom_diag_mediator::pss pss =122 x:point,y:sum,z:point downsample_field_3d integer integer mom_diag_mediator::psm psm =123 x:point,y:sum,z:mean integer integer mom_diag_mediator::pmp pmp =131 x:point,y:mean,z:point downsample_field_2d integer integer mom_diag_mediator::pmm pmm =133 x:point,y:mean,z:mean downsample_field_3d integer integer mom_diag_mediator::spp spp =211 x:sum,y:point,z:point downsample_field_2d integer integer mom_diag_mediator::sps sps =212 x:sum,y:point,z:sum downsample_field_3d integer integer mom_diag_mediator::ssp ssp =221 x:sum;y:sum,z:point downsample_field_2d integer integer mom_diag_mediator::mpp mpp =311 x:mean,y:point,z:point downsample_field_2d integer integer mom_diag_mediator::mpm mpm =313 x:mean,y:point,z:mean downsample_field_3d integer integer mom_diag_mediator::mmp mmp =331 x:mean,y:mean,z:point downsample_field_2d downsample_field_3d integer integer mom_diag_mediator::mms mms =332 x:mean,y:mean,z:sum downsample_field_3d integer integer mom_diag_mediator::sss sss =222 x:sum,y:sum,z:sum downsample_field_3d integer integer mom_diag_mediator::mmm mmm =333 x:mean,y:mean,z:mean downsample_field_3d integer integer mom_diag_mediator::msk msk =-1 Use the downsample method of a mask. downsample_field_2d downsample_field_3d post_data_2d_low post_data_3d_low subroutine, public subroutine, public mom_diag_mediator::set_axes_info (G, GV, US, param_file, diag_cs, set_vertical) set_axes_info G G GV GV US US param_file param_file diag_cs diag_cs set_vertical set_vertical Sets up diagnostics axes. g Ocean grid structure gv ocean vertical grid structure us A dimensional unit scaling type param_file Parameter file structure diag_cs Diagnostics control structure set_vertical If true or missing, set up vertical axes define_axes_group diag_grid_storage_init set_axes_info_dsamp mom_oda_driver_mod::init_oda subroutine subroutine mom_diag_mediator::set_axes_info_dsamp (G, GV, param_file, diag_cs, id_zl_native, id_zi_native) set_axes_info_dsamp G G GV GV param_file param_file diag_cs diag_cs id_zl_native id_zl_native id_zi_native id_zi_native g Ocean grid structure gv ocean vertical grid structure param_file Parameter file structure diag_cs Diagnostics control structure id_zl_native ID of native layers id_zi_native ID of native interfaces define_axes_group_dsamp mom_error_handler::mom_error set_axes_info subroutine, public subroutine, public mom_diag_mediator::set_masks_for_axes (G, diag_cs) set_masks_for_axes G G diag_cs diag_cs set_masks_for_axes sets up the 2d and 3d masks for diagnostics using the current grid recorded after calling diag_update_remap_grids() g The ocean grid type. diag_cs A pointer to a type with many variables used for diagnostics mom_error_handler::assert set_masks_for_axes_dsamp subroutine subroutine mom_diag_mediator::set_masks_for_axes_dsamp (G, diag_cs) set_masks_for_axes_dsamp G G diag_cs diag_cs g The ocean grid type. diag_cs A pointer to a type with many variables used for diagnostics mom_error_handler::mom_error set_masks_for_axes subroutine, public subroutine, public mom_diag_mediator::diag_register_area_ids (diag_cs, id_area_t, id_area_q) diag_register_area_ids diag_cs diag_cs id_area_t id_area_t id_area_q id_area_q Attaches the id of cell areas to axes groups for use with cell_measures. diag_cs Diagnostics control structure id_area_t Diag_mediator id for area of h-cells id_area_q Diag_mediator id for area of q-cells subroutine, public subroutine, public mom_diag_mediator::register_cell_measure (G, diag, Time) register_cell_measure G G diag diag Time Time Sets a handle inside diagnostics mediator to associate 3d cell measures. g Ocean grid structure diag Regulates diagnostic output time Model time diag_associate_volume_cell_measure register_diag_field subroutine, public subroutine, public mom_diag_mediator::diag_associate_volume_cell_measure (diag_cs, id_h_volume) diag_associate_volume_cell_measure diag_cs diag_cs id_h_volume id_h_volume Attaches the id of cell volumes to axes groups for use with cell_measures. diag_cs Diagnostics control structure id_h_volume Diag_manager id for volume of h-cells register_cell_measure integer function, public integer function, public mom_diag_mediator::diag_get_volume_cell_measure_dm_id (diag_cs) diag_get_volume_cell_measure_dm_id diag_cs diag_cs Returns diag_manager id for cell measure of h-cells. diag_cs Diagnostics control structure subroutine, public subroutine, public mom_diag_mediator::define_axes_group (diag_cs, handles, axes, nz, vertical_coordinate_number, x_cell_method, y_cell_method, v_cell_method, is_h_point, is_q_point, is_u_point, is_v_point, is_layer, is_interface, is_native, needs_remapping, needs_interpolating, xyave_axes) define_axes_group diag_cs diag_cs handles handles axes axes nz nz vertical_coordinate_number vertical_coordinate_number x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method is_h_point is_h_point is_q_point is_q_point is_u_point is_u_point is_v_point is_v_point is_layer is_layer is_interface is_interface is_native is_native needs_remapping needs_remapping needs_interpolating needs_interpolating xyave_axes xyave_axes Defines a group of "axes" from list of handles. diag_cs Diagnostics control structure handles A list of 1D axis handles axes The group of 1D axes nz Number of layers in this diagnostic grid vertical_coordinate_number Index number for vertical coordinate x_cell_method A x-direction cell method used to construct the "cell_methods" attribute in CF convention y_cell_method A y-direction cell method used to construct the "cell_methods" attribute in CF convention v_cell_method A vertical direction cell method used to construct the "cell_methods" attribute in CF convention is_h_point If true, indicates this axes group for h-point located fields is_q_point If true, indicates this axes group for q-point located fields is_u_point If true, indicates this axes group for u-point located fields is_v_point If true, indicates this axes group for v-point located fields is_layer If true, indicates that this axes group is for a layer vertically-located field. is_interface If true, indicates that this axes group is for an interface vertically-located field. is_native If true, indicates that this axes group is for a native model grid. False for any other grid. needs_remapping If true, indicates that this axes group is for a intensive layer-located field that must be remapped to these axes. Used for rank>2. needs_interpolating If true, indicates that this axes group is for a sampled interface-located field that must be interpolated to these axes. Used for rank>2. xyave_axes The corresponding axes group for horizontally area-average diagnostics i2s mom_error_handler::mom_error mom_internal_tides::internal_tides_init set_axes_info subroutine subroutine mom_diag_mediator::define_axes_group_dsamp (diag_cs, handles, axes, dl, nz, vertical_coordinate_number, x_cell_method, y_cell_method, v_cell_method, is_h_point, is_q_point, is_u_point, is_v_point, is_layer, is_interface, is_native, needs_remapping, needs_interpolating, xyave_axes) define_axes_group_dsamp diag_cs diag_cs handles handles axes axes dl dl nz nz vertical_coordinate_number vertical_coordinate_number x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method is_h_point is_h_point is_q_point is_q_point is_u_point is_u_point is_v_point is_v_point is_layer is_layer is_interface is_interface is_native is_native needs_remapping needs_remapping needs_interpolating needs_interpolating xyave_axes xyave_axes Defines a group of downsampled "axes" from list of handles. diag_cs Diagnostics control structure handles A list of 1D axis handles axes The group of 1D axes dl Downsample level nz Number of layers in this diagnostic grid vertical_coordinate_number Index number for vertical coordinate x_cell_method A x-direction cell method used to construct the "cell_methods" attribute in CF convention y_cell_method A y-direction cell method used to construct the "cell_methods" attribute in CF convention v_cell_method A vertical direction cell method used to construct the "cell_methods" attribute in CF convention is_h_point If true, indicates this axes group for h-point located fields is_q_point If true, indicates this axes group for q-point located fields is_u_point If true, indicates this axes group for u-point located fields is_v_point If true, indicates this axes group for v-point located fields is_layer If true, indicates that this axes group is for a layer vertically-located field. is_interface If true, indicates that this axes group is for an interface vertically-located field. is_native If true, indicates that this axes group is for a native model grid. False for any other grid. needs_remapping If true, indicates that this axes group is for a intensive layer-located field that must be remapped to these axes. Used for rank>2. needs_interpolating If true, indicates that this axes group is for a sampled interface-located field that must be interpolated to these axes. Used for rank>2. xyave_axes The corresponding axes group for horizontally area-average diagnostics i2s mom_error_handler::mom_error set_axes_info_dsamp subroutine, public subroutine, public mom_diag_mediator::set_diag_mediator_grid (G, diag_cs) set_diag_mediator_grid G G diag_cs diag_cs Set up the array extents for doing diagnostics. g The ocean's grid structure diag_cs Structure used to regulate diagnostic output subroutine subroutine mom_diag_mediator::post_data_0d (diag_field_id, field, diag_cs, is_static) post_data_0d diag_field_id diag_field_id field field diag_cs diag_cs is_static is_static Make a real scalar diagnostic available for averaging or output. diag_field_id The id for an output variable returned by a previous call to register_diag_field. field real value being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mom_error_handler::assert id_clock_diag_mediator subroutine, public subroutine, public mom_diag_mediator::post_data_1d_k (diag_field_id, field, diag_cs, is_static) post_data_1d_k diag_field_id diag_field_id field field diag_cs diag_cs is_static is_static Make a real 1-d array diagnostic available for averaging or output. diag_field_id The id for an output variable returned by a previous call to register_diag_field. field 1-d array being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mom_error_handler::assert id_clock_diag_mediator subroutine subroutine mom_diag_mediator::post_data_2d (diag_field_id, field, diag_cs, is_static, mask) post_data_2d diag_field_id diag_field_id field field diag_cs diag_cs is_static is_static mask mask Make a real 2-d array diagnostic available for averaging or output. diag_field_id The id for an output variable returned by a previous call to register_diag_field. field 2-d array being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mask If present, use this real array as the data mask. mom_error_handler::assert id_clock_diag_mediator post_data_2d_low subroutine subroutine mom_diag_mediator::post_data_2d_low (diag, field, diag_cs, is_static, mask) post_data_2d_low diag diag field field diag_cs diag_cs is_static is_static mask mask Make a real 2-d array diagnostic available for averaging or output using a diag_type instead of an integer id. diag A structure describing the diagnostic to post field 2-d array being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mask If present, use this real array as the data mask. mom_error_handler::assert downsample_field_2d mom_error_handler::mom_error msk post_data_2d subroutine subroutine mom_diag_mediator::post_data_3d (diag_field_id, field, diag_cs, is_static, mask, alt_h) post_data_3d diag_field_id diag_field_id field field diag_cs diag_cs is_static is_static mask mask alt_h alt_h Make a real 3-d array diagnostic available for averaging or output. diag_field_id The id for an output variable returned by a previous call to register_diag_field. field 3-d array being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mask If present, use this real array as the data mask. alt_h An alternate thickness to use for vertically mom_error_handler::assert id_clock_diag_mediator id_clock_diag_remap mom_error_handler::mom_error post_data_3d_low subroutine subroutine mom_diag_mediator::post_data_3d_low (diag, field, diag_cs, is_static, mask) post_data_3d_low diag diag field field diag_cs diag_cs is_static is_static mask mask Make a real 3-d array diagnostic available for averaging or output using a diag_type instead of an integer id. diag A structure describing the diagnostic to post field 3-d array being offered for output or averaging diag_cs Structure used to regulate diagnostic output is_static If true, this is a static field that is always offered. mask If present, use this real array as the data mask. mom_error_handler::assert downsample_field_3d mom_error_handler::mom_error msk post_xy_average post_data_3d subroutine subroutine mom_diag_mediator::post_xy_average (diag_cs, diag, field) post_xy_average diag_cs diag_cs diag diag field field Post the horizontally area-averaged diagnostic. diag This diagnostic field Diagnostic field diag_cs Diagnostics mediator control structure mom_error_handler::assert mom_diag_remap::horizontally_average_diag_field post_data_3d_low subroutine, public subroutine, public mom_diag_mediator::enable_averaging (time_int_in, time_end_in, diag_cs) enable_averaging time_int_in time_int_in time_end_in time_end_in diag_cs diag_cs This subroutine enables the accumulation of time averages over the specified time interval. time_int_in The time interval [s] over which any values that are offered are valid. time_end_in The end time of the valid interval diag_cs Structure used to regulate diagnostic output mom_barotropic::btstep mom_forcing_type::mech_forcing_diags mom_main mom_ice_shelf::shelf_calc_flux subroutine, public subroutine, public mom_diag_mediator::enable_averages (time_int, time_end, diag_CS, T_to_s) enable_averages time_int time_int time_end time_end diag_CS diag_CS T_to_s T_to_s Enable the accumulation of time averages over the specified time interval in time units. time_int The time interval over which any values that are offered are valid [T ~> s]. time_end The end time of the valid interval. diag_cs A structure that is used to regulate diagnostic output t_to_s A conversion factor for time_int to [s]. mom_forcing_type::forcing_diagnostics mom_ice_shelf::solo_step_ice_shelf mom_ice_shelf_dynamics::update_ice_shelf subroutine, public subroutine, public mom_diag_mediator::disable_averaging (diag_cs) disable_averaging diag_cs diag_cs Call this subroutine to avoid averaging any offered fields. diag_cs Structure used to regulate diagnostic output mom_forcing_type::forcing_diagnostics mom_forcing_type::mech_forcing_diags mom_main mom_ice_shelf::shelf_calc_flux mom_ice_shelf::solo_step_ice_shelf mom_ice_shelf_dynamics::update_ice_shelf logical function, public logical function, public mom_diag_mediator::query_averaging_enabled (diag_cs, time_int, time_end) query_averaging_enabled diag_cs diag_cs time_int time_int time_end time_end Call this subroutine to determine whether the averaging is currently enabled. .true. is returned if it is. diag_cs Structure used to regulate diagnostic output time_int Current setting of diagtime_int [s] time_end Current setting of diagtime_end mom_lateral_mixing_coeffs::calc_resoln_function mom_lateral_mixing_coeffs::calc_slope_functions mom_lateral_mixing_coeffs::calc_visbeck_coeffs mom_opacity::set_opacity type(time_type) function, public type(time_type) function, public mom_diag_mediator::get_diag_time_end (diag_cs) get_diag_time_end diag_cs diag_cs This function returns the valid end time for use with diagnostics that are handled outside of the MOM6 diagnostics infrastructure. diag_cs Structure used to regulate diagnostic output mom_generic_tracer::mom_generic_tracer_column_physics mom_generic_tracer::mom_generic_tracer_surface_state integer function, public integer function, public mom_diag_mediator::register_diag_field (module_name, field_name, axes_in, init_time, long_name, units, missing_value, range, mask_variant, standard_name, verbose, do_not_log, err_msg, interp_method, tile_count, cmor_field_name, cmor_long_name, cmor_units, cmor_standard_name, cell_methods, x_cell_method, y_cell_method, v_cell_method, conversion, v_extensive) register_diag_field module_name module_name field_name field_name axes_in axes_in init_time init_time long_name long_name units units missing_value missing_value range range mask_variant mask_variant standard_name standard_name verbose verbose do_not_log do_not_log err_msg err_msg interp_method interp_method tile_count tile_count cmor_field_name cmor_field_name cmor_long_name cmor_long_name cmor_units cmor_units cmor_standard_name cmor_standard_name cell_methods cell_methods x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method conversion conversion v_extensive v_extensive Returns the "diag_mediator" handle for a group (native, CMOR, z-coord, ...) of diagnostics derived from one field. module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of the diagnostic field axes_in Container w/ up to 3 integer handles that indicates axes for this field init_time Time at which a field is first available? long_name Long name of a field. units Units of a field. standard_name Standardized name associated with a field missing_value A value that indicates missing values. range Valid range of a variable (not used in MOM?) mask_variant If true a logical mask must be provided with post_data calls (not used in MOM?) verbose If true, FMS is verbose (not used in MOM?) do_not_log If true, do not log something (not used in MOM?) err_msg String into which an error message might be placed (not used in MOM?) interp_method If 'none' indicates the field should not be interpolated as a scalar tile_count no clue (not used in MOM?) cmor_field_name CMOR name of a field cmor_long_name CMOR long name of a field cmor_units CMOR units of a field cmor_standard_name CMOR standardized name associated with a field cell_methods String to append as cell_methods attribute. Use '' to have no attribute. If present, this overrides the default constructed from the default for each individual axis direction. x_cell_method Specifies the cell method for the x-direction. Use '' have no method. y_cell_method Specifies the cell method for the y-direction. Use '' have no method. v_cell_method Specifies the cell method for the vertical direction. Use '' have no method. conversion A value to multiply data by before writing to file v_extensive True for vertically extensive fields (vertically integrated). Default/absent for intensive. mom_error_handler::mom_error register_diag_field_expand_cmor mom_coriolisadv::coriolisadv_init mom_diapyc_energy_req::diapyc_energy_req_init mom_int_tide_input::int_tide_input_init mom_cvmix_kpp::kpp_init ocean_register_diag mom_opacity::opacity_init register_cell_measure mom_offline_main::register_diags_offline_transport mom_set_diffusivity::set_diffusivity_init mom_tracer_hor_diff::tracer_hor_diff_init logical function logical function mom_diag_mediator::register_diag_field_expand_cmor (dm_id, module_name, field_name, axes, init_time, long_name, units, missing_value, range, mask_variant, standard_name, verbose, do_not_log, err_msg, interp_method, tile_count, cmor_field_name, cmor_long_name, cmor_units, cmor_standard_name, cell_methods, x_cell_method, y_cell_method, v_cell_method, conversion, v_extensive) register_diag_field_expand_cmor dm_id dm_id module_name module_name field_name field_name axes axes init_time init_time long_name long_name units units missing_value missing_value range range mask_variant mask_variant standard_name standard_name verbose verbose do_not_log do_not_log err_msg err_msg interp_method interp_method tile_count tile_count cmor_field_name cmor_field_name cmor_long_name cmor_long_name cmor_units cmor_units cmor_standard_name cmor_standard_name cell_methods cell_methods x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method conversion conversion v_extensive v_extensive Returns True if either the native or CMOr version of the diagnostic were registered. Updates 'dm_id' after calling register_diag_field_expand_axes() for both native and CMOR variants of the field. dm_id The diag_mediator ID for this diagnostic group module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of the diagnostic field axes Container w/ up to 3 integer handles that indicates axes for this field init_time Time at which a field is first available? long_name Long name of a field. units Units of a field. standard_name Standardized name associated with a field missing_value A value that indicates missing values. range Valid range of a variable (not used in MOM?) mask_variant If true a logical mask must be provided with post_data calls (not used in MOM?) verbose If true, FMS is verbose (not used in MOM?) do_not_log If true, do not log something (not used in MOM?) err_msg String into which an error message might be placed (not used in MOM?) interp_method If 'none' indicates the field should not be interpolated as a scalar tile_count no clue (not used in MOM?) cmor_field_name CMOR name of a field cmor_long_name CMOR long name of a field cmor_units CMOR units of a field cmor_standard_name CMOR standardized name associated with a field cell_methods String to append as cell_methods attribute. Use '' to have no attribute. If present, this overrides the default constructed from the default for each individual axis direction. x_cell_method Specifies the cell method for the x-direction. Use '' have no method. y_cell_method Specifies the cell method for the y-direction. Use '' have no method. v_cell_method Specifies the cell method for the vertical direction. Use '' have no method. conversion A value to multiply data by before writing to file v_extensive True for vertically extensive fields (vertically integrated). Default/absent for intensive. add_diag_to_list add_xyz_method attach_cell_methods mom_error_handler::is_root_pe log_available_diag register_diag_field_expand_axes register_diag_field integer function integer function mom_diag_mediator::register_diag_field_expand_axes (module_name, field_name, axes, init_time, long_name, units, missing_value, range, mask_variant, standard_name, verbose, do_not_log, err_msg, interp_method, tile_count) register_diag_field_expand_axes module_name module_name field_name field_name axes axes init_time init_time long_name long_name units units missing_value missing_value range range mask_variant mask_variant standard_name standard_name verbose verbose do_not_log do_not_log err_msg err_msg interp_method interp_method tile_count tile_count Returns an FMS id from register_diag_field_fms (the diag_manager routine) after expanding axes (axes-group) into handles and conditionally adding an FMS area_id for cell_measures. module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of the diagnostic field axes Container w/ up to 3 integer handles that indicates axes for this field init_time Time at which a field is first available? long_name Long name of a field. units Units of a field. standard_name Standardized name associated with a field missing_value A value that indicates missing values. range Valid range of a variable (not used in MOM?) mask_variant If true a logical mask must be provided with post_data calls (not used in MOM?) verbose If true, FMS is verbose (not used in MOM?) do_not_log If true, do not log something (not used in MOM?) err_msg String into which an error message might be placed (not used in MOM?) interp_method If 'none' indicates the field should not be interpolated as a scalar tile_count no clue (not used in MOM?) register_diag_field_expand_cmor subroutine subroutine mom_diag_mediator::add_diag_to_list (diag_cs, dm_id, fms_id, this_diag, axes, module_name, field_name, msg) add_diag_to_list diag_cs diag_cs dm_id dm_id fms_id fms_id this_diag this_diag axes axes module_name module_name field_name field_name msg msg Create a diagnostic type and attached to list. diag_cs Diagnostics mediator control structure dm_id The diag_mediator ID for this diagnostic group fms_id The FMS diag_manager ID for this diagnostic this_diag This diagnostic axes Container w/ up to 3 integer handles that indicates axes for this field module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of diagnostic msg Message for errors alloc_diag_with_id mom_error_handler::assert get_new_diag_id register_diag_field_expand_cmor subroutine subroutine mom_diag_mediator::add_xyz_method (diag, axes, x_cell_method, y_cell_method, v_cell_method, v_extensive) add_xyz_method diag diag axes axes x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method v_extensive v_extensive Adds the encoded "cell_methods" for a diagnostics as a diag% property This allows access to the cell_method for a given diagnostics at the time of sending. diag This diagnostic axes Container w/ up to 3 integer handles that indicates axes for this field x_cell_method Specifies the cell method for the x-direction. Use '' have no method. y_cell_method Specifies the cell method for the y-direction. Use '' have no method. v_cell_method Specifies the cell method for the vertical direction. Use '' have no method. v_extensive True for vertically extensive fields (vertically integrated). Default/absent for intensive. mom_error_handler::mom_error register_diag_field_expand_cmor subroutine subroutine mom_diag_mediator::attach_cell_methods (id, axes, ostring, cell_methods, x_cell_method, y_cell_method, v_cell_method, v_extensive) attach_cell_methods id id axes axes ostring ostring cell_methods cell_methods x_cell_method x_cell_method y_cell_method y_cell_method v_cell_method v_cell_method v_extensive v_extensive Attaches "cell_methods" attribute to a variable based on defaults for axes_grp or optional arguments. id Handle to diagnostic axes Container w/ up to 3 integer handles that indicates axes for this field ostring The cell_methods strings that would appear in the file cell_methods String to append as cell_methods attribute. Use '' to have no attribute. If present, this overrides the default constructed from the default for each individual axis direction. x_cell_method Specifies the cell method for the x-direction. Use '' have no method. y_cell_method Specifies the cell method for the y-direction. Use '' have no method. v_cell_method Specifies the cell method for the vertical direction. Use '' have no method. v_extensive True for vertically extensive fields (vertically integrated). Default/absent for intensive. mom_error_handler::mom_error register_diag_field_expand_cmor integer function, public integer function, public mom_diag_mediator::register_scalar_field (module_name, field_name, init_time, diag_cs, long_name, units, missing_value, range, standard_name, do_not_log, err_msg, interp_method, cmor_field_name, cmor_long_name, cmor_units, cmor_standard_name) register_scalar_field module_name module_name field_name field_name init_time init_time diag_cs diag_cs long_name long_name units units missing_value missing_value range range standard_name standard_name do_not_log do_not_log err_msg err_msg interp_method interp_method cmor_field_name cmor_field_name cmor_long_name cmor_long_name cmor_units cmor_units cmor_standard_name cmor_standard_name An integer handle for a diagnostic array. module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of the diagnostic field init_time Time at which a field is first available? diag_cs Structure used to regulate diagnostic output long_name Long name of a field. units Units of a field. standard_name Standardized name associated with a field missing_value A value that indicates missing values. range Valid range of a variable (not used in MOM?) do_not_log If true, do not log something (not used in MOM?) err_msg String into which an error message might be placed (not used in MOM?) interp_method If 'none' indicates the field should not be interpolated as a scalar cmor_field_name CMOR name of a field cmor_long_name CMOR long name of a field cmor_units CMOR units of a field cmor_standard_name CMOR standardized name associated with a field alloc_diag_with_id mom_error_handler::assert get_new_diag_id mom_error_handler::is_root_pe log_available_diag integer function, public integer function, public mom_diag_mediator::register_static_field (module_name, field_name, axes, long_name, units, missing_value, range, mask_variant, standard_name, do_not_log, interp_method, tile_count, cmor_field_name, cmor_long_name, cmor_units, cmor_standard_name, area, x_cell_method, y_cell_method, area_cell_method, conversion) register_static_field module_name module_name field_name field_name axes axes long_name long_name units units missing_value missing_value range range mask_variant mask_variant standard_name standard_name do_not_log do_not_log interp_method interp_method tile_count tile_count cmor_field_name cmor_field_name cmor_long_name cmor_long_name cmor_units cmor_units cmor_standard_name cmor_standard_name area area x_cell_method x_cell_method y_cell_method y_cell_method area_cell_method area_cell_method conversion conversion Registers a static diagnostic, returning an integer handle. An integer handle for a diagnostic array. module_name Name of this module, usually "ocean_model" or "ice_shelf_model" field_name Name of the diagnostic field axes Container w/ up to 3 integer handles that indicates axes for this field long_name Long name of a field. units Units of a field. standard_name Standardized name associated with a field missing_value A value that indicates missing values. range Valid range of a variable (not used in MOM?) mask_variant If true a logical mask must be provided with post_data calls (not used in MOM?) do_not_log If true, do not log something (not used in MOM?) interp_method If 'none' indicates the field should not be interpolated as a scalar tile_count no clue (not used in MOM?) cmor_field_name CMOR name of a field cmor_long_name CMOR long name of a field cmor_units CMOR units of a field cmor_standard_name CMOR standardized name associated with a field area fms_id for area_t x_cell_method Specifies the cell method for the x-direction. y_cell_method Specifies the cell method for the y-direction. area_cell_method Specifies the cell method for area conversion A value to multiply data by before writing to file alloc_diag_with_id mom_error_handler::assert get_new_diag_id mom_error_handler::is_root_pe log_available_diag mom_geothermal::geothermal_init subroutine subroutine mom_diag_mediator::describe_option (opt_name, value, diag_CS) describe_option opt_name opt_name value value diag_CS diag_CS Describe an option setting in the diagnostic files. opt_name The name of the option value A character string with the setting of the option. diag_cs Structure used to regulate diagnostic output log_available_diag integer function, public integer function, public mom_diag_mediator::ocean_register_diag (var_desc, G, diag_CS, day) ocean_register_diag var_desc var_desc G G diag_CS diag_CS day day Registers a diagnostic using the information encapsulated in the vardesc type argument and returns an integer handle to this diagostic. That integer handle is negative if the diagnostic is unused. An integer handle to this diagnostic. var_desc The vardesc type describing the diagnostic g The ocean's grid type diag_cs The diagnotic control structure day The current model time mom_error_handler::mom_error register_diag_field subroutine, public subroutine, public mom_diag_mediator::diag_mediator_infrastructure_init (err_msg) diag_mediator_infrastructure_init err_msg err_msg err_msg An error message subroutine, public subroutine, public mom_diag_mediator::diag_mediator_init (G, GV, US, nz, param_file, diag_cs, doc_file_dir) diag_mediator_init G G GV GV US US nz nz param_file param_file diag_cs diag_cs doc_file_dir doc_file_dir diag_mediator_init initializes the MOM diag_mediator and opens the available diagnostics file, if appropriate. g The ocean grid type. gv The ocean vertical grid structure us A dimensional unit scaling type nz The number of layers in the model's native grid. param_file Parameter file structure diag_cs A pointer to a type with many variables used for diagnostics doc_file_dir A directory in which to create the file id_clock_diag_grid_updates id_clock_diag_mediator id_clock_diag_remap initialize_diag_type mom_error_handler::is_root_pe mom_error_handler::mom_error subroutine, public subroutine, public mom_diag_mediator::diag_set_state_ptrs (h, T, S, eqn_of_state, diag_cs) diag_set_state_ptrs h h T T S S eqn_of_state eqn_of_state diag_cs diag_cs Set pointers to the default state fields used to remap diagnostics. h the model thickness array [H ~> m or kg m-2] t the model temperature array s the model salinity array eqn_of_state Equation of state structure diag_cs diag mediator control structure subroutine, public subroutine, public mom_diag_mediator::diag_update_remap_grids (diag_cs, alt_h, alt_T, alt_S, update_intensive, update_extensive) diag_update_remap_grids diag_cs diag_cs alt_h alt_h alt_T alt_T alt_S alt_S update_intensive update_intensive update_extensive update_extensive Build/update vertical grids for diagnostic remapping. The target grids need to be updated whenever sea surface height changes. diag_cs Diagnostics control structure alt_h Used if remapped grids should be something other than the current thicknesses [H ~> m or kg m-2] alt_t Used if remapped grids should be something other than the current temperatures alt_s Used if remapped grids should be something other than the current salinity update_intensive If true (default), update the grids used for intensive diagnostics update_extensive If true (not default), update the grids used for intensive diagnostics id_clock_diag_grid_updates mom_error_handler::mom_error mom_ale::ale_main mom_bulk_mixed_layer::bulkmixedlayer mom_mixed_layer_restrat::mixedlayer_restrat_bml mom_mixed_layer_restrat::mixedlayer_restrat_general mom_dynamics_split_rk2::step_mom_dyn_split_rk2 mom_dynamics_unsplit::step_mom_dyn_unsplit mom_thickness_diffuse::thickness_diffuse subroutine, public subroutine, public mom_diag_mediator::diag_masks_set (G, nz, diag_cs) diag_masks_set G G nz nz diag_cs diag_cs Sets up the 2d and 3d masks for native diagnostics. g The ocean grid type. nz The number of layers in the model's native grid. diag_cs A pointer to a type with many variables used for diagnostics downsample_diag_masks_set subroutine, public subroutine, public mom_diag_mediator::diag_mediator_close_registration (diag_CS) diag_mediator_close_registration diag_CS diag_CS diag_cs Structure used to regulate diagnostic output mom_main ocean_model_mod::ocean_model_init subroutine, public subroutine, public mom_diag_mediator::diag_mediator_end (time, diag_CS, end_diag_manager) diag_mediator_end time time diag_CS diag_CS end_diag_manager end_diag_manager time The current model time diag_cs Structure used to regulate diagnostic output end_diag_manager If true, call diag_manager_end() diag_grid_storage_end mom_main ocean_model_mod::ocean_model_end character(len=15) function character(len=15) function mom_diag_mediator::i2s (a, n_in) i2s a a n_in n_in Convert the first n elements (up to 3) of an integer array to an underscore delimited string. a The array of integers to translate n_in The number of elements to translate, by default all The returned string define_axes_group define_axes_group_dsamp integer function integer function mom_diag_mediator::get_new_diag_id (diag_cs) get_new_diag_id diag_cs diag_cs Returns a new diagnostic id, it may be necessary to expand the diagnostics array. diag_cs Diagnostics control structure mom_error_handler::assert initialize_diag_type add_diag_to_list register_scalar_field register_static_field subroutine subroutine mom_diag_mediator::initialize_diag_type (diag) initialize_diag_type diag diag Initializes a diag_type (used after allocating new memory) diag diag_type to be initialized diag_mediator_init get_new_diag_id subroutine subroutine mom_diag_mediator::alloc_diag_with_id (diag_id, diag_cs, diag) alloc_diag_with_id diag_id diag_id diag_cs diag_cs diag diag Make a new diagnostic. Either use memory which is in the array of 'primary' diagnostics, or if that is in use, insert it to the list of secondary diags. diag_id id for the diagnostic diag_cs structure used to regulate diagnostic output diag structure representing a diagnostic (inout) add_diag_to_list register_scalar_field register_static_field subroutine subroutine mom_diag_mediator::log_available_diag (used, module_name, field_name, cell_methods_string, comment, diag_CS, long_name, units, standard_name) log_available_diag used used module_name module_name field_name field_name cell_methods_string cell_methods_string comment comment diag_CS diag_CS long_name long_name units units standard_name standard_name Log a diagnostic to the available diagnostics file. used Whether this diagnostic was in the diag_table or not module_name Name of the diagnostic module field_name Name of this diagnostic field cell_methods_string The spatial component of the CF cell_methods attribute comment A comment to append after [Used|Unused] diag_cs The diagnotics control structure long_name CF long name of diagnostic units Units for diagnostic standard_name CF standardized name of diagnostic describe_option register_diag_field_expand_cmor register_scalar_field register_static_field subroutine subroutine mom_diag_mediator::log_chksum_diag (docunit, description, chksum) log_chksum_diag docunit docunit description description chksum chksum Log the diagnostic chksum to the chksum diag file. docunit Handle of the log file description Name of the diagnostic module chksum chksum of the diagnostic subroutine, public subroutine, public mom_diag_mediator::diag_grid_storage_init (grid_storage, G, diag) diag_grid_storage_init grid_storage grid_storage G G diag diag Allocates fields necessary to store diagnostic remapping fields. grid_storage Structure containing a snapshot of the target grids g Horizontal grid diag Diagnostic control structure used as the contructor template for this routine set_axes_info subroutine, public subroutine, public mom_diag_mediator::diag_copy_diag_to_storage (grid_storage, h_state, diag) diag_copy_diag_to_storage grid_storage grid_storage h_state h_state diag diag Copy from the main diagnostic arrays to the grid storage as well as the native thicknesses. grid_storage Structure containing a snapshot of the target grids h_state Current model thicknesses [H ~> m or kg m-2] diag Diagnostic control structure used as the contructor mom::initialize_mom mom::step_mom subroutine, public subroutine, public mom_diag_mediator::diag_copy_storage_to_diag (diag, grid_storage) diag_copy_storage_to_diag diag diag grid_storage grid_storage Copy from the stored diagnostic arrays to the main diagnostic grids. diag Diagnostic control structure used as the contructor grid_storage Structure containing a snapshot of the target grids mom_diagnostics::calculate_diagnostic_fields mom_tracer_registry::post_tracer_diagnostics_at_sync mom_diagnostics::post_transport_diagnostics subroutine, public subroutine, public mom_diag_mediator::diag_save_grids (diag) diag_save_grids diag diag Save the current diagnostic grids in the temporary structure within diag. diag Diagnostic control structure used as the contructor mom_diagnostics::calculate_diagnostic_fields mom_tracer_registry::post_tracer_diagnostics_at_sync mom_diagnostics::post_transport_diagnostics subroutine, public subroutine, public mom_diag_mediator::diag_restore_grids (diag) diag_restore_grids diag diag Restore the diagnostic grids from the temporary structure within diag. diag Diagnostic control structure used as the contructor mom_diagnostics::calculate_diagnostic_fields mom_tracer_registry::post_tracer_diagnostics_at_sync mom_diagnostics::post_transport_diagnostics subroutine, public subroutine, public mom_diag_mediator::diag_grid_storage_end (grid_storage) diag_grid_storage_end grid_storage grid_storage Deallocates the fields in the remapping fields container. grid_storage Structure containing a snapshot of the target grids diag_mediator_end subroutine subroutine mom_diag_mediator::downsample_diag_masks_set (G, nz, diag_cs) downsample_diag_masks_set G G nz nz diag_cs diag_cs g The ocean grid type. nz The number of layers in the model's native grid. diag_cs A pointer to a type with many variables used for diagnostics diag_masks_set subroutine subroutine mom_diag_mediator::downsample_diag_indices_get (fo1, fo2, dl, diag_cs, isv, iev, jsv, jev) downsample_diag_indices_get fo1 fo1 fo2 fo2 dl dl diag_cs diag_cs isv isv iev iev jsv jsv jev jev Get the diagnostics-compute indices (to be passed to send_data) based on the shape of the diag field (the same way they are deduced for non-downsampled fields) fo1 The size of the diag field in x fo2 The size of the diag field in y dl Integer downsample level diag_cs Structure used to regulate diagnostic output isv i-start index for diagnostics iev i-end index for diagnostics jsv j-start index for diagnostics jev j-end index for diagnostics mom_error_handler::mom_error downsample_diag_field_2d downsample_diag_field_3d subroutine subroutine mom_diag_mediator::downsample_diag_field_3d (locfield, locfield_dsamp, dl, diag_cs, diag, isv, iev, jsv, jev, mask) downsample_diag_field_3d locfield locfield locfield_dsamp locfield_dsamp dl dl diag_cs diag_cs diag diag isv isv iev iev jsv jsv jev jev mask mask This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 3d interface. locfield Input array pointer locfield_dsamp Output (downsampled) array diag_cs Structure used to regulate diagnostic output diag A structure describing the diagnostic to post dl Level of down sampling isv i-start index for diagnostics iev i-end index for diagnostics jsv j-start index for diagnostics jev j-end index for diagnostics mask If present, use this real array as the data mask. downsample_diag_indices_get mom_error_handler::mom_error subroutine subroutine mom_diag_mediator::downsample_diag_field_2d (locfield, locfield_dsamp, dl, diag_cs, diag, isv, iev, jsv, jev, mask) downsample_diag_field_2d locfield locfield locfield_dsamp locfield_dsamp dl dl diag_cs diag_cs diag diag isv isv iev iev jsv jsv jev jev mask mask This subroutine allocates and computes a downsampled array from an input array It also determines the diagnostics-compurte indices for the downsampled array 2d interface. locfield Input array pointer locfield_dsamp Output (downsampled) array diag_cs Structure used to regulate diagnostic output diag A structure describing the diagnostic to post dl Level of down sampling isv i-start index for diagnostics iev i-end index for diagnostics jsv j-start index for diagnostics jev j-end index for diagnostics mask If present, use this real array as the data mask. downsample_diag_indices_get mom_error_handler::mom_error subroutine subroutine mom_diag_mediator::downsample_field_3d (field_in, field_out, dl, method, mask, diag_cs, diag, isv_o, jsv_o, isv_d, iev_d, jsv_d, jev_d) downsample_field_3d field_in field_in field_out field_out dl dl method method mask mask diag_cs diag_cs diag diag isv_o isv_o jsv_o jsv_o isv_d isv_d iev_d iev_d jsv_d jsv_d jev_d jev_d This subroutine allocates and computes a down sampled 3d array given an input array The down sample method is based on the "cell_methods" for the diagnostics as explained in the above table. The down sample method could be deduced (before send_data call) from the diagx_cell_method, diagy_cell_method and diagv_cell_method This is the summary of the down sample algoritm for a diagnostic field f: \[ f(Id,Jd) = \sum_{i,j} f(Id+i,Jd+j) * weight(Id+i,Jd+j) / [ \sum_{i,j} weight(Id+i,Jd+j)] \] Here, i and j run from 0 to dl-1 (dl being the down sample level). Id,Jd are the down sampled (coarse grid) indices run over the coarsened compute grid, if and jf are the original (fine grid) indices. Example x_cell y_cell v_cell algorithm_id implemented weight(if,jf) --------------------------------------------------------------------------------------- theta mean mean mean MMM =222 G%areaT(if,jf)*h(if,jf) u point mean mean PMM =022 dyCu(if,jf)*h(if,jf)*delta(if,Id) v mean point mean MPM =202 dxCv(if,jf)*h(if,jf)*delta(jf,Jd) ? point sum mean PSM =012 h(if,jf)*delta(if,Id) volcello sum sum sum SSS =111 1 T_dfxy_co sum sum point SSP =110 1 umo point sum sum PSS =011 1*delta(if,Id) vmo sum point sum SPS =101 1*delta(jf,Jd) umo_2d point sum point PSP =010 1*delta(if,Id) vmo_2d sum point point SPP =100 1*delta(jf,Jd) ? point mean point PMP =020 dyCu(if,jf)*delta(if,Id) ? mean point point MPP =200 dxCv(if,jf)*delta(jf,Jd) w mean mean point MMP =220 G%areaT(if,jf) h*theta mean mean sum MMS =221 G%areaT(if,jf) delta is the Kronecker delta field_in Original field to be down sampled field_out down sampled field dl Level of down sampling method Sampling method mask Mask for field diag_cs Structure used to regulate diagnostic output diag A structure describing the diagnostic to post isv_o Original i-start index jsv_o Original j-start index isv_d i-start index of down sampled data iev_d i-end index of down sampled data jsv_d j-start index of down sampled data jev_d j-end index of down sampled data mmm mmp mms mom_error_handler::mom_error mpm msk pmm pss sps sss post_data_3d_low subroutine subroutine mom_diag_mediator::downsample_field_2d (field_in, field_out, dl, method, mask, diag_cs, diag, isv_o, jsv_o, isv_d, iev_d, jsv_d, jev_d) downsample_field_2d field_in field_in field_out field_out dl dl method method mask mask diag_cs diag_cs diag diag isv_o isv_o jsv_o jsv_o isv_d isv_d iev_d iev_d jsv_d jsv_d jev_d jev_d This subroutine allocates and computes a down sampled 2d array given an input array The down sample method is based on the "cell_methods" for the diagnostics as explained in the above table. field_in Original field to be down sampled field_out Down sampled field dl Level of down sampling method Sampling method mask Mask for field diag_cs Structure used to regulate diagnostic output diag A structure describing the diagnostic to post isv_o Original i-start index jsv_o Original j-start index isv_d i-start index of down sampled data iev_d i-end index of down sampled data jsv_d j-start index of down sampled data jev_d j-end index of down sampled data mmp mom_error_handler::mom_error mpp msk pmp psp spp ssp post_data_2d_low subroutine subroutine mom_diag_mediator::downsample_mask_2d (field_in, field_out, dl, isc_o, jsc_o, isc_d, iec_d, jsc_d, jec_d, isd_d, ied_d, jsd_d, jed_d) downsample_mask_2d field_in field_in field_out field_out dl dl isc_o isc_o jsc_o jsc_o isc_d isc_d iec_d iec_d jsc_d jsc_d jec_d jec_d isd_d isd_d ied_d ied_d jsd_d jsd_d jed_d jed_d Allocate and compute the 2d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0) field_in Original field to be down sampled field_out Down sampled field dl Level of down sampling isc_o Original i-start index jsc_o Original j-start index isc_d Computational i-start index of down sampled data iec_d Computational i-end index of down sampled data jsc_d Computational j-start index of down sampled data jec_d Computational j-end index of down sampled data isd_d Computational i-start index of down sampled data ied_d Computational i-end index of down sampled data jsd_d Computational j-start index of down sampled data jed_d Computational j-end index of down sampled data subroutine subroutine mom_diag_mediator::downsample_mask_3d (field_in, field_out, dl, isc_o, jsc_o, isc_d, iec_d, jsc_d, jec_d, isd_d, ied_d, jsd_d, jed_d) downsample_mask_3d field_in field_in field_out field_out dl dl isc_o isc_o jsc_o jsc_o isc_d isc_d iec_d iec_d jsc_d jsc_d jec_d jec_d isd_d isd_d ied_d ied_d jsd_d jsd_d jed_d jed_d Allocate and compute the 3d down sampled mask The masks are down sampled based on a minority rule, i.e., a coarse cell is open (1) if at least one of the sub-cells are open, otherwise it's closed (0) field_in Original field to be down sampled field_out down sampled field dl Level of down sampling isc_o Original i-start index jsc_o Original j-start index isc_d Computational i-start index of down sampled data iec_d Computational i-end index of down sampled data jsc_d Computational j-start index of down sampled data jec_d Computational j-end index of down sampled data isd_d Computational i-start index of down sampled data ied_d Computational i-end index of down sampled data jsd_d Computational j-start index of down sampled data jed_d Computational j-end index of down sampled data The subroutines here provide convenient wrappers to the fms diag_manager interfaces with additional diagnostic capabilies.