namespace mom_verticalgrid

Overview

Provides a transparent vertical ocean grid type and supporting routines. More…

namespace mom_verticalgrid {

// global functions

subroutine, public verticalgridinit(param_file param_file, GV GV, US US);
subroutine, public fix_restart_scaling(GV GV);
character(len=48) function, public get_thickness_units(GV GV);
character(len=48) function, public get_flux_units(GV GV);

character(len=48) function, public get_tr_flux_units(
    GV GV,
    tr_units tr_units,
    tr_vol_conc_units tr_vol_conc_units,
    tr_mass_conc_units tr_mass_conc_units
    );

subroutine, public setverticalgridaxes(Rlay Rlay, GV GV);
subroutine, public verticalgridend(GV GV);

} // namespace mom_verticalgrid

Detailed Documentation

Provides a transparent vertical ocean grid type and supporting routines.

Global Functions

subroutine, public verticalgridinit(param_file param_file, GV GV, US US)

Allocates and initializes the ocean model vertical grid structure.

Parameters:

param_file	Parameter file handle/type
gv	The container for vertical grid data
us	A dimensional unit scaling type

subroutine, public fix_restart_scaling(GV GV)

Set the scaling factors for restart files to the scaling factors for this run.

Parameters:

gv	The ocean’s vertical grid structure

character(len=48) function, public get_thickness_units(GV GV)

Returns the model’s thickness units, usually m or kg/m^2.

Parameters:

gv	The ocean’s vertical grid structure

Returns:

The vertical thickness units

character(len=48) function, public get_flux_units(GV GV)

Returns the model’s thickness flux units, usually m^3/s or kg/s.

Parameters:

gv	The ocean’s vertical grid structure

Returns:

The thickness flux units

character(len=48) function, public get_tr_flux_units(
    GV GV,
    tr_units tr_units,
    tr_vol_conc_units tr_vol_conc_units,
    tr_mass_conc_units tr_mass_conc_units
    )

Returns the model’s tracer flux units.

Parameters:

gv	The ocean’s vertical grid structure.
tr_units	Units for a tracer, for example Celsius or PSU.
tr_vol_conc_units	The concentration units per unit volume, for example if the units are umol m-3, tr_vol_conc_units would be umol.
tr_mass_conc_units	The concentration units per unit mass of sea water, for example if the units are mol kg-1, tr_vol_conc_units would be mol.

Returns:

The model’s flux units for a tracer.

subroutine, public setverticalgridaxes(Rlay Rlay, GV GV)

This sets the coordinate data for the “layer mode” of the isopycnal model.

Parameters:

gv	The container for vertical grid data
rlay	The layer target density

subroutine, public verticalgridend(GV GV)

Deallocates the model’s vertical grid structure.

Parameters:

gv	The ocean’s vertical grid structure