mom_regridding module reference ¶

Called from:

subroutine mom_regridding/filtered_grid_motion(CS, nk, z_old, z_new, dz_g)¶

Returns the change in interface position motion after filtering and assuming the top and bottom interfaces do not move. The filtering is a function of depth, and is applied as the integrated average filtering over the trajectory of the interface. By design, this code can not give tangled interfaces provided that z_old and z_new are not already tangled.

Parameters:

cs :: [in] Regridding control structure
nk :: [in] Number of cells in source grid
z_old :: [in] Old grid position [H ~> m or kg m-2]
z_new :: [in] New grid position before filtering [H ~> m or kg m-2]
dz_g :: [inout] Change in interface positions including the effects of filtering [H ~> m or kg m-2]

Call to:

build_grid_adaptive build_grid_hycom1 build_rho_grid build_sigma_grid build_zstar_grid

Called from:

subroutine mom_regridding/build_zstar_grid(CS, G, GV, h, nom_depth_H, dzInterface, frac_shelf_h, zScale)¶

Builds a z*-coordinate grid with partial steps (Adcroft and Campin, 2004). z* is defined as z* = (z-eta)/(H+eta)*H s.t. z*=0 when z=eta and z*=-H when z=-H .

Parameters:

cs :: [in] Regridding control structure
g :: [in] Ocean grid structure
gv :: [in] ocean vertical grid structure
h :: [in] Layer thicknesses [H ~> m or kg m-2]
nom_depth_h :: [in] The bathymetric depth of this column relative to mean sea level or another locally valid reference height, converted to thickness units [H ~> m or kg m-2]
dzinterface :: [inout] The change in interface depth [H ~> m or kg m-2].
frac_shelf_h :: [in] Fractional ice shelf coverage [nondim].
zscale :: [in] Scaling factor from the target coordinate resolution in Z to desired units for zInterface, usually Z_to_H in which case it is in units of [H Z-1 ~> nondim or kg m-3]

Call to:

adjust_interface_motion coord_zlike::build_zstar_column filtered_grid_motion mom_error_handler::mom_error

Called from:

coord_sigma::build_sigma_column filtered_grid_motion mom_error_handler::mom_error

subroutine mom_regridding/build_sigma_grid(CS, G, GV, h, nom_depth_H, dzInterface)¶

This routine builds a grid based on terrain-following coordinates.

Parameters:

cs :: [in] Regridding control structure
g :: [in] Ocean grid structure
gv :: [in] ocean vertical grid structure
h :: [in] Layer thicknesses [H ~> m or kg m-2]
nom_depth_h :: [in] The bathymetric depth of this column relative to mean sea level or another locally valid reference height, converted to thickness units [H ~> m or kg m-2]
dzinterface :: [inout] The change in interface depth [H ~> m or kg m-2]

Call to:

Called from:

filtered_grid_motion mom_error_handler::mom_error set_h_neglect

subroutine mom_regridding/build_rho_grid(G, GV, US, h, nom_depth_H, tv, dzInterface, remapCS, CS, frac_shelf_h)¶

This routine builds a new grid based on a given set of target interface densities.

Parameters:

cs :: [in] Regridding control structure
g :: [in] Ocean grid structure
gv :: [in] Ocean vertical grid structure
us :: [in] A dimensional unit scaling type
h :: [in] Layer thicknesses [H ~> m or kg m-2]
nom_depth_h :: [in] The bathymetric depth of this column relative to mean sea level or another locally valid reference height, converted to thickness units [H ~> m or kg m-2]
tv :: [in] Thermodynamics structure
dzinterface :: [inout] The change in interface depth [H ~> m or kg m-2]
remapcs :: [in] The remapping control structure
frac_shelf_h :: [in] Fractional ice shelf coverage [nondim]

Call to:

Called from:

adjust_interface_motion coord_hycom::build_hycom1_column calc_h_new_by_dz filtered_grid_motion mom_error_handler::mom_error set_h_neglect

subroutine mom_regridding/build_grid_hycom1(G, GV, US, h, nom_depth_H, tv, h_new, dzInterface, remapCS, CS, frac_shelf_h, zScale)¶

Builds a simple HyCOM-like grid with the deepest location of potential density interpolated from the column profile and a clipping of depth for each interface to a fixed z* or p* grid. This should probably be (optionally?) changed to find the nearest location of the target density.

Parameters:

g :: [in] Grid structure
gv :: [in] Ocean vertical grid structure
us :: [in] A dimensional unit scaling type
h :: [in] Existing model thickness [H ~> m or kg m-2]
nom_depth_h :: [in] The bathymetric depth of this column relative to mean sea level or another locally valid reference height, converted to thickness units [H ~> m or kg m-2]
tv :: [in] Thermodynamics structure
remapcs :: [in] The remapping control structure
cs :: [in] Regridding control structure
h_new :: [inout] New layer thicknesses [H ~> m or kg m-2]
dzinterface :: [inout] Changes in interface position in thickness units [H ~> m or kg m-2]
frac_shelf_h :: [in] Fractional ice shelf coverage [nondim]
zscale :: [in] Scaling factor from the target coordinate resolution in Z to desired units for zInterface, usually Z_to_H in which case it is in units of [H Z-1 ~> nondim or kg m-3]

Call to:

Called from:

adjust_interface_motion mom_error_handler::assert coord_adapt::build_adapt_column filtered_grid_motion

subroutine mom_regridding/build_grid_adaptive(G, GV, US, h, nom_depth_H, tv, dzInterface, remapCS, CS)¶

This subroutine builds an adaptive grid that follows density surfaces where possible, subject to constraints on the smoothness of interface heights.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
us :: [in] A dimensional unit scaling type
h :: [in] Layer thicknesses [H ~> m or kg m-2]
nom_depth_h :: [in] The bathymetric depth of this column relative to mean sea level or another locally valid reference height, converted to thickness units [H ~> m or kg m-2]
tv :: [in] A structure pointing to various thermodynamic variables
cs :: [in] Regridding control structure
dzinterface :: [inout] The change in interface depth [H ~> m or kg m-2]
remapcs :: [in] The remapping control structure

Call to:

Called from:

subroutine mom_regridding/adjust_interface_motion(CS, nk, h_old, dz_int)¶

Adjust dz_Interface to ensure non-negative future thicknesses.

Parameters:

cs :: [in] Regridding control structure
nk :: [in] Number of layers in h_old
h_old :: [in] Layer thicknesses on the old grid [H ~> m or kg m-2]
dz_int :: [inout] Interface movements, adjusted to keep the thicknesses thicker than their minimum value [H ~> m or kg m-2]

Call to:

build_grid_adaptive build_grid_hycom1 build_zstar_grid

Called from:

subroutine mom_regridding/inflate_vanished_layers_old(CS, G, GV, h)¶

make sure all layers are at least as thick as the minimum thickness allowed for regridding purposes by inflating thin layers. This breaks mass conservation and adds mass to the model when there are excessively thin layers.

Parameters:

cs :: [in] Regridding control structure
g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
h :: [inout] Layer thicknesses [H ~> m or kg m-2]

Call to:

coord_rho::old_inflate_layers_1d

subroutine mom_regridding/convective_adjustment(G, GV, h, tv)¶

Achieve convective adjustment by swapping layers.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
h :: [inout] Layer thicknesses [H ~> m or kg m-2]
tv :: [inout] A structure pointing to various thermodynamic variables

function mom_regridding/uniformresolution(nk, coordMode, maxDepth, rhoLight, rhoHeavy) [real]¶

Return a uniform resolution vector in the units of the coordinate.

Parameters:

nk :: [in] Number of cells in source grid
coordmode :: [in] A string indicating the coordinate mode. See the documentation for regrid_consts() for the recognized values. for the recognized values.
maxdepth :: [in] The range of the grid values in some modes, in coordinate dependent units that might be [m] or [kg m-3] or [nondim] or something else.
rholight :: [in] The minimum value of the grid in RHO mode [kg m-3]
rhoheavy :: [in] The maximum value of the grid in RHO mode [kg m-3]

Return:

undefined :: The returned uniform resolution grid, in coordinate dependent units that might be [m] or [kg m-3] or [nondim] or something else.

Call to:

mom_error_handler::mom_error regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1

Called from:

subroutine mom_regridding/initcoord(CS, GV, US, coord_mode, param_file)¶

Initialize the coordinate resolutions by calling the appropriate initialization routine for the specified coordinate mode.

Parameters:

cs :: [inout] Regridding control structure
coord_mode :: [in] A string indicating the coordinate mode. See the documentation for regrid_consts() for the recognized values. for the recognized values.
gv :: [in] Ocean vertical grid structure
us :: [in] A dimensional unit scaling type
param_file :: [in] Parameter file

Call to:

coord_adapt::init_coord_adapt coord_hycom::init_coord_hycom coord_sigma::init_coord_sigma coord_zlike::init_coord_zlike regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1

Called from:

subroutine mom_regridding/setcoordinateresolution(dz, CS, scale)¶

Set the fixed resolution data.

Parameters:

dz :: [in] A vector of vertical grid spacings, in arbitrary coordinate dependent units, such as [m] for a z-coordinate or [kg m-3] for a density coordinate.
cs :: [inout] Regridding control structure
scale :: [in] A scaling factor converting dz to the internal represetation of coordRes, in various units that depend on the coordinate, such as [Z m-1 ~> 1 for a z-coordinate or [R m3 kg-1 ~> 1] for a density coordinate.

Call to:

Called from:

subroutine mom_regridding/set_target_densities_from_gv(GV, US, CS)¶

Set target densities based on the old Rlay variable.

Parameters:

gv :: [in] Ocean vertical grid structure
us :: [in] A dimensional unit scaling type
cs :: [inout] Regridding control structure

Called from:

subroutine mom_regridding/set_target_densities(CS, rho_int)¶

Set target densities based on vector of interface values.

Parameters:

cs :: [inout] Regridding control structure
rho_int :: [in] Interface densities [R ~> kg m-3]

Call to:

Called from:

subroutine mom_regridding/set_regrid_max_depths(CS, max_depths, units_to_H)¶

Set maximum interface depths based on a vector of input values.

Parameters:

cs :: [inout] Regridding control structure
max_depths :: [in] Maximum interface depths, in arbitrary units, often [m]
units_to_h :: [in] A conversion factor for max_depths into H units, often in [H m-1 ~> 1 or kg m-3]

Call to:

mom_error_handler::mom_error regrid_consts::regridding_hycom1 coord_hycom::set_hycom_params

Called from:

subroutine mom_regridding/set_regrid_max_thickness(CS, max_h, units_to_H)¶

Set maximum layer thicknesses based on a vector of input values.

Parameters:

cs :: [inout] Regridding control structure
max_h :: [in] Maximum layer thicknesses, in arbitrary units, often [m]
units_to_h :: [in] A conversion factor for max_h into H units, often [H m-1 ~> 1 or kg m-3]

Call to:

regrid_consts::regridding_hycom1 coord_hycom::set_hycom_params

Called from:

build_grid_hycom1 build_rho_grid

subroutine mom_regridding/write_regrid_file(CS, GV, filepath)¶

Write the vertical coordinate information into a file. This subroutine writes out a file containing any available data related to the vertical grid used by the MOM ocean model when in ALE mode.

Parameters:

cs :: [in] Regridding control structure
gv :: [in] ocean vertical grid structure
filepath :: [in] The full path to the file to write

Call to:

getcoordinateunits regrid_consts::regridding_hybgen mom_hybgen_regrid::write_hybgen_coord_file

function mom_regridding/set_h_neglect(GV, remap_answer_date, h_neglect_edge) [real]¶

Set appropriate values for the negligible thicknesses used for remapping based on an answer date.

Parameters:

gv :: [in] Ocean vertical grid structure
remap_answer_date :: [in] The vintage of the expressions to use for remapping. Values below 20190101 recover the remapping answers from 2018. Higher values use more robust forms of the same remapping algorithms.
h_neglect_edge :: [out] A negligibly small thickness used in remapping edge value calculations [H ~> m or kg m-2]

Return:

undefined :: A negligibly small thickness used in remapping cell reconstructions [H ~> m or kg m-2]

Called from:

function mom_regridding/set_dz_neglect(GV, US, remap_answer_date, dz_neglect_edge) [real]¶

Set appropriate values for the negligible vertical layer extents used for remapping based on an answer date.

Parameters:

gv :: [in] Ocean vertical grid structure
us :: [in] A dimensional unit scaling type
remap_answer_date :: [in] The vintage of the expressions to use for remapping. Values below 20190101 recover the remapping answers from 2018. Higher values use more robust forms of the same remapping algorithms.
dz_neglect_edge :: [out] A negligibly small vertical layer extent used in remapping edge value calculations [Z ~> m]

Return:

undefined :: A negligibly small vertical layer extent used in remapping cell reconstructions [Z ~> m]

Called from:

mom_tracer_initialization_from_z::mom_initialize_tracer_from_z

function mom_regridding/getcoordinateresolution(CS, undo_scaling) [real]¶

Query the fixed resolution data.

Parameters:

cs :: [in] Regridding control structure
undo_scaling :: [in] If present and true, undo any internal rescaling of the resolution data.

Return:

undefined :: The resolution or delta of the target coordinate, in units that depend on the coordinate [various]

function mom_regridding/getcoordinateinterfaces(CS, undo_scaling) [real]¶

Query the target coordinate interface positions.

Parameters:

cs :: [in] Regridding control structure
undo_scaling :: [in] If present and true, undo any internal rescaling of the resolution data.

Return:

undefined :: Interface positions in target coordinate, in units that depend on the coordinate [various]

Call to:

mom_oda_driver_mod::init_oda initialize_regridding

function mom_regridding/getcoordinateunits(CS) [character(len=20)]¶

Query the target coordinate units.

Parameters:: cs :: [in] Regridding control structure
Call to:: mom_error_handler::mom_error regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1
Called from:: write_regrid_file

function mom_regridding/getcoordinateshortname(CS) [character(len=20)]¶

Query the short name of the coordinate.

Parameters:: cs :: [in] Regridding control structure
Call to:: mom_error_handler::mom_error regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1

subroutine mom_regridding/set_regrid_params(CS, boundary_extrapolation, min_thickness, old_grid_weight, interp_scheme, depth_of_time_filter_shallow, depth_of_time_filter_deep, compress_fraction, ref_pressure, integrate_downward_for_e, remap_answers_2018, remap_answer_date, regrid_answer_date, adaptTimeRatio, adaptZoom, adaptZoomCoeff, adaptBuoyCoeff, adaptAlpha, adaptDoMin, adaptDrho0)¶

Can be used to set any of the parameters for MOM_regridding.

Parameters:

cs :: [inout] Regridding control structure
boundary_extrapolation :: [in] Extrapolate in boundary cells
min_thickness :: [in] Minimum thickness allowed when building the new grid [H ~> m or kg m-2]
old_grid_weight :: [in] Weight given to old coordinate when time-filtering grid [nondim]
interp_scheme :: [in] Interpolation method for state-dependent coordinates
depth_of_time_filter_shallow :: [in] Depth to start cubic [H ~> m or kg m-2]
depth_of_time_filter_deep :: [in] Depth to end cubic [H ~> m or kg m-2]
compress_fraction :: [in] Fraction of compressibility to add to potential density [nondim]
ref_pressure :: [in] The reference pressure for density-dependent coordinates [R L2 T-2 ~> Pa]
integrate_downward_for_e :: [in] If true, integrate for interface positions downward from the top.
remap_answers_2018 :: [in] If true, use the order of arithmetic and expressions that recover the remapping answers from 2018. Otherwise use more robust but mathematically equivalent expressions.
remap_answer_date :: [in] The vintage of the expressions to use for remapping
regrid_answer_date :: [in] The vintage of the expressions to use for regridding
adapttimeratio :: [in] Ratio of the ALE timestep to the grid timescale [nondim].
adaptzoom :: [in] Depth of near-surface zooming region [H ~> m or kg m-2].
adaptzoomcoeff :: [in] Coefficient of near-surface zooming diffusivity [nondim].
adaptbuoycoeff :: [in] Coefficient of buoyancy diffusivity [nondim].
adaptalpha :: [in] Scaling factor on optimization tendency [nondim].
adaptdomin :: [in] If true, make a HyCOM-like mixed layer by preventing interfaces from being shallower than the depths specified by the regridding coordinate.
adaptdrho0 :: [in] Reference density difference for stratification-dependent diffusion. [R ~> kg m-3]

Call to:

mom_error_handler::mom_error regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1 coord_adapt::set_adapt_params coord_hycom::set_hycom_params regrid_interp::set_interp_answer_date regrid_interp::set_interp_extrap regrid_interp::set_interp_scheme coord_sigma::set_sigma_params coord_zlike::set_zlike_params

Called from:

function mom_regridding/get_regrid_size(CS) [integer]¶

Returns the number of levels/layers in the regridding control structure.

Parameters:: cs :: [inout] Regridding control structure

function mom_regridding/get_zlike_cs(CS) [type(zlike_cs)]¶

This returns a copy of the zlike_CS stored in the regridding control structure.

Parameters:: cs :: [in] Regridding control structure
Called from:: mom_diag_remap::diag_remap_update

function mom_regridding/get_sigma_cs(CS) [type(sigma_cs)]¶

This returns a copy of the sigma_CS stored in the regridding control structure.

Parameters:: cs :: [in] Regridding control structure
Called from:: mom_diag_remap::diag_remap_update

function mom_regridding/get_rho_cs(CS) [type(rho_cs)]¶

This returns a copy of the rho_CS stored in the regridding control structure.

Parameters:: cs :: [in] Regridding control structure
Called from:: mom_diag_remap::diag_remap_update

function mom_regridding/getstaticthickness(CS, SSH, depth) [real]¶

Return coordinate-derived thicknesses for fixed coordinate systems.

Parameters:

cs :: [in] Regridding control structure
ssh :: [in] The sea surface height, in the same units as depth, often [Z ~> m]
depth :: [in] The maximum depth of the grid, often [Z ~> m]

Return:

undefined :: The returned thicknesses in the units of depth, often [Z ~> m]

Call to:

mom_error_handler::mom_error regrid_consts::regridding_adaptive regrid_consts::regridding_hybgen regrid_consts::regridding_hycom1

Called from:

mom_ale::ale_initthicknesstocoord

subroutine mom_regridding/dz_function1(string, dz)¶

Parses a string and generates a dz(:) profile that goes like k**power.

Parameters:

string :: [in] String with list of parameters in form dz_min, H_total, power, precision
dz :: [inout] Profile of nominal thicknesses [m] or other units

Call to:

Called from:

function mom_regridding/create_coord_param(param_prefix, param_name, param_suffix) [character(len=max_param_length)]¶

Construct the name of a parameter for a specific coordinate based on param_prefix and param_suffix. For the main, prognostic coordinate this will simply return the parameter name (e.g. P_REF)

Parameters:

param_name :: The base name of the parameter (e.g. the one used for the main coordinate)
param_prefix :: String to prefix to parameter names.
param_suffix :: String to append to parameter names.

Return:

undefined :: Parameter name prepended by param_prefix and appended with param_suffix

Call to:

max_param_length mom_error_handler::mom_error

Called from:

function mom_regridding/rho_function1(string, rho_target) [integer]¶

Parses a string and generates a rho_target(:) profile with refined resolution downward and returns the number of levels.

Parameters:

string :: [in] String with list of parameters in form dz_min, H_total, power, precision
rho_target :: [inout] Profile of interface densities [kg m-3]

Called from: