coord_rho coord_rho::rho_cs subroutine, public subroutine, public coord_rho::init_coord_rho (CS, nk, ref_pressure, target_density, interp_CS) init_coord_rho CS CS nk nk ref_pressure ref_pressure target_density target_density interp_CS interp_CS Initialise a rho_CS with pointers to parameters. cs Unassociated pointer to hold the control structure nk Number of layers in the grid ref_pressure Coordinate reference pressure [R L2 T-2 ~> Pa] target_density Nominal density of interfaces [R ~> kg m-3] interp_cs Controls for interpolation mom_error_handler::mom_error subroutine, public subroutine, public coord_rho::end_coord_rho (CS) end_coord_rho CS CS This subroutine deallocates memory in the control structure for the coord_rho module. cs Coordinate control structure subroutine, public subroutine, public coord_rho::set_rho_params (CS, min_thickness, integrate_downward_for_e, interp_CS) set_rho_params CS CS min_thickness min_thickness integrate_downward_for_e integrate_downward_for_e interp_CS interp_CS This subroutine can be used to set the parameters for the coord_rho module. cs Coordinate control structure min_thickness Minimum allowed thickness [H ~> m or kg m-2] integrate_downward_for_e If true, integrate for interface positions from the top downward. If false, integrate from the bottom upward, as does the rest of the model. interp_cs Controls for interpolation mom_error_handler::mom_error subroutine, public subroutine, public coord_rho::build_rho_column (CS, nz, depth, h, T, S, eqn_of_state, z_interface, h_neglect, h_neglect_edge) build_rho_column CS CS nz nz depth depth h h T T S S eqn_of_state eqn_of_state z_interface z_interface h_neglect h_neglect h_neglect_edge h_neglect_edge Build a rho coordinate column. Density profiles are calculated on the source grid.Positions of target densities (for interfaces) are found by interpolation. cs coord_rho control structure nz Number of levels on source grid (i.e. length of h, T, S) depth Depth of ocean bottom (positive downward) [H ~> m or kg m-2] h Layer thicknesses [H ~> m or kg m-2] t Temperature for source column [degC] s Salinity for source column [ppt] eqn_of_state Equation of state structure z_interface Absolute positions of interfaces h_neglect A negligibly small width for the purpose of cell reconstructions [H ~> m or kg m-2] h_neglect_edge A negligibly small width for the purpose of edge value calculations [H ~> m or kg m-2] regrid_interp::build_and_interpolate_grid copy_finite_thicknesses old_inflate_layers_1d mom_diag_remap::diag_remap_update subroutine subroutine coord_rho::build_rho_column_iteratively (CS, remapCS, nz, depth, h, T, S, eqn_of_state, zInterface, h_neglect, h_neglect_edge, dev_tol) build_rho_column_iteratively CS CS remapCS remapCS nz nz depth depth h h T T S S eqn_of_state eqn_of_state zInterface zInterface h_neglect h_neglect h_neglect_edge h_neglect_edge dev_tol dev_tol Iteratively build a rho coordinate column. The algorithm operates as follows within each column: Given T & S within each layer, the layer densities are computed.Based on these layer densities, a global density profile is reconstructed (this profile is monotonically increasing and may be discontinuous)The new grid interfaces are determined based on the target interface densities.T & S are remapped onto the new grid.Return to step 1 until convergence or until the maximum number of iterations is reached, whichever comes first. cs Regridding control structure remapcs Remapping parameters and options nz Number of levels depth Depth of ocean bottom [Z ~> m] h Layer thicknesses in Z coordinates [Z ~> m] t T for column [degC] s S for column [ppt] eqn_of_state Equation of state structure zinterface Absolute positions of interfaces h_neglect A negligibly small width for the purpose of cell reconstructions in the same units as h [Z ~> m] h_neglect_edge A negligibly small width for the purpose of edge value calculations in the same units as h [Z ~> m] dev_tol The tolerance for the deviation between successive grids for determining when the iterative solver has converged [Z ~> m] regrid_interp::build_and_interpolate_grid copy_finite_thicknesses old_inflate_layers_1d mom_remapping::remapping_core_h subroutine subroutine coord_rho::copy_finite_thicknesses (nk, h_in, thresh, nout, h_out, mapping) copy_finite_thicknesses nk nk h_in h_in thresh thresh nout nout h_out h_out mapping mapping Copy column thicknesses with vanished layers removed. nk Number of layer for h_in, T_in, S_in h_in Thickness of input column [H ~> m or kg m-2] or [Z ~> m] thresh Thickness threshold defining vanished layers [H ~> m or kg m-2] or [Z ~> m] nout Number of non-vanished layers h_out Thickness of output column [H ~> m or kg m-2] or [Z ~> m] mapping Index of k-out corresponding to k-in build_rho_column build_rho_column_iteratively subroutine, public subroutine, public coord_rho::old_inflate_layers_1d (min_thickness, nk, h) old_inflate_layers_1d min_thickness min_thickness nk nk h h Inflate vanished layers to finite (nonzero) width. min_thickness Minimum allowed thickness [H ~> m or kg m-2] nk Number of layers in the grid h Layer thicknesses [H ~> m or kg m-2] build_rho_column build_rho_column_iteratively mom_regridding::inflate_vanished_layers_old Regrid columns for the continuous isopycnal (rho) coordinate.