mom_regridding module reference

Generates vertical grids as part of the ALE algorithm.

Data Types

regridding_cs

Regridding control structure.

Functions/Subroutines

`initialize_regridding()`	Initialization and configures a regridding control structure based on customizable run-time parameters.
`end_regridding()`	Deallocation of regridding memory.
`regridding_main()`	Dispatching regridding routine for orchestrating regridding & remapping.
`regridding_preadjust_reqs()`	This routine returns flags indicating which pre-remapping state adjustments are needed depending on the coordinate mode in use.
`calc_h_new_by_dz()`	Calculates h_new from h + delta_k dzInterface.
`check_grid_column()`	Check that the total thickness of new and old grids are consistent.
`filtered_grid_motion()`	Returns the change in interface position motion after filtering and assuming the top and bottom interfaces do not move.
`build_zstar_grid()`	Builds a z*-coordinate grid with partial steps (Adcroft and Campin, 2004).
`build_sigma_grid()`	This routine builds a grid based on terrain-following coordinates.
`build_rho_grid()`	This routine builds a new grid based on a given set of target interface densities.
`build_grid_hycom1()`	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.
`build_grid_adaptive()`	This subroutine builds an adaptive grid that follows density surfaces where possible, subject to constraints on the smoothness of interface heights.
`adjust_interface_motion()`	Adjust dz_Interface to ensure non-negative future thicknesses.
`inflate_vanished_layers_old()`	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.
`convective_adjustment()`	Achieve convective adjustment by swapping layers.
`uniformresolution()`	Return a uniform resolution vector in the units of the coordinate.
`initcoord()`	Initialize the coordinate resolutions by calling the appropriate initialization routine for the specified coordinate mode.
`setcoordinateresolution()`	Set the fixed resolution data.
`setcoordinateresolution_3d()`	Set the 3d fixed resolution data.
`set_target_densities_from_gv()`	Set target densities based on the old Rlay variable.
`set_target_densities_3d()`	Set target densities based on vector of interface values.
`set_target_densities()`	Set target densities based on vector of interface values.
`set_regrid_max_depths()`	Set maximum interface depths based on a vector of input values.
`set_regrid_max_thickness()`	Set maximum layer thicknesses based on a vector of input values.
`write_regrid_file()`	Write the vertical coordinate information into a file.
`set_h_neglect()`	Set appropriate values for the negligible thicknesses used for remapping based on an answer date.
`set_dz_neglect()`	Set appropriate values for the negligible vertical layer extents used for remapping based on an answer date.
`getcoordinateresolution()`	Query the fixed resolution data.
`getcoordinateinterfaces()`	Query the target coordinate interface positions.
`getcoordinateunits()`	Query the target coordinate units.
`getcoordinateshortname()`	Query the short name of the coordinate.
`set_regrid_params()`	Can be used to set any of the parameters for MOM_regridding.
`get_regrid_size()`	Returns the number of levels/layers in the regridding control structure.
`get_zlike_cs()`	This returns a copy of the zlike_CS stored in the regridding control structure.
`get_sigma_cs()`	This returns a copy of the sigma_CS stored in the regridding control structure.
`get_rho_cs()`	This returns a copy of the rho_CS stored in the regridding control structure.
`getstaticthickness()`	Return coordinate-derived thicknesses for fixed coordinate systems.
`dz_function1()`	Parses a string and generates a dz(:) profile that goes like k**power.
`create_coord_param()`	Construct the name of a parameter for a specific coordinate based on param_prefix and param_suffix.
`rho_function1()`	Parses a string and generates a rho_target(:) profile with refined resolution downward and returns the number of levels.

Detailed Description

A vertical grid is defined solely by the cell thicknesses, \(h\). Most calculations in this module start with the coordinate at the bottom of the column set to -depth, and use a increasing value of coordinate with decreasing k. This is consistent with the rest of MOM6 that uses position, \(z\) which is a negative quantity for most of the ocean.

A change in grid is define through a change in position of the interfaces:

\[z^n_{k+1/2} = z^{n-1}_{k+1/2} + \Delta z_{k+1/2}\]

with the positive upward coordinate convention

\[z_{k-1/2} = z_{k+1/2} + h_k\]

so that

\[h^n_k = h^{n-1}_k + ( \Delta z_{k-1/2} - \Delta z_{k+1/2} )\]

Original date of creation: 2008.06.09 by L. White

Type Documentation

type mom_regridding/regridding_cs