namespace mom_tracer_z_init

Overview

Used to initialize tracers from a depth- (or z*-) space file. More…

namespace mom_tracer_z_init {

// global functions

logical function, public 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
    );

} // namespace mom_tracer_z_init

Detailed Documentation

Used to initialize tracers from a depth- (or z*-) space file.

Global Functions

logical function, public 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.

Parameters:

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

Returns:

A return code indicating if the initialization has been successful