mom_spatial_means real function, public real function, public mom_spatial_means::global_area_mean (var, G, scale) global_area_mean var var G G scale scale Return the global area mean of a variable. This uses reproducing sums. g The ocean's grid structure var The variable to average scale A rescaling factor for the variable mom_forcing_type::forcing_diagnostics mom_generic_tracer::mom_generic_tracer_column_physics mom_generic_tracer::mom_generic_tracer_surface_state mom_internal_tides::sum_en real function, public real function, public mom_spatial_means::global_area_integral (var, G, scale, area) global_area_integral var var G G scale scale area area Return the global area integral of a variable, by default using the masked area from the grid, but an alternate could be used instead. This uses reproducing sums. g The ocean's grid structure var The variable to integrate scale A rescaling factor for the variable area The alternate area to use, including any required masking [L2 ~> m2]. The returned area integral, usually in the units of var times [m2]. mom_ice_shelf::add_shelf_flux mom_forcing_type::forcing_diagnostics mom_diagnostics::post_surface_thermo_diags real function, dimension(gv %ke), public real function, dimension( gv %ke), public mom_spatial_means::global_layer_mean (var, h, G, GV, scale) global_layer_mean var var h h G G GV GV scale scale Return the layerwise global thickness-weighted mean of a variable. This uses reproducing sums. g The ocean's grid structure gv The ocean's vertical grid structure var The variable to average h Layer thicknesses [H ~> m or kg m-2] scale A rescaling factor for the variable real function, public real function, public mom_spatial_means::global_volume_mean (var, h, G, GV, scale) global_volume_mean var var h h G G GV GV scale scale Find the global thickness-weighted mean of a variable. This uses reproducing sums. g The ocean's grid structure gv The ocean's vertical grid structure var The variable being averaged h Layer thicknesses [H ~> m or kg m-2] scale A rescaling factor for the variable The thickness-weighted average of var mom_diagnostics::calculate_diagnostic_fields real function, public real function, public mom_spatial_means::global_mass_integral (h, G, GV, var, on_PE_only, scale) global_mass_integral h h G G GV GV var var on_PE_only on_PE_only scale scale Find the global mass-weighted integral of a variable. This uses reproducing sums. g The ocean's grid structure gv The ocean's vertical grid structure h Layer thicknesses [H ~> m or kg m-2] var The variable being integrated on_pe_only If present and true, the sum is only done on the local PE, and it is not order invariant. scale A rescaling factor for the variable The mass-weighted integral of var (or 1) in kg times the units of var mom::get_ocean_stocks subroutine, public subroutine, public mom_spatial_means::global_i_mean (array, i_mean, G, mask, scale, tmp_scale) global_i_mean array array i_mean i_mean G G mask mask scale scale tmp_scale tmp_scale Determine the global mean of a field along rows of constant i, returning it in a 1-d array using the local indexing. This uses reproducing sums. g The ocean's grid structure array The variable being averaged i_mean Global mean of array along its i-axis mask An array used for weighting the i-mean scale A rescaling factor for the output variable tmp_scale A rescaling factor for the internal calculations that is removed from the output mom_error_handler::mom_error mom_coms::query_efp_overflow_error mom_coms::reset_efp_overflow_error mom_sponge::apply_sponge subroutine, public subroutine, public mom_spatial_means::global_j_mean (array, j_mean, G, mask, scale, tmp_scale) global_j_mean array array j_mean j_mean G G mask mask scale scale tmp_scale tmp_scale Determine the global mean of a field along rows of constant j, returning it in a 1-d array using the local indexing. This uses reproducing sums. g The ocean's grid structure array The variable being averaged j_mean Global mean of array along its j-axis mask An array used for weighting the j-mean scale A rescaling factor for the output variable tmp_scale A rescaling factor for the internal calculations that is removed from the output mom_error_handler::mom_error mom_coms::query_efp_overflow_error mom_coms::reset_efp_overflow_error subroutine, public subroutine, public mom_spatial_means::adjust_area_mean_to_zero (array, G, scaling, unit_scale) adjust_area_mean_to_zero array array G G scaling scaling unit_scale unit_scale Adjust 2d array such that area mean is zero without moving the zero contour. g Grid structure array 2D array to be adjusted scaling The scaling factor used unit_scale A rescaling factor for the variable mom_surface_forcing_gfdl::convert_iob_to_fluxes Functions and routines to take area, volume, mass-weighted, layerwise, zonal or meridional means.