MOM6
|
Provides a transparent vertical ocean grid type and supporting routines.
Data Types | |
type | verticalgrid_type |
Describes the vertical ocean grid, including unit conversion factors. More... | |
Functions/Subroutines | |
subroutine, public | verticalgridinit (param_file, GV, US) |
Allocates and initializes the ocean model vertical grid structure. More... | |
subroutine, public | fix_restart_scaling (GV) |
Set the scaling factors for restart files to the scaling factors for this run. More... | |
character(len=48) function, public | get_thickness_units (GV) |
Returns the model's thickness units, usually m or kg/m^2. More... | |
character(len=48) function, public | get_flux_units (GV) |
Returns the model's thickness flux units, usually m^3/s or kg/s. More... | |
character(len=48) function, public | get_tr_flux_units (GV, tr_units, tr_vol_conc_units, tr_mass_conc_units) |
Returns the model's tracer flux units. More... | |
subroutine, public | setverticalgridaxes (Rlay, GV, scale) |
This sets the coordinate data for the "layer mode" of the isopycnal model. More... | |
subroutine, public | verticalgridend (GV) |
Deallocates the model's vertical grid structure. More... | |
subroutine, public mom_verticalgrid::fix_restart_scaling | ( | type(verticalgrid_type), intent(inout) | GV | ) |
Set the scaling factors for restart files to the scaling factors for this run.
[in,out] | gv | The ocean's vertical grid structure |
Definition at line 183 of file MOM_verticalGrid.F90.
character(len=48) function, public mom_verticalgrid::get_flux_units | ( | type(verticalgrid_type), intent(in) | GV | ) |
Returns the model's thickness flux units, usually m^3/s or kg/s.
[in] | gv | The ocean's vertical grid structure |
Definition at line 205 of file MOM_verticalGrid.F90.
Referenced by mom_dynamics_split_rk2::initialize_dyn_split_rk2(), mom_dynamics_unsplit::initialize_dyn_unsplit(), mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2(), mom_dynamics_split_rk2::register_restarts_dyn_split_rk2(), mom_dynamics_unsplit::register_restarts_dyn_unsplit(), mom_dynamics_unsplit_rk2::register_restarts_dyn_unsplit_rk2(), and mom::set_restart_fields().
character(len=48) function, public mom_verticalgrid::get_thickness_units | ( | type(verticalgrid_type), intent(in) | GV | ) |
Returns the model's thickness units, usually m or kg/m^2.
[in] | gv | The ocean's vertical grid structure |
Definition at line 190 of file MOM_verticalGrid.F90.
Referenced by mom_ale::ale_register_diags(), mom_diabatic_driver::diabatic_driver_init(), mom_geothermal::geothermal_init(), mom::register_diags(), mom_diagnostics::register_transport_diags(), and mom::set_restart_fields().
character(len=48) function, public mom_verticalgrid::get_tr_flux_units | ( | type(verticalgrid_type), intent(in) | GV, |
character(len=*), intent(in), optional | tr_units, | ||
character(len=*), intent(in), optional | tr_vol_conc_units, | ||
character(len=*), intent(in), optional | tr_mass_conc_units | ||
) |
Returns the model's tracer flux units.
[in] | gv | The ocean's vertical grid structure. |
[in] | tr_units | Units for a tracer, for example Celsius or PSU. |
[in] | 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. |
[in] | 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. |
Definition at line 220 of file MOM_verticalGrid.F90.
References mom_error_handler::mom_error().
Referenced by mom::initialize_mom().
subroutine, public mom_verticalgrid::setverticalgridaxes | ( | real, dimension(gv%ke), intent(in) | Rlay, |
type(verticalgrid_type), intent(inout) | GV, | ||
real, intent(in) | scale | ||
) |
This sets the coordinate data for the "layer mode" of the isopycnal model.
[in,out] | gv | The container for vertical grid data |
[in] | rlay | The layer target density [R ~> kg m-3] |
[in] | scale | A unit scaling factor for Rlay |
Definition at line 276 of file MOM_verticalGrid.F90.
Referenced by mom_coord_initialization::mom_initialize_coord().
subroutine, public mom_verticalgrid::verticalgridend | ( | type(verticalgrid_type), pointer | GV | ) |
Deallocates the model's vertical grid structure.
gv | The ocean's vertical grid structure |
Definition at line 299 of file MOM_verticalGrid.F90.
subroutine, public mom_verticalgrid::verticalgridinit | ( | type(param_file_type), intent(in) | param_file, |
type(verticalgrid_type), pointer | GV, | ||
type(unit_scale_type), intent(in) | US | ||
) |
Allocates and initializes the ocean model vertical grid structure.
[in] | param_file | Parameter file handle/type |
gv | The container for vertical grid data | |
[in] | us | A dimensional unit scaling type |
Definition at line 76 of file MOM_verticalGrid.F90.
References mom_error_handler::mom_error().
Referenced by mom_oda_driver_mod::init_oda().