mom_diag_remap mom_diag_remap::diag_remap_ctrl subroutine, public subroutine, public mom_diag_remap::diag_remap_init (remap_cs, coord_tuple, answers_2018) diag_remap_init remap_cs remap_cs coord_tuple coord_tuple answers_2018 answers_2018 Initialize a diagnostic remapping type with the given vertical coordinate. remap_cs Diag remapping control structure coord_tuple A string in form of MODULE_SUFFIX PARAMETER_SUFFIX COORDINATE_NAME answers_2018 If true, use the order of arithmetic and expressions for remapping that recover the answers from the end of 2018. Otherwise, use more robust forms of the same expressions. regrid_consts::coordinatemode mom_string_functions::extractword subroutine, public subroutine, public mom_diag_remap::diag_remap_end (remap_cs) diag_remap_end remap_cs remap_cs De-init a diagnostic remapping type. Free allocated memory. remap_cs Diag remapping control structure diag_remap_diag_registration_closed subroutine, public subroutine, public mom_diag_remap::diag_remap_diag_registration_closed (remap_cs) diag_remap_diag_registration_closed remap_cs remap_cs Inform that all diagnostics have been registered. If _set_active() has not been called on the remapping control structure will be disabled. This saves time in the case that a vertical coordinate was configured but no diagnostics which use the coordinate appeared in the diag_table. remap_cs Diag remapping control structure diag_remap_end subroutine, public subroutine, public mom_diag_remap::diag_remap_set_active (remap_cs) diag_remap_set_active remap_cs remap_cs Indicate that this remapping type is actually used by the diag manager. If this is never called then the type will be disabled to save time. See further explanation with diag_remap_registration_closed. remap_cs Diag remapping control structure subroutine, public subroutine, public mom_diag_remap::diag_remap_configure_axes (remap_cs, GV, US, param_file) diag_remap_configure_axes remap_cs remap_cs GV GV US US param_file param_file Configure the vertical axes for a diagnostic remapping control structure. Reads a configuration parameters to determine coordinate generation. remap_cs Diag remap control structure gv ocean vertical grid structure us A dimensional unit scaling type param_file Parameter file structure regrid_consts::coordinatemode mom_string_functions::lowercase subroutine, public subroutine, public mom_diag_remap::diag_remap_get_axes_info (remap_cs, nz, id_layer, id_interface) diag_remap_get_axes_info remap_cs remap_cs nz nz id_layer id_layer id_interface id_interface Get layer and interface axes ids for this coordinate Needed when defining axes groups. remap_cs Diagnostic coordinate control structure nz Number of vertical levels for the coordinate id_layer 1D-axes id for layer points id_interface 1D-axes id for interface points logical function, public logical function, public mom_diag_remap::diag_remap_axes_configured (remap_cs) diag_remap_axes_configured remap_cs remap_cs Whether or not the axes for this vertical coordinated has been configured. Configuration is complete when diag_remap_configure_axes() has been successfully called. remap_cs Diagnostic coordinate control structure subroutine, public subroutine, public mom_diag_remap::diag_remap_update (remap_cs, G, GV, US, h, T, S, eqn_of_state, h_target) diag_remap_update remap_cs remap_cs G G GV GV US US h h T T S S eqn_of_state eqn_of_state h_target h_target Build/update target vertical grids for diagnostic remapping. The target grids need to be updated whenever sea surface height or layer thicknesses changes. In the case of density-based coordinates then technically we should also regenerate the target grid whenever T/S change. remap_cs Diagnostic coordinate control structure g The ocean's grid type gv ocean vertical grid structure us A dimensional unit scaling type h New thickness [H ~> m or kg m-2] t New temperatures [degC] s New salinities [ppt] eqn_of_state A pointer to the equation of state h_target The new diagnostic thicknesses [H ~> m or kg m-2] coord_rho::build_rho_column coord_sigma::build_sigma_column coord_zlike::build_zstar_column regrid_consts::coordinatemode mom_regridding::get_rho_cs mom_regridding::get_sigma_cs mom_regridding::get_zlike_cs mom_error_handler::mom_error subroutine, public subroutine, public mom_diag_remap::diag_remap_do_remap (remap_cs, G, GV, h, staggered_in_x, staggered_in_y, mask, field, remapped_field) diag_remap_do_remap remap_cs remap_cs G G GV GV h h staggered_in_x staggered_in_x staggered_in_y staggered_in_y mask mask field field remapped_field remapped_field Remap diagnostic field to alternative vertical grid. remap_cs Diagnostic coodinate control structure g Ocean grid structure gv ocean vertical grid structure h The current thicknesses [H ~> m or kg m-2] staggered_in_x True is the x-axis location is at u or q points staggered_in_y True is the y-axis location is at v or q points mask A mask for the field [nondim] field The diagnostic field to be remapped [A] remapped_field Field remapped to new coordinate [A] mom_error_handler::assert mom_remapping::remapping_core_h subroutine, public subroutine, public mom_diag_remap::diag_remap_calc_hmask (remap_cs, G, mask) diag_remap_calc_hmask remap_cs remap_cs G G mask mask Calculate masks for target grid. remap_cs Diagnostic coodinate control structure g Ocean grid structure mask h-point mask for target grid [nondim] mom_error_handler::assert regrid_consts::coordinatemode subroutine, public subroutine, public mom_diag_remap::vertically_reintegrate_diag_field (remap_cs, G, h, h_target, staggered_in_x, staggered_in_y, mask, field, reintegrated_field) vertically_reintegrate_diag_field remap_cs remap_cs G G h h h_target h_target staggered_in_x staggered_in_x staggered_in_y staggered_in_y mask mask field field reintegrated_field reintegrated_field Vertically re-grid an already vertically-integrated diagnostic field to alternative vertical grid. remap_cs Diagnostic coodinate control structure g Ocean grid structure h The thicknesses of the source grid [H ~> m or kg m-2] h_target The thicknesses of the target grid [H ~> m or kg m-2] staggered_in_x True is the x-axis location is at u or q points staggered_in_y True is the y-axis location is at v or q points mask A mask for the field [nondim] field The diagnostic field to be remapped [A] reintegrated_field Field argument remapped to alternative coordinate [A] mom_error_handler::assert mom_diag_vkernels::reintegrate_column subroutine, public subroutine, public mom_diag_remap::vertically_interpolate_diag_field (remap_cs, G, h, staggered_in_x, staggered_in_y, mask, field, interpolated_field) vertically_interpolate_diag_field remap_cs remap_cs G G h h staggered_in_x staggered_in_x staggered_in_y staggered_in_y mask mask field field interpolated_field interpolated_field Vertically interpolate diagnostic field to alternative vertical grid. remap_cs Diagnostic coodinate control structure g Ocean grid structure h The current thicknesses [H ~> m or kg m-2] staggered_in_x True is the x-axis location is at u or q points staggered_in_y True is the y-axis location is at v or q points mask A mask for the field [nondim] field The diagnostic field to be remapped [A] interpolated_field Field argument remapped to alternative coordinate [A] mom_error_handler::assert mom_diag_vkernels::interpolate_column subroutine, public subroutine, public mom_diag_remap::horizontally_average_diag_field (G, GV, h, staggered_in_x, staggered_in_y, is_layer, is_extensive, field, averaged_field, averaged_mask) horizontally_average_diag_field G G GV GV h h staggered_in_x staggered_in_x staggered_in_y staggered_in_y is_layer is_layer is_extensive is_extensive field field averaged_field averaged_field averaged_mask averaged_mask Horizontally average field. g Ocean grid structure gv The ocean vertical grid structure h The current thicknesses [H ~> m or kg m-2] staggered_in_x True if the x-axis location is at u or q points staggered_in_y True if the y-axis location is at v or q points is_layer True if the z-axis location is at h points is_extensive True if the z-direction is spatially integrated (over layers) field The diagnostic field to be remapped [A] averaged_field Field argument horizontally averaged [A] averaged_mask Mask for horizontally averaged field [nondim] mom_error_handler::assert mom_diag_mediator::post_xy_average provides runtime remapping of diagnostics to z star, sigma and rho vertical coordinates. The diag_remap_ctrl type represents a remapping of diagnostics to a particular vertical coordinate. The module is used by the diag mediator module in the following way: diag_remap_init() is called to initialize a diag_remap_ctrl instance.diag_remap_configure_axes() is called to read the configuration file and set up the vertical coordinate / axes definitions.diag_remap_get_axes_info() returns information needed for the diag mediator to define new axes for the remapped diagnostics.diag_remap_update() is called periodically (whenever h, T or S change) to either create or update the target remapping grids.diag_remap_do_remap() is called from within a diag post() to do the remapping before the diagnostic is written out.