mom_horizontal_regridding mom_horizontal_regridding::fill_boundaries mom_horizontal_regridding::horiz_interp_and_extrap_tracer subroutine, public subroutine, public mom_horizontal_regridding::mystats (array, missing, is, ie, js, je, k, mesg) mystats array array missing missing is is ie ie js js je je k k mesg mesg Write to the terminal some basic statistics about the k-th level of an array. array input array (ND) missing missing value (ND) is Start index in i ie End index in i js Start index in j je End index in j k Level to calculate statistics for mesg Label to use in message horiz_interp_and_extrap_tracer_fms_id horiz_interp_and_extrap_tracer_record mom_tracer_initialization_from_z::mom_initialize_tracer_from_z subroutine subroutine mom_horizontal_regridding::fill_miss_2d (aout, good, fill, prev, G, smooth, num_pass, relc, crit, debug, answers_2018) fill_miss_2d aout aout good good fill fill prev prev G G smooth smooth num_pass num_pass relc relc crit crit debug debug answers_2018 answers_2018 Use ICE-9 algorithm to populate points (fill=1) with valid data (good=1). If no information is available, Then use a previous guess (prev). Optionally (smooth) blend the filled points to achieve a more desirable result. g The ocean's grid structure. aout The array with missing values to fill good Valid data mask for incoming array fill Same shape array of points which need prev First guess where isolated holes exist. smooth If present and true, apply a number of Laplacian iterations to the interpolated data num_pass The maximum number of iterations relc A relaxation coefficient for Laplacian (ND) crit A minimal value for deltas between iterations. debug If true, write verbose debugging messages. answers_2018 If true, use expressions that give the same answers as the code did in late 2018. Otherwise add parentheses for rotational symmetry. horiz_interp_and_extrap_tracer_fms_id horiz_interp_and_extrap_tracer_record subroutine subroutine mom_horizontal_regridding::horiz_interp_and_extrap_tracer_record (filename, varnam, conversion, recnum, G, tr_z, mask_z, z_in, z_edges_in, missing_value, reentrant_x, tripolar_n, homogenize, m_to_Z, answers_2018, ongrid) horiz_interp_and_extrap_tracer_record filename filename varnam varnam conversion conversion recnum recnum G G tr_z tr_z mask_z mask_z z_in z_in z_edges_in z_edges_in missing_value missing_value reentrant_x reentrant_x tripolar_n tripolar_n homogenize homogenize m_to_Z m_to_Z answers_2018 answers_2018 ongrid ongrid Extrapolate and interpolate from a file record. filename Path to file containing tracer to be interpolated. varnam Name of tracer in filee. conversion Conversion factor for tracer. recnum Record number of tracer to be read. g Grid object tr_z pointer to allocatable tracer array on local model grid and input-file vertical levels. mask_z pointer to allocatable tracer mask array on local model grid and input-file vertical levels. z_in Cell grid values for input data. z_edges_in Cell grid edge values for input data. missing_value The missing value in the returned array. reentrant_x If true, this grid is reentrant in the x-direction tripolar_n If true, this is a northern tripolar grid homogenize If present and true, horizontally homogenize data to produce perfectly "flat" initial conditions m_to_z A conversion factor from meters to the units of depth. If missing, GbathyT must be in m. answers_2018 If true, use expressions that give the same answers as the code did in late 2018. Otherwise add parentheses for rotational symmetry. ongrid If true, then data are assumed to have been interpolated to the model horizontal grid. In this case, only extrapolation is performed by this routine fill_miss_2d meshgrid mystats subroutine subroutine mom_horizontal_regridding::horiz_interp_and_extrap_tracer_fms_id (fms_id, Time, conversion, G, tr_z, mask_z, z_in, z_edges_in, missing_value, reentrant_x, tripolar_n, homogenize, spongeOngrid, m_to_Z, answers_2018) horiz_interp_and_extrap_tracer_fms_id fms_id fms_id Time Time conversion conversion G G tr_z tr_z mask_z mask_z z_in z_in z_edges_in z_edges_in missing_value missing_value reentrant_x reentrant_x tripolar_n tripolar_n homogenize homogenize spongeOngrid spongeOngrid m_to_Z m_to_Z answers_2018 answers_2018 Extrapolate and interpolate using a FMS time interpolation handle. fms_id A unique id used by the FMS time interpolator time A FMS time type conversion Conversion factor for tracer. g Grid object tr_z pointer to allocatable tracer array on local model grid and native vertical levels. mask_z pointer to allocatable tracer mask array on local model grid and native vertical levels. z_in Cell grid values for input data. z_edges_in Cell grid edge values for input data. (Intent out) missing_value The missing value in the returned array. reentrant_x If true, this grid is reentrant in the x-direction tripolar_n If true, this is a northern tripolar grid homogenize If present and true, horizontally homogenize data to produce perfectly "flat" initial conditions spongeongrid If present and true, the sponge data are on the model grid m_to_z A conversion factor from meters to the units of depth. If missing, GbathyT must be in m. answers_2018 If true, use expressions that give the same answers as the code did in late 2018. Otherwise add parentheses for rotational symmetry. fill_miss_2d meshgrid mystats subroutine subroutine mom_horizontal_regridding::meshgrid (x, y, x_T, y_T) meshgrid x x y y x_T x_T y_T y_T Create a 2d-mesh of grid coordinates from 1-d arrays. x input 1-dimensional vector y input 1-dimensional vector x_t output 2-dimensional array y_t output 2-dimensional array horiz_interp_and_extrap_tracer_fms_id horiz_interp_and_extrap_tracer_record integer function, dimension(0:size(m, 1)+1, 0:size(m, 2)+1) integer function, dimension(0:size(m,1)+1,0:size(m,2)+1) mom_horizontal_regridding::fill_boundaries_int (m, cyclic_x, tripolar_n) fill_boundaries_int m m cyclic_x cyclic_x tripolar_n tripolar_n Fill grid edges for integer data. m input array (ND) cyclic_x True if domain is zonally re-entrant tripolar_n True if domain has an Arctic fold fill_boundaries_real real function, dimension(0:size(m, 1)+1, 0:size(m, 2)+1) real function, dimension(0:size(m,1)+1,0:size(m,2)+1) mom_horizontal_regridding::fill_boundaries_real (m, cyclic_x, tripolar_n) fill_boundaries_real m m cyclic_x cyclic_x tripolar_n tripolar_n Fill grid edges for real data. m input array (ND) cyclic_x True if domain is zonally re-entrant tripolar_n True if domain has an Arctic fold fill_boundaries_int subroutine subroutine mom_horizontal_regridding::smooth_heights (zi, fill, bad, sor, niter, cyclic_x, tripolar_n) smooth_heights zi zi fill fill bad bad sor sor niter niter cyclic_x cyclic_x tripolar_n tripolar_n Solve del2 (zi) = 0 using successive iterations with a 5 point stencil. Only points fill==1 are modified. Except where bad==1, information propagates isotropically in index space. The resulting solution in each region is an approximation to del2(zi)=0 subject to boundary conditions along the valid points curve bounding this region. zi input and output array (ND) fill same shape as zi, 1=fill bad same shape as zi, 1=bad data sor relaxation coefficient (ND) niter maximum number of iterations cyclic_x true if domain is zonally reentrant tripolar_n true if domain has an Arctic fold Horizontal interpolation.