mom_grid_initialize mom_grid_initialize::gps subroutine, public subroutine, public mom_grid_initialize::set_grid_metrics (G, param_file, US) set_grid_metrics G G param_file param_file US US set_grid_metrics is used to set the primary values in the model's horizontal grid. The bathymetry, land-sea mask and any restricted channel widths are not known yet, so these are set later. g The dynamic horizontal grid type param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave grid_metrics_chksum mom_dyn_horgrid::set_derived_dyn_horgrid set_grid_metrics_cartesian set_grid_metrics_from_mosaic set_grid_metrics_mercator set_grid_metrics_spherical mom_oda_driver_mod::init_oda mom_ice_shelf::initialize_ice_shelf mom_fixed_initialization::mom_initialize_fixed subroutine subroutine mom_grid_initialize::grid_metrics_chksum (parent, G, US) grid_metrics_chksum parent parent G G US US grid_metrics_chksum performs a set of checksums on metrics on the grid for debugging. parent A string identifying the caller g The dynamic horizontal grid type us A dimensional unit scaling type set_grid_metrics subroutine subroutine mom_grid_initialize::set_grid_metrics_from_mosaic (G, param_file, US) set_grid_metrics_from_mosaic G G param_file param_file US US Sets the grid metrics from a mosaic file. g The dynamic horizontal grid type param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave extrapolate_metric set_grid_metrics subroutine subroutine mom_grid_initialize::set_grid_metrics_cartesian (G, param_file, US) set_grid_metrics_cartesian G G param_file param_file US US Calculate the values of the metric terms for a Cartesian grid that might be used and save them in arrays. Within this subroutine, the x- and y- grid spacings and their inverses and the cell areas centered on h, q, u, and v points are calculated, as are the geographic locations of each of these 4 sets of points. g The dynamic horizontal grid type param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_grid_metrics subroutine subroutine mom_grid_initialize::set_grid_metrics_spherical (G, param_file, US) set_grid_metrics_spherical G G param_file param_file US US Calculate the values of the metric terms that might be used and save them in arrays. Within this subroutine, the x- and y- grid spacings and their inverses and the cell areas centered on h, q, u, and v points are calculated, as are the geographic locations of each of these 4 sets of points. g The dynamic horizontal grid type param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_grid_metrics subroutine subroutine mom_grid_initialize::set_grid_metrics_mercator (G, param_file, US) set_grid_metrics_mercator G G param_file param_file US US Calculate the values of the metric terms that might be used and save them in arrays. Within this subroutine, the x- and y- grid spacings and their inverses and the cell areas centered on h, q, u, and v points are calculated, as are the geographic locations of each of these 4 sets of points. g The dynamic horizontal grid type param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave dl ds_di ds_dj dx_di dy_dj find_root int_di_dx int_dj_dy set_grid_metrics real function real function mom_grid_initialize::ds_di (x, y, GP) ds_di x x y y GP GP This function returns the grid spacing in the logical x direction. x The longitude in question y The latitude in question gp A structure of grid parameters dx_di set_grid_metrics_mercator real function real function mom_grid_initialize::ds_dj (x, y, GP) ds_dj x x y y GP GP This function returns the grid spacing in the logical y direction. x The longitude in question y The latitude in question gp A structure of grid parameters dy_dj set_grid_metrics_mercator real function real function mom_grid_initialize::dl (x1, x2, y1, y2) dl x1 x1 x2 x2 y1 y1 y2 y2 This function returns the contribution from the line integral along one of the four sides of a cell face to the area of a cell, assuming that the sides follow a linear path in latitude and longitude (i.e., on a Mercator grid). x1 Segment starting longitude, in degrees E. x2 Segment ending longitude, in degrees E. y1 Segment ending latitude, in degrees N. y2 Segment ending latitude, in degrees N. set_grid_metrics_mercator real function real function mom_grid_initialize::find_root (fn, dy_df, GP, fnval, y1, ymin, ymax, ittmax) find_root fn fn dy_df dy_df GP GP fnval fnval y1 y1 ymin ymin ymax ymax ittmax ittmax This subroutine finds and returns the value of y at which the monotonically increasing function fn takes the value fnval, also returning in ittmax the number of iterations of Newton's method that were used to polish the root. The value of y where fn(y) = fnval that will be returned fn The external function whose root is being sought dy_df The inverse of the derivative of that function gp A structure of grid parameters fnval The value of fn being sought y1 A first guess for y ymin The minimum permitted value of y ymax The maximum permitted value of y ittmax The number of iterations used to polish the root set_grid_metrics_mercator real function real function mom_grid_initialize::dx_di (x, GP) dx_di x x GP GP This function calculates and returns the value of dx/di, where x is the longitude in Radians, and i is the integral north-south grid index. x The longitude in question gp A structure of grid parameters ds_di set_grid_metrics_mercator real function real function mom_grid_initialize::int_di_dx (x, GP) int_di_dx x x GP GP This function calculates and returns the integral of the inverse of dx/di to the point x, in radians. x The longitude in question gp A structure of grid parameters set_grid_metrics_mercator real function real function mom_grid_initialize::dy_dj (y, GP) dy_dj y y GP GP This subroutine calculates and returns the value of dy/dj, where y is the latitude in Radians, and j is the integral north-south grid index. y The latitude in question gp A structure of grid parameters ds_dj set_grid_metrics_mercator real function real function mom_grid_initialize::int_dj_dy (y, GP) int_dj_dy y y GP GP This subroutine calculates and returns the integral of the inverse of dy/dj to the point y, in radians. y The latitude in question gp A structure of grid parameters set_grid_metrics_mercator subroutine subroutine mom_grid_initialize::extrapolate_metric (var, jh, missing) extrapolate_metric var var jh jh missing missing Extrapolates missing metric data into all the halo regions. var The array in which to fill in halos jh The size of the halos to be filled missing The missing data fill value, 0 by default. set_grid_metrics_from_mosaic real function, public real function, public mom_grid_initialize::adcroft_reciprocal (val) adcroft_reciprocal val val This function implements Adcroft's rule for reciprocals, namely that Adcroft_Inv(x) = 1/x for |x|>0 or 0 for x=0. val The value being inverted. The Adcroft reciprocal of val. initialize_masks subroutine, public subroutine, public mom_grid_initialize::initialize_masks (G, PF, US) initialize_masks G G PF PF US US Initializes the grid masks and any metrics that come with masks already applied. Initialize_masks sets mask2dT, mask2dCu, mask2dCv, and mask2dBu to mask out flow over any points which are shallower than Dmin and permit an appropriate treatment of the boundary conditions. mask2dCu and mask2dCv are 0.0 at any points adjacent to a land point. mask2dBu is 0.0 at any land or boundary point. For points in the interior, mask2dCu, mask2dCv, and mask2dBu are all 1.0. g The dynamic horizontal grid type pf Parameter file structure us A dimensional unit scaling type adcroft_reciprocal mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_fixed_initialization::mom_initialize_fixed Initializes horizontal grid. The metric terms have the form Dzp, IDzp, or DXDYp, where z can be X or Y, and p can be q, u, v, or h. z describes the direction of the metric, while p describes the location. IDzp is the inverse of Dzp, while DXDYp is the product of DXp and DYp except that areaT is calculated analytically from the latitudes and longitudes of the surrounding q points.On a sphere, a variety of grids can be implemented by defining analytic expressions for dx_di, dy_dj (where x and y are latitude and longitude, and i and j are grid indices) and the expressions for the integrals of their inverses in the four subroutines dy_dj, Int_dj_dy, dx_di, and Int_di_dx.initialize_masks sets up land masks based on the depth field. The one argument is the minimum ocean depth. Depths that are less than this are interpreted as land points.