mom_tracer_z_init logical function, public logical function, public mom_tracer_z_init::tracer_z_init (tr, h, filename, tr_name, G, US, missing_val, land_val) tracer_z_init tr tr h h filename filename tr_name tr_name G G US US missing_val missing_val land_val land_val This function initializes a tracer by reading a Z-space file, returning .true. if this appears to have been successful, and false otherwise. A return code indicating if the initialization has been successful g The ocean's grid structure us A dimensional unit scaling type tr The tracer to initialize h Layer thicknesses [H ~> m or kg m-2] filename The name of the file to read from tr_name The name of the tracer in the file missing_val The missing value for the tracer land_val A value to use to fill in land points find_limited_slope find_overlap mom_error_handler::mom_error read_z_edges mom_ocmip2_cfc::init_tracer_cfc ideal_age_example::initialize_ideal_age_tracer mom_generic_tracer::initialize_mom_generic_tracer oil_tracer::initialize_oil_tracer subroutine, public subroutine, public mom_tracer_z_init::tracer_z_init_array (tr_in, z_edges, nk_data, e, land_fill, G, nlay, nlevs, eps_z, tr) tracer_z_init_array tr_in tr_in z_edges z_edges nk_data nk_data e e land_fill land_fill G G nlay nlay nlevs nlevs eps_z eps_z tr tr Layer model routine for remapping tracers from pseudo-z coordinates into layers defined by target interface positions. g The ocean's grid structure nk_data The number of levels in the input data tr_in The z-space array of tracer concentrations that is read in. z_edges The depths of the cell edges in the input z* data [Z ~> m or m] nlay The number of vertical layers in the target grid e The depths of the target layer interfaces [Z ~> m or m] land_fill fill in data over land (1) nlevs The number of input levels with valid data eps_z A negligibly thin layer thickness [Z ~> m]. tr tracers in layer space find_limited_slope find_overlap subroutine subroutine mom_tracer_z_init::read_z_edges (filename, tr_name, z_edges, nz_out, has_edges, use_missing, missing, scale) read_z_edges filename filename tr_name tr_name z_edges z_edges nz_out nz_out has_edges has_edges use_missing use_missing missing missing scale scale This subroutine reads the vertical coordinate data for a field from a NetCDF file. It also might read the missing value attribute for that same field. filename The name of the file to read from. tr_name The name of the tracer in the file. z_edges The depths of the vertical edges of the tracer array nz_out The number of vertical layers in the tracer array has_edges If true the values in z_edges are the edges of the tracer cells, otherwise they are the cell centers use_missing If false on input, see whether the tracer has a missing value, and if so return true missing The missing value, if one has been found scale A scaling factor for z_edges into new units. mom_error_handler::mom_error mom_error_handler::mom_mesg tracer_z_init subroutine subroutine mom_tracer_z_init::find_overlap (e, Z_top, Z_bot, k_max, k_start, k_top, k_bot, wt, z1, z2) find_overlap e e Z_top Z_top Z_bot Z_bot k_max k_max k_start k_start k_top k_top k_bot k_bot wt wt z1 z1 z2 z2 Determines the layers bounded by interfaces e that overlap with the depth range between Z_top and Z_bot, and the fractional weights of each layer. It also calculates the normalized relative depths of the range of each layer that overlaps that depth range. e Column interface heights, [Z ~> m] or other units. z_top Top of range being mapped to, in the units of e [Z ~> m]. z_bot Bottom of range being mapped to, in the units of e [Z ~> m]. k_max Number of valid layers. k_start Layer at which to start searching. k_top Indices of top layers that overlap with the depth range. k_bot Indices of bottom layers that overlap with the depth range. wt Relative weights of each layer from k_top to k_bot [nondim]. z1 Depth of the top limits of the part of a layer that contributes to a depth level, relative to the cell center and normalized by the cell thickness [nondim]. Note that -1/2 <= z1 < z2 <= 1/2. z2 Depths of the bottom limit of the part of a layer that contributes to a depth level, relative to the cell center and normalized by the cell thickness [nondim]. Note that -1/2 <= z1 < z2 <= 1/2. tracer_z_init tracer_z_init_array real function real function mom_tracer_z_init::find_limited_slope (val, e, k) find_limited_slope val val e e k k This subroutine determines a limited slope for val to be advected with a piecewise limited scheme. val An column the values that are being interpolated. e A column's interface heights [Z ~> m] or other units. k The layer whose slope is being determined. The normalized slope in the intracell distribution of val. tracer_z_init tracer_z_init_array subroutine, public subroutine, public mom_tracer_z_init::determine_temperature (temp, salt, R_tgt, p_ref, niter, land_fill, h, k_start, G, US, eos, h_massless) determine_temperature temp temp salt salt R_tgt R_tgt p_ref p_ref niter niter land_fill land_fill h h k_start k_start G G US US eos eos h_massless h_massless This subroutine determines the potential temperature and salinity that is consistent with the target density using provided initial guess. g The ocean's grid structure temp potential temperature [degC] salt salinity [PSU] r_tgt desired potential density [R ~> kg m-3]. p_ref reference pressure [R L2 T-2 ~> Pa]. niter maximum number of iterations k_start starting index (i.e. below the buffer layer) land_fill land fill value h layer thickness, used only to avoid working on us A dimensional unit scaling type eos seawater equation of state control structure h_massless A threshold below which a layer is determined to be massless [H ~> m or kg m-2] mom_eos::eos_domain Used to initialize tracers from a depth- (or z*-) space file.