MOM6
|
Initializes fixed aspects of the related to its vertical coordinate.
Functions/Subroutines | |
subroutine, public | mom_initialize_coord (GV, US, PF, write_geom, output_dir, tv, max_depth) |
MOM_initialize_coord sets up time-invariant quantities related to MOM6's vertical coordinate. More... | |
subroutine | set_coord_from_gprime (Rlay, g_prime, GV, US, param_file) |
Sets the layer densities (Rlay) and the interface reduced gravities (g). More... | |
subroutine | set_coord_from_layer_density (Rlay, g_prime, GV, US, param_file) |
Sets the layer densities (Rlay) and the interface reduced gravities (g). More... | |
subroutine | set_coord_from_ts_ref (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a profile of g'. More... | |
subroutine | set_coord_from_ts_profile (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a T-S profile. More... | |
subroutine | set_coord_from_ts_range (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a linear T-S profile. More... | |
subroutine | set_coord_from_file (Rlay, g_prime, GV, US, param_file) |
subroutine | set_coord_linear (Rlay, g_prime, GV, US, param_file) |
Sets the layer densities (Rlay) and the interface reduced gravities (g) according to a linear profile starting at a reference surface layer density and spanning a range of densities to the bottom defined by the parameter RLAY_RANGE (defaulting to 2.0 if not defined) More... | |
subroutine | set_coord_to_none (Rlay, g_prime, GV, US, param_file) |
Sets Rlay to Rho0 and g_prime to zero except for the free surface. This is for use only in ALE mode where Rlay should not be used and g_prime(1) alone might be used. More... | |
subroutine | write_vertgrid_file (GV, US, param_file, directory) |
Writes out a file containing any available data related to the vertical grid used by the MOM ocean model. More... | |
Variables | |
character(len=40) | mdl = "MOM_coord_initialization" |
This module's name. More... | |
subroutine, public mom_coord_initialization::mom_initialize_coord | ( | type(verticalgrid_type), intent(inout) | GV, |
type(unit_scale_type), intent(in) | US, | ||
type(param_file_type), intent(in) | PF, | ||
logical, intent(in) | write_geom, | ||
character(len=*), intent(in) | output_dir, | ||
type(thermo_var_ptrs), intent(inout) | tv, | ||
real, intent(in) | max_depth | ||
) |
MOM_initialize_coord sets up time-invariant quantities related to MOM6's vertical coordinate.
[in,out] | gv | Ocean vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | pf | A structure indicating the open file to parse for model parameter values. |
[in] | write_geom | If true, write grid geometry files. |
[in] | output_dir | The directory into which to write files. |
[in,out] | tv | The thermodynamic variable structure. |
[in] | max_depth | The ocean's maximum depth [Z ~> m]. |
Definition at line 40 of file MOM_coord_initialization.F90.
References bfb_initialization::bfb_set_coord(), mom_error_handler::calltree_enter(), mom_error_handler::calltree_leave(), mdl, set_coord_from_file(), set_coord_from_gprime(), set_coord_from_layer_density(), set_coord_from_ts_profile(), set_coord_from_ts_range(), set_coord_from_ts_ref(), set_coord_linear(), set_coord_to_none(), mom_verticalgrid::setverticalgridaxes(), user_initialization::user_set_coord(), and write_vertgrid_file().
Referenced by mom_oda_driver_mod::init_oda(), and mom::initialize_mom().
|
private |
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
Definition at line 385 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g).
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
Definition at line 126 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g).
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
Definition at line 160 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a T-S profile.
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
eqn_of_state | integer that selects equation of state. | |
[in] | p_ref | The coordinate-density reference pressure [Pa]. |
Definition at line 254 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a linear T-S profile.
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
eqn_of_state | integer that selects equation of state | |
[in] | p_ref | The coordinate-density reference pressure [Pa] |
Definition at line 302 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g) from a profile of g'.
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
eqn_of_state | integer selecting the equation of state. | |
[in] | p_ref | The coordinate-density reference pressure [Pa]. |
Definition at line 203 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets the layer densities (Rlay) and the interface reduced gravities (g) according to a linear profile starting at a reference surface layer density and spanning a range of densities to the bottom defined by the parameter RLAY_RANGE (defaulting to 2.0 if not defined)
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
Definition at line 437 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Sets Rlay to Rho0 and g_prime to zero except for the free surface. This is for use only in ALE mode where Rlay should not be used and g_prime(1) alone might be used.
[out] | rlay | The layers' target coordinate values (potential density) [R ~> kg m-3]. |
[out] | g_prime | The reduced gravity across the interfaces, [L2 Z-1 T-2 ~> m s-2]. |
[in] | gv | The ocean's vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
Definition at line 481 of file MOM_coord_initialization.F90.
References mom_error_handler::calltree_enter(), and mom_error_handler::calltree_leave().
Referenced by mom_initialize_coord().
|
private |
Writes out a file containing any available data related to the vertical grid used by the MOM ocean model.
[in] | gv | The ocean's vertical grid structure |
[in] | us | A dimensional unit scaling type |
[in] | param_file | A structure to parse for run-time parameters |
[in] | directory | The directory into which to place the file. |
Definition at line 512 of file MOM_coord_initialization.F90.
References mom_io::var_desc().
Referenced by mom_initialize_coord().
|
private |
This module's name.
Definition at line 33 of file MOM_coord_initialization.F90.
Referenced by mom_initialize_coord().