mom_tracer_initialization_from_z module reference

Initializes hydrography from z-coordinate climatology files.

More…

Functions/Subroutines

mom_initialize_tracer_from_z()

Initializes a tracer from a z-space data file, including any lateral regridding that is needed.

Detailed Description

Initializes hydrography from z-coordinate climatology files.

Function/Subroutine Documentation

subroutine mom_tracer_initialization_from_z/mom_initialize_tracer_from_z(h, tr, G, GV, US, PF, src_file, src_var_nam, src_var_unit_conversion, src_var_record, homogenize, useALEremapping, remappingScheme, src_var_gridspec, h_in_Z_units, ongrid)

Initializes a tracer from a z-space data file, including any lateral regridding that is needed.

Parameters:

  • g :: [inout] Ocean grid structure.

  • gv :: [in] Ocean vertical grid structure.

  • us :: [in] A dimensional unit scaling type

  • h :: h [in] Layer thicknesses, in [H ~> m or kg m-2] or

  • tr :: tr Pointer to array to be initialized [CU ~> conc]

  • pf :: [in] parameter file

  • src_file :: src_file [in] source filename

  • src_var_nam :: src_var_nam [in] variable name in file

  • src_var_unit_conversion :: src_var_unit_conversion [in] optional multiplicative unit conversion, often used for rescaling into model units [CU conc-1 ~> 1]

  • src_var_record :: src_var_record [in] record to read for multiple time-level files

  • homogenize :: homogenize [in] optionally homogenize to mean value

  • usealeremapping :: [in] to remap or not (optional)

  • remappingscheme :: [in] remapping scheme to use.

  • src_var_gridspec :: src_var_gridspec [in] Source variable name in a gridspec file. This is not implemented yet.

  • h_in_z_units :: [in] If present and true, the input grid thicknesses are in the units of height ([Z ~> m]) instead of the usual units of thicknesses ([H ~> m or kg m-2])

  • ongrid :: ongrid [in] If true, then data are assumed to have been interpolated to the model horizontal grid. In this case, only extrapolation is performed by horiz_interp_and_extrap_tracer()

Call to:

mom_ale::ale_remap_scalar mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_interface_heights::dz_to_thickness_simple mom_remapping::initialize_remapping mdl mom_horizontal_regridding::mystats mom_regridding::set_dz_neglect mom_regridding::set_h_neglect

Called from:

marbl_tracers::initialize_marbl_tracers

[source]

[source]