mom_remapping module reference¶

Provides column-wise vertical remapping functions.

Data Types¶

remapping_cs

Container for remapping parameters.

Functions/Subroutines¶

`remapping_set_param()`	Set parameters within remapping object.
`extract_member_remapping_cs()`
`buildgridfromh()`	Calculate edge coordinate x from cell width h.
`ispossumerrsignificant()`	Compare two summation estimates of positive data and judge if due to more than round-off.
`remapping_core_h()`	Remaps column of values u0 on grid h0 to grid h1 assuming the top edge is aligned.
`remapping_core_w()`	Remaps column of values u0 on grid h0 to implied grid h1 where the interfaces of h1 differ from those of h0 by dx.
`build_reconstructions_1d()`	Creates polynomial reconstructions of u0 on the source grid h0.
`check_reconstructions_1d()`	Checks that edge values and reconstructions satisfy bounds.
`remap_via_sub_cells()`	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.
`average_value_ppoly()`	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.
`measure_input_bounds()`	Measure totals and bounds on source grid.
`measure_output_bounds()`	Measure totals and bounds on destination grid.
`remapbyprojection()`	Remaps column of values u0 on grid h0 to grid h1 by integrating over the projection of each h1 cell onto the h0 grid.
`remapbydeltaz()`	Remaps column of values u0 on grid h0 to implied grid h1 where the interfaces of h1 differ from those of h0 by dx.
`integraterecononinterval()`	Integrate the reconstructed column profile over a single cell.
`dzfromh1h2()`	Calculates the change in interface positions based on h1 and h2.
`initialize_remapping()`	Constructor for remapping control structure.
`setreconstructiontype()`	Changes the method of reconstruction Use this routine to parse a string parameter specifying the reconstruction and re-allocates work arrays appropriately.
`end_remapping()`	Destrcutor for remapping control structure.
`remapping_unit_tests()`	Runs unit tests on remapping functions.
`test_answer()`	Returns true if any cell of u and u_true are not identical.
`dumpgrid()`	Convenience function for printing grid to screen.

Detailed Description¶

Provides column-wise vertical remapping functions.

Type Documentation¶

type mom_remapping/remapping_cs¶

Container for remapping parameters.

Type fields

% remapping_scheme [integer] :: Determines which reconstruction to use.
% degree [integer] :: Degree of polynomial reconstruction.
% boundary_extrapolation [logical] :: If true, extrapolate boundaries.
% check_reconstruction [logical] :: If true, reconstructions are checked for consistency.
% check_remapping [logical] :: If true, the result of remapping are checked for conservation and bounds.
% force_bounds_in_subcell [logical] :: If true, the intermediate values used in remapping are forced to be bounded.
% answers_2018 [logical] :: If true use older, less acccurate expressions.

Function/Subroutine Documentation¶

subroutine mom_remapping/remapping_set_param(CS, remapping_scheme, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell, answers_2018)¶

Set parameters within remapping object.

Parameters

cs :: [inout] Remapping control structure
remapping_scheme :: [in] Remapping scheme to use
boundary_extrapolation :: [in] Indicate to extrapolate in boundary cells
check_reconstruction :: [in] Indicate to check reconstructions
check_remapping :: [in] Indicate to check results of remapping
force_bounds_in_subcell :: [in] Force subcells values to be bounded
answers_2018 :: [in] If true use older, less acccurate expressions.

Call to

setreconstructiontype

Called from

initialize_remapping

subroutine mom_remapping/extract_member_remapping_cs(CS, remapping_scheme, degree, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell)¶

Parameters

cs :: [in] Control structure for remapping module
remapping_scheme :: [out] Determines which reconstruction scheme to use
degree :: [out] Degree of polynomial reconstruction
boundary_extrapolation :: [out] If true, extrapolate boundaries
check_reconstruction :: [out] If true, reconstructions are checked for consistency.
check_remapping :: [out] If true, the result of remapping are checked for conservation and bounds.
force_bounds_in_subcell :: [out] If true, the intermediate values used in remapping are forced to be bounded.

subroutine mom_remapping/buildgridfromh(nz, h, x)¶

Calculate edge coordinate x from cell width h.

Parameters

nz :: [in] Number of cells
h :: [in] Cell widths
x :: [inout] Edge coordiantes starting at x(1)=0

Called from

remapping_unit_tests

function mom_remapping/ispossumerrsignificant(n1, sum1, n2, sum2) [logical]¶

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.

Parameters

n1 :: [in] Number of values in sum1
n2 :: [in] Number of values in sum2
sum1 :: [in] Sum of n1 values
sum2 :: [in] Sum of n2 values

Return

undefined :: True if difference in sums is large

Call to

mom_error_handler::mom_error

subroutine mom_remapping/remapping_core_h(CS, n0, h0, u0, n1, h1, u1, h_neglect, h_neglect_edge)¶

Remaps column of values u0 on grid h0 to grid h1 assuming the top edge is aligned.

Parameters

cs :: [in] Remapping control structure
n0 :: [in] Number of cells on source grid
h0 :: [in] Cell widths on source grid
u0 :: [in] Cell averages on source grid
n1 :: [in] Number of cells on target grid
h1 :: [in] Cell widths on target grid
u1 :: [out] Cell averages on target grid
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h0.
h_neglect_edge :: [in] A negligibly small width for the purpose of edge value calculations in the same units as h0.

Call to

build_reconstructions_1d check_reconstructions_1d measure_input_bounds measure_output_bounds mom_error_handler::mom_error remap_via_sub_cells

Called from

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_open_boundary::update_obc_segment_data mom_wave_speed::wave_speed

subroutine mom_remapping/remapping_core_w(CS, n0, h0, u0, n1, dx, u1, h_neglect, 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.

Parameters

cs :: [in] Remapping control structure
n0 :: [in] Number of cells on source grid
h0 :: [in] Cell widths on source grid
u0 :: [in] Cell averages on source grid
n1 :: [in] Number of cells on target grid
dx :: [in] Cell widths on target grid
u1 :: [out] Cell averages on target grid
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h0.
h_neglect_edge :: [in] A negligibly small width for the purpose of edge value calculations in the same units as h0.

Call to

build_reconstructions_1d check_reconstructions_1d measure_input_bounds measure_output_bounds mom_error_handler::mom_error remap_via_sub_cells

Called from

remapping_unit_tests

subroutine mom_remapping/build_reconstructions_1d(CS, n0, h0, u0, ppoly_r_coefs, ppoly_r_E, ppoly_r_S, iMethod, h_neglect, h_neglect_edge)¶

Creates polynomial reconstructions of u0 on the source grid h0.

Parameters

cs :: [in] Remapping control structure
n0 :: [in] Number of cells on source grid
h0 :: [in] Cell widths on source grid
u0 :: [in] Cell averages on source grid
ppoly_r_coefs :: [out] Coefficients of polynomial
ppoly_r_e :: [out] Edge value of polynomial
ppoly_r_s :: [out] Edge slope of polynomial
imethod :: [out] Integration method
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h0.
h_neglect_edge :: [in] A negligibly small width for the purpose of edge value calculations in the same units as h0.

Call to

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

Called from

remapping_core_h remapping_core_w

subroutine mom_remapping/check_reconstructions_1d(n0, h0, u0, deg, boundary_extrapolation, ppoly_r_coefs, ppoly_r_E, ppoly_r_S)¶

Checks that edge values and reconstructions satisfy bounds.

Parameters

n0 :: [in] Number of cells on source grid
h0 :: [in] Cell widths on source grid
u0 :: [in] Cell averages on source grid
deg :: [in] Degree of polynomial reconstruction
boundary_extrapolation :: [in] Extrapolate at boundaries if true
ppoly_r_coefs :: [out] Coefficients of polynomial
ppoly_r_e :: [out] Edge value of polynomial
ppoly_r_s :: [out] Edge slope of polynomial

Call to

mom_error_handler::mom_error

Called from

remapping_core_h remapping_core_w

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

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.

Parameters

n0 :: [in] Number of cells in source grid
h0 :: [in] Source grid widths (size n0)
u0 :: [in] Source cell averages (size n0)
ppoly0_e :: [in] Edge value of polynomial
ppoly0_coefs :: [in] Coefficients of polynomial
n1 :: [in] Number of cells in target grid
h1 :: [in] Target grid widths (size n1)
method :: [in] Remapping scheme to use
force_bounds_in_subcell :: [in] Force sub-cell values to be bounded
u1 :: [out] Target cell averages (size n1)
uh_err :: [out] Estimate of bound on error in sum of u*h
ah_sub :: [out] h_sub
aisub_src :: [out] i_sub_src
aiss :: [out] isrc_start
aise :: [out] isrc_ens

Call to

average_value_ppoly measure_input_bounds measure_output_bounds mom_error_handler::mom_error old_algorithm

Called from

remapping_core_h remapping_core_w remapping_unit_tests

function mom_remapping/average_value_ppoly(n0, u0, ppoly0_E, ppoly0_coefs, method, i0, xa, xb) [real]¶

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.

Parameters

n0 :: [in] Number of cells in source grid
u0 :: [in] Cell means
ppoly0_e :: [in] Edge value of polynomial
ppoly0_coefs :: [in] Coefficients of polynomial
method :: [in] Remapping scheme to use
i0 :: [in] Source cell index
xa :: [in] Non-dimensional start position within source cell
xb :: [in] Non-dimensional end position within source cell

Call to

integration_pcm integration_plm integration_ppm integration_pqm mom_error_handler::mom_error

Called from

mom_lateral_boundary_diffusion::bulk_average mom_lateral_boundary_diffusion::fluxes_layer_method remap_via_sub_cells

subroutine mom_remapping/measure_input_bounds(n0, h0, u0, edge_values, h0tot, h0err, u0tot, u0err, u0min, u0max)¶

Measure totals and bounds on source grid.

Parameters

n0 :: [in] Number of cells on source grid
h0 :: [in] Cell widths on source grid
u0 :: [in] Cell averages on source grid
edge_values :: [in] Cell edge values on source grid
h0tot :: [out] Sum of cell widths
h0err :: [out] Magnitude of round-off error in h0tot
u0tot :: [out] Sum of cell widths times values
u0err :: [out] Magnitude of round-off error in u0tot
u0min :: [out] Minimum value in reconstructions of u0
u0max :: [out] Maximum value in reconstructions of u0

Called from

remap_via_sub_cells remapping_core_h remapping_core_w

subroutine mom_remapping/measure_output_bounds(n1, h1, u1, h1tot, h1err, u1tot, u1err, u1min, u1max)¶

Measure totals and bounds on destination grid.

Parameters

n1 :: [in] Number of cells on destination grid
h1 :: [in] Cell widths on destination grid
u1 :: [in] Cell averages on destination grid
h1tot :: [out] Sum of cell widths
h1err :: [out] Magnitude of round-off error in h1tot
u1tot :: [out] Sum of cell widths times values
u1err :: [out] Magnitude of round-off error in u1tot
u1min :: [out] Minimum value in reconstructions of u1
u1max :: [out] Maximum value in reconstructions of u1

Called from

remap_via_sub_cells remapping_core_h remapping_core_w

subroutine mom_remapping/remapbyprojection(n0, h0, u0, ppoly0_E, ppoly0_coefs, n1, h1, method, u1, 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.

Parameters

n0 :: [in] Number of cells in source grid
h0 :: [in] Source grid widths (size n0)
u0 :: [in] Source cell averages (size n0)
ppoly0_e :: [in] Edge value of polynomial
ppoly0_coefs :: [in] Coefficients of polynomial
n1 :: [in] Number of cells in target grid
h1 :: [in] Target grid widths (size n1)
method :: [in] Remapping scheme to use
u1 :: [out] Target cell averages (size n1)
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h.

Call to

integraterecononinterval

Called from

remapping_unit_tests

subroutine mom_remapping/remapbydeltaz(n0, h0, u0, ppoly0_E, ppoly0_coefs, n1, dx1, method, u1, h1, 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).

Parameters

n0 :: [in] Number of cells in source grid
h0 :: [in] Source grid sizes (size n0)
u0 :: [in] Source cell averages (size n0)
ppoly0_e :: [in] Edge value of polynomial
ppoly0_coefs :: [in] Coefficients of polynomial
n1 :: [in] Number of cells in target grid
dx1 :: [in] Target grid edge positions (size n1+1)
method :: [in] Remapping scheme to use
u1 :: [out] Target cell averages (size n1)
h1 :: [out] Target grid widths (size n1)
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h.

Call to

integraterecononinterval

Called from

remapping_unit_tests

subroutine mom_remapping/integraterecononinterval(n0, h0, u0, ppoly0_E, ppoly0_coefs, method, xL, xR, hC, uAve, jStart, xStart, h_neglect)¶

Integrate the reconstructed column profile over a single cell.

Parameters

n0 :: [in] Number of cells in source grid
h0 :: [in] Source grid sizes (size n0)
u0 :: [in] Source cell averages
ppoly0_e :: [in] Edge value of polynomial
ppoly0_coefs :: [in] Coefficients of polynomial
method :: [in] Remapping scheme to use
xl :: [in] Left edges of target cell
xr :: [in] Right edges of target cell
hc :: [in] Cell width hC = xR - xL
uave :: [out] Average value on target cell
jstart :: [inout] The index of the cell to start searching from On exit, contains index of last cell used
xstart :: [inout] The left edge position of cell jStart On first entry should be 0.
h_neglect :: [in] A negligibly small width for the purpose of cell reconstructions in the same units as h.

Call to

hneglect_dflt integration_pcm integration_plm integration_ppm integration_pqm mom_error_handler::mom_error

Called from

remapbydeltaz remapbyprojection

subroutine mom_remapping/dzfromh1h2(n1, h1, n2, h2, dx)¶

Calculates the change in interface positions based on h1 and h2.

Parameters

n1 :: [in] Number of cells on source grid
h1 :: [in] Cell widths of source grid (size n1)
n2 :: [in] Number of cells on target grid
h2 :: [in] Cell widths of target grid (size n2)
dx :: [out] Change in interface position (size n2+1)

Called from

mom_ale::ale_remap_scalar remapping_unit_tests

subroutine mom_remapping/initialize_remapping(CS, remapping_scheme, boundary_extrapolation, check_reconstruction, check_remapping, force_bounds_in_subcell, answers_2018)¶

Constructor for remapping control structure.

Parameters

cs :: [inout] Remapping control structure
remapping_scheme :: [in] Remapping scheme to use
boundary_extrapolation :: [in] Indicate to extrapolate in boundary cells
check_reconstruction :: [in] Indicate to check reconstructions
check_remapping :: [in] Indicate to check results of remapping
force_bounds_in_subcell :: [in] Force subcells values to be bounded
answers_2018 :: [in] If true use older, less acccurate expressions.

Call to

remapping_set_param

Called from

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 mom_remapping/setreconstructiontype(string, 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.

Parameters

string :: [in] String to parse for method
cs :: [inout] Remapping control structure

Call to

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

Called from