namespace mom_tracer_initialization_from_z

Overview

Initializes hydrography from z-coordinate climatology files. More…

namespace mom_tracer_initialization_from_z {

// global functions

subroutine, public mom_initialize_tracer_from_z(
    h h,
    tr tr,
    G G,
    GV GV,
    US US,
    PF PF,
    src_file src_file,
    src_var_nam src_var_nam,
    src_var_unit_conversion src_var_unit_conversion,
    src_var_record src_var_record,
    homogenize homogenize,
    useALEremapping useALEremapping,
    remappingScheme remappingScheme,
    src_var_gridspec src_var_gridspec
    );

} // namespace mom_tracer_initialization_from_z

Detailed Documentation

Initializes hydrography from z-coordinate climatology files.

Global Functions

subroutine, public mom_initialize_tracer_from_z(
    h h,
    tr tr,
    G G,
    GV GV,
    US US,
    PF PF,
    src_file src_file,
    src_var_nam src_var_nam,
    src_var_unit_conversion src_var_unit_conversion,
    src_var_record src_var_record,
    homogenize homogenize,
    useALEremapping useALEremapping,
    remappingScheme remappingScheme,
    src_var_gridspec src_var_gridspec
    )

Initializes a tracer from a z-space data file.

Parameters:

g	Ocean grid structure.
gv	Ocean vertical grid structure.
us	A dimensional unit scaling type
h	Layer thickness [H ~> m or kg m-2].
tr	Pointer to array to be initialized
pf	parameter file
src_file	source filename
src_var_nam	variable name in file
src_var_unit_conversion	optional multiplicative unit conversion
src_var_record	record to read for multiple time-level files
homogenize	optionally homogenize to mean value
usealeremapping	to remap or not (optional)
remappingscheme	remapping scheme to use.
src_var_gridspec	Source variable name in a gridspec file. This is not implemented yet.