mom_remapping mom_remapping::remapping_cs integer, parameter integer, parameter mom_remapping::remapping_pcm remapping_pcm = 0 O(h^1) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::remapping_plm remapping_plm = 1 O(h^2) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::remapping_ppm_h4 remapping_ppm_h4 = 2 O(h^3) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::remapping_ppm_ih4 remapping_ppm_ih4 = 3 O(h^3) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::remapping_pqm_ih4ih3 remapping_pqm_ih4ih3 = 4 O(h^4) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::remapping_pqm_ih6ih5 remapping_pqm_ih6ih5 = 5 O(h^5) remapping scheme. build_reconstructions_1d setreconstructiontype integer, parameter integer, parameter mom_remapping::integration_pcm integration_pcm = 0 Piecewise Constant Method. average_value_ppoly build_reconstructions_1d integraterecononinterval integer, parameter integer, parameter mom_remapping::integration_plm integration_plm = 1 Piecewise Linear Method. average_value_ppoly build_reconstructions_1d integraterecononinterval remapping_unit_tests integer, parameter integer, parameter mom_remapping::integration_ppm integration_ppm = 3 Piecewise Parabolic Method. average_value_ppoly build_reconstructions_1d integraterecononinterval remapping_unit_tests integer, parameter integer, parameter mom_remapping::integration_pqm integration_pqm = 5 Piecewise Quartic Method. average_value_ppoly build_reconstructions_1d integraterecononinterval character(len=40) character(len=40) mom_remapping::mdl mdl = "MOM_remapping" This module's name. character(len=256), public character(len=256), public mom_remapping::remappingschemesdoc remappingschemesdoc = "PCM (1st-order accurate)\n"// "PLM (2nd-order accurate)\n"// "PPM_H4 (3rd-order accurate)\n"// "PPM_IH4 (3rd-order accurate)\n"// "PQM_IH4IH3 (4th-order accurate)\n"// "PQM_IH6IH5 (5th-order accurate)\n" Documentation for external callers. mom_lateral_boundary_diffusion::lateral_boundary_diffusion_init mom_neutral_diffusion::neutral_diffusion_init character(len=3), public character(len=3), public mom_remapping::remappingdefaultscheme remappingdefaultscheme = "PLM" Default remapping method. mom_lateral_boundary_diffusion::lateral_boundary_diffusion_init mom_neutral_diffusion::neutral_diffusion_init real, parameter real, parameter mom_remapping::hneglect_dflt hneglect_dflt = 1.E-30 A thickness [H ~> m or kg m-2] that can be added to thicknesses in a denominator without changing the numerical result, except where a division by zero would otherwise occur. integraterecononinterval remapping_unit_tests logical, parameter logical, parameter mom_remapping::old_algorithm old_algorithm = .false. Use the old "broken" algorithm. This is a temporary measure to assist debugging until we delete the old algorithm. remap_via_sub_cells subroutine, public subroutine, public mom_remapping::remapping_set_param (CS, remapping_scheme, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell, answers_2018) remapping_set_param CS CS remapping_scheme remapping_scheme boundary_extrapolation boundary_extrapolation check_reconstruction check_reconstruction check_remapping check_remapping force_bounds_in_subcell force_bounds_in_subcell answers_2018 answers_2018 Set parameters within remapping object. cs Remapping control structure remapping_scheme Remapping scheme to use boundary_extrapolation Indicate to extrapolate in boundary cells check_reconstruction Indicate to check reconstructions check_remapping Indicate to check results of remapping force_bounds_in_subcell Force subcells values to be bounded answers_2018 If true use older, less acccurate expressions. setreconstructiontype initialize_remapping subroutine, public subroutine, public mom_remapping::extract_member_remapping_cs (CS, remapping_scheme, degree, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell) extract_member_remapping_cs CS CS remapping_scheme remapping_scheme degree degree boundary_extrapolation boundary_extrapolation check_reconstruction check_reconstruction check_remapping check_remapping force_bounds_in_subcell force_bounds_in_subcell cs Control structure for remapping module remapping_scheme Determines which reconstruction scheme to use degree Degree of polynomial reconstruction boundary_extrapolation If true, extrapolate boundaries check_reconstruction If true, reconstructions are checked for consistency. check_remapping If true, the result of remapping are checked for conservation and bounds. force_bounds_in_subcell If true, the intermediate values used in remapping are forced to be bounded. subroutine subroutine mom_remapping::buildgridfromh (nz, h, x) buildgridfromh nz nz h h x x Calculate edge coordinate x from cell width h. nz Number of cells h Cell widths x Edge coordiantes starting at x(1)=0 remapping_unit_tests logical function logical function mom_remapping::ispossumerrsignificant (n1, sum1, n2, sum2) ispossumerrsignificant n1 n1 sum1 sum1 n2 n2 sum2 sum2 Compare two summation estimates of positive data and judge if due to more than round-off. When two sums are calculated from different vectors that should add up to the same value, the results can differ by round off. The round off error can be bounded to be proportional to the number of operations. This function returns true if the difference between sum1 and sum2 is larger than than the estimated round off bound. This estimate/function is only valid for summation of positive data. n1 Number of values in sum1 n2 Number of values in sum2 sum1 Sum of n1 values sum2 Sum of n2 values True if difference in sums is large mom_error_handler::mom_error subroutine, public subroutine, public mom_remapping::remapping_core_h (CS, n0, h0, u0, n1, h1, u1, h_neglect, h_neglect_edge) remapping_core_h CS CS n0 n0 h0 h0 u0 u0 n1 n1 h1 h1 u1 u1 h_neglect h_neglect h_neglect_edge h_neglect_edge Remaps column of values u0 on grid h0 to grid h1 assuming the top edge is aligned. cs Remapping control structure n0 Number of cells on source grid h0 Cell widths on source grid u0 Cell averages on source grid n1 Number of cells on target grid h1 Cell widths on target grid u1 Cell averages on target grid h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h0. h_neglect_edge A negligibly small width for the purpose of edge value calculations in the same units as h0. build_reconstructions_1d check_reconstructions_1d measure_input_bounds measure_output_bounds mom_error_handler::mom_error remap_via_sub_cells mom_ale_sponge::apply_ale_sponge coord_rho::build_rho_column_iteratively mom_tidal_mixing::calculate_cvmix_tidal mom_state_initialization::cut_off_column_top mom_diag_remap::diag_remap_do_remap mom_oda_driver_mod::set_prior_tracer mom_wave_speed::wave_speed subroutine, public subroutine, public mom_remapping::remapping_core_w (CS, n0, h0, u0, n1, dx, u1, h_neglect, h_neglect_edge) remapping_core_w CS CS n0 n0 h0 h0 u0 u0 n1 n1 dx dx u1 u1 h_neglect h_neglect h_neglect_edge h_neglect_edge Remaps column of values u0 on grid h0 to implied grid h1 where the interfaces of h1 differ from those of h0 by dx. cs Remapping control structure n0 Number of cells on source grid h0 Cell widths on source grid u0 Cell averages on source grid n1 Number of cells on target grid dx Cell widths on target grid u1 Cell averages on target grid h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h0. h_neglect_edge A negligibly small width for the purpose of edge value calculations in the same units as h0. build_reconstructions_1d check_reconstructions_1d measure_input_bounds measure_output_bounds mom_error_handler::mom_error remap_via_sub_cells remapping_unit_tests subroutine, public subroutine, public mom_remapping::build_reconstructions_1d (CS, n0, h0, u0, ppoly_r_coefs, ppoly_r_E, ppoly_r_S, iMethod, h_neglect, h_neglect_edge) build_reconstructions_1d CS CS n0 n0 h0 h0 u0 u0 ppoly_r_coefs ppoly_r_coefs ppoly_r_E ppoly_r_E ppoly_r_S ppoly_r_S iMethod iMethod h_neglect h_neglect h_neglect_edge h_neglect_edge Creates polynomial reconstructions of u0 on the source grid h0. cs Remapping control structure n0 Number of cells on source grid h0 Cell widths on source grid u0 Cell averages on source grid ppoly_r_coefs Coefficients of polynomial ppoly_r_e Edge value of polynomial ppoly_r_s Edge slope of polynomial imethod Integration method h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h0. h_neglect_edge A negligibly small width for the purpose of edge value calculations in the same units as h0. regrid_edge_values::edge_slopes_implicit_h3 regrid_edge_values::edge_slopes_implicit_h5 integration_pcm integration_plm integration_ppm integration_pqm mom_error_handler::mom_error pcm_functions::pcm_reconstruction plm_functions::plm_boundary_extrapolation plm_functions::plm_reconstruction ppm_functions::ppm_boundary_extrapolation ppm_functions::ppm_reconstruction pqm_functions::pqm_boundary_extrapolation_v1 pqm_functions::pqm_reconstruction remapping_pcm remapping_plm remapping_ppm_h4 remapping_ppm_ih4 remapping_pqm_ih4ih3 remapping_pqm_ih6ih5 remapping_core_h remapping_core_w subroutine subroutine mom_remapping::check_reconstructions_1d (n0, h0, u0, deg, boundary_extrapolation, ppoly_r_coefs, ppoly_r_E, ppoly_r_S) check_reconstructions_1d n0 n0 h0 h0 u0 u0 deg deg boundary_extrapolation boundary_extrapolation ppoly_r_coefs ppoly_r_coefs ppoly_r_E ppoly_r_E ppoly_r_S ppoly_r_S Checks that edge values and reconstructions satisfy bounds. n0 Number of cells on source grid h0 Cell widths on source grid u0 Cell averages on source grid deg Degree of polynomial reconstruction boundary_extrapolation Extrapolate at boundaries if true ppoly_r_coefs Coefficients of polynomial ppoly_r_e Edge value of polynomial ppoly_r_s Edge slope of polynomial mom_error_handler::mom_error remapping_core_h remapping_core_w subroutine subroutine mom_remapping::remap_via_sub_cells (n0, h0, u0, ppoly0_E, ppoly0_coefs, n1, h1, method, force_bounds_in_subcell, u1, uh_err, ah_sub, aisub_src, aiss, aise) remap_via_sub_cells n0 n0 h0 h0 u0 u0 ppoly0_E ppoly0_E ppoly0_coefs ppoly0_coefs n1 n1 h1 h1 method method force_bounds_in_subcell force_bounds_in_subcell u1 u1 uh_err uh_err ah_sub ah_sub aisub_src aisub_src aiss aiss aise aise Remaps column of n0 values u0 on grid h0 to grid h1 with n1 cells by calculating the n0+n1+1 sub-integrals of the intersection of h0 and h1, and the summing the appropriate integrals into the h1*u1 values. h0 and h1 must have the same units. n0 Number of cells in source grid h0 Source grid widths (size n0) u0 Source cell averages (size n0) ppoly0_e Edge value of polynomial ppoly0_coefs Coefficients of polynomial n1 Number of cells in target grid h1 Target grid widths (size n1) method Remapping scheme to use force_bounds_in_subcell Force sub-cell values to be bounded u1 Target cell averages (size n1) uh_err Estimate of bound on error in sum of u*h ah_sub h_sub aisub_src i_sub_src aiss isrc_start aise isrc_ens average_value_ppoly measure_input_bounds measure_output_bounds mom_error_handler::mom_error old_algorithm remapping_core_h remapping_core_w remapping_unit_tests real function, public real function, public mom_remapping::average_value_ppoly (n0, u0, ppoly0_E, ppoly0_coefs, method, i0, xa, xb) average_value_ppoly n0 n0 u0 u0 ppoly0_E ppoly0_E ppoly0_coefs ppoly0_coefs method method i0 i0 xa xa xb xb Returns the average value of a reconstruction within a single source cell, i0, between the non-dimensional positions xa and xb (xa<=xb) with dimensional separation dh. n0 Number of cells in source grid u0 Cell means ppoly0_e Edge value of polynomial ppoly0_coefs Coefficients of polynomial method Remapping scheme to use i0 Source cell index xa Non-dimensional start position within source cell xb Non-dimensional end position within source cell integration_pcm integration_plm integration_ppm integration_pqm mom_error_handler::mom_error mom_lateral_boundary_diffusion::bulk_average mom_lateral_boundary_diffusion::fluxes_layer_method mom_neutral_diffusion::neutral_surface_t_eval remap_via_sub_cells subroutine subroutine mom_remapping::measure_input_bounds (n0, h0, u0, edge_values, h0tot, h0err, u0tot, u0err, u0min, u0max) measure_input_bounds n0 n0 h0 h0 u0 u0 edge_values edge_values h0tot h0tot h0err h0err u0tot u0tot u0err u0err u0min u0min u0max u0max Measure totals and bounds on source grid. n0 Number of cells on source grid h0 Cell widths on source grid u0 Cell averages on source grid edge_values Cell edge values on source grid h0tot Sum of cell widths h0err Magnitude of round-off error in h0tot u0tot Sum of cell widths times values u0err Magnitude of round-off error in u0tot u0min Minimum value in reconstructions of u0 u0max Maximum value in reconstructions of u0 remap_via_sub_cells remapping_core_h remapping_core_w subroutine subroutine mom_remapping::measure_output_bounds (n1, h1, u1, h1tot, h1err, u1tot, u1err, u1min, u1max) measure_output_bounds n1 n1 h1 h1 u1 u1 h1tot h1tot h1err h1err u1tot u1tot u1err u1err u1min u1min u1max u1max Measure totals and bounds on destination grid. n1 Number of cells on destination grid h1 Cell widths on destination grid u1 Cell averages on destination grid h1tot Sum of cell widths h1err Magnitude of round-off error in h1tot u1tot Sum of cell widths times values u1err Magnitude of round-off error in u1tot u1min Minimum value in reconstructions of u1 u1max Maximum value in reconstructions of u1 remap_via_sub_cells remapping_core_h remapping_core_w subroutine subroutine mom_remapping::remapbyprojection (n0, h0, u0, ppoly0_E, ppoly0_coefs, n1, h1, method, u1, h_neglect) remapbyprojection n0 n0 h0 h0 u0 u0 ppoly0_E ppoly0_E ppoly0_coefs ppoly0_coefs n1 n1 h1 h1 method method u1 u1 h_neglect h_neglect Remaps column of values u0 on grid h0 to grid h1 by integrating over the projection of each h1 cell onto the h0 grid. n0 Number of cells in source grid h0 Source grid widths (size n0) u0 Source cell averages (size n0) ppoly0_e Edge value of polynomial ppoly0_coefs Coefficients of polynomial n1 Number of cells in target grid h1 Target grid widths (size n1) method Remapping scheme to use u1 Target cell averages (size n1) h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h. integraterecononinterval remapping_unit_tests subroutine subroutine mom_remapping::remapbydeltaz (n0, h0, u0, ppoly0_E, ppoly0_coefs, n1, dx1, method, u1, h1, h_neglect) remapbydeltaz n0 n0 h0 h0 u0 u0 ppoly0_E ppoly0_E ppoly0_coefs ppoly0_coefs n1 n1 dx1 dx1 method method u1 u1 h1 h1 h_neglect h_neglect Remaps column of values u0 on grid h0 to implied grid h1 where the interfaces of h1 differ from those of h0 by dx. The new grid is defined relative to the original grid by change dx1(:) = xNew(:) - xOld(:) and the remapping calculated so that hNew(k) qNew(k) = hOld(k) qOld(k) + F(k+1) - F(k) where F(k) = dx1(k) qAverage and where qAverage is the average qOld in the region zOld(k) to zNew(k). n0 Number of cells in source grid h0 Source grid sizes (size n0) u0 Source cell averages (size n0) ppoly0_e Edge value of polynomial ppoly0_coefs Coefficients of polynomial n1 Number of cells in target grid dx1 Target grid edge positions (size n1+1) method Remapping scheme to use u1 Target cell averages (size n1) h1 Target grid widths (size n1) h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h. integraterecononinterval remapping_unit_tests subroutine subroutine mom_remapping::integraterecononinterval (n0, h0, u0, ppoly0_E, ppoly0_coefs, method, xL, xR, hC, uAve, jStart, xStart, h_neglect) integraterecononinterval n0 n0 h0 h0 u0 u0 ppoly0_E ppoly0_E ppoly0_coefs ppoly0_coefs method method xL xL xR xR hC hC uAve uAve jStart jStart xStart xStart h_neglect h_neglect Integrate the reconstructed column profile over a single cell. n0 Number of cells in source grid h0 Source grid sizes (size n0) u0 Source cell averages ppoly0_e Edge value of polynomial ppoly0_coefs Coefficients of polynomial method Remapping scheme to use xl Left edges of target cell xr Right edges of target cell hc Cell width hC = xR - xL uave Average value on target cell jstart The index of the cell to start searching from On exit, contains index of last cell used xstart The left edge position of cell jStart On first entry should be 0. h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h. hneglect_dflt integration_pcm integration_plm integration_ppm integration_pqm mom_error_handler::mom_error remapbydeltaz remapbyprojection subroutine, public subroutine, public mom_remapping::dzfromh1h2 (n1, h1, n2, h2, dx) dzfromh1h2 n1 n1 h1 h1 n2 n2 h2 h2 dx dx Calculates the change in interface positions based on h1 and h2. n1 Number of cells on source grid h1 Cell widths of source grid (size n1) n2 Number of cells on target grid h2 Cell widths of target grid (size n2) dx Change in interface position (size n2+1) mom_ale::ale_remap_scalar remapping_unit_tests subroutine, public subroutine, public mom_remapping::initialize_remapping (CS, remapping_scheme, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell, answers_2018) initialize_remapping CS CS remapping_scheme remapping_scheme boundary_extrapolation boundary_extrapolation check_reconstruction check_reconstruction check_remapping check_remapping force_bounds_in_subcell force_bounds_in_subcell answers_2018 answers_2018 Constructor for remapping control structure. cs Remapping control structure remapping_scheme Remapping scheme to use boundary_extrapolation Indicate to extrapolate in boundary cells check_reconstruction Indicate to check reconstructions check_remapping Indicate to check results of remapping force_bounds_in_subcell Force subcells values to be bounded answers_2018 If true use older, less acccurate expressions. remapping_set_param mom_oda_driver_mod::init_oda mom_ale_sponge::initialize_ale_sponge_fixed mom_ale_sponge::initialize_ale_sponge_varying mom_open_boundary::open_boundary_config mom_tidal_mixing::read_tidal_constituents remapping_unit_tests mom_wave_speed::wave_speed_init subroutine subroutine mom_remapping::setreconstructiontype (string, CS) setreconstructiontype string string CS CS Changes the method of reconstruction Use this routine to parse a string parameter specifying the reconstruction and re-allocates work arrays appropriately. It is called from initialize_remapping but can be called from an external module too. string String to parse for method cs Remapping control structure mom_error_handler::mom_error remapping_pcm remapping_plm remapping_ppm_h4 remapping_ppm_ih4 remapping_pqm_ih4ih3 remapping_pqm_ih6ih5 mom_string_functions::uppercase remapping_set_param subroutine, public subroutine, public mom_remapping::end_remapping (CS) end_remapping CS CS Destrcutor for remapping control structure. cs Remapping control structure logical function, public logical function, public mom_remapping::remapping_unit_tests (verbose) remapping_unit_tests verbose verbose Runs unit tests on remapping functions. Should only be called from a single/root thread Returns True if a test fails, otherwise False. verbose If true, write results to stdout buildgridfromh dumpgrid dzfromh1h2 hneglect_dflt initialize_remapping integration_plm integration_ppm pcm_functions::pcm_reconstruction plm_functions::plm_reconstruction ppm_functions::ppm_boundary_extrapolation ppm_functions::ppm_reconstruction remap_via_sub_cells remapbydeltaz remapbyprojection remapping_core_w test_answer mom_unit_tests::unit_tests logical function logical function mom_remapping::test_answer (verbose, n, u, u_true, label, tol) test_answer verbose verbose n n u u u_true u_true label label tol tol Returns true if any cell of u and u_true are not identical. Returns false otherwise. verbose If true, write results to stdout n Number of cells in u u Values to test u_true Values to test against (correct answer) label Message tol The tolerance for differences between u and u_true remapping_unit_tests subroutine subroutine mom_remapping::dumpgrid (n, h, x, u) dumpgrid n n h h x x u u Convenience function for printing grid to screen. n Number of cells h Cell thickness x Interface delta u Cell average values remapping_unit_tests Provides column-wise vertical remapping functions.