Go to the documentation of this file.
20 implicit none ;
private
22 #include <MOM_memory.h>
40 subroutine user_set_coord(Rlay, g_prime, GV, US, param_file, eqn_of_state)
43 real,
dimension(:),
intent(out) :: rlay
44 real,
dimension(:),
intent(out) :: g_prime
50 type(
eos_type),
pointer :: eqn_of_state
54 "USER_initialization.F90, USER_set_coord: " // &
55 "Unmodified user routine called - you must edit the routine to use it")
66 real,
dimension(G%isd:G%ied,G%jsd:G%jed), &
69 real,
intent(in) :: max_depth
73 "USER_initialization.F90, USER_initialize_topography: " // &
74 "Unmodified user routine called - you must edit the routine to use it")
86 real,
dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
90 logical,
optional,
intent(in) :: just_read_params
96 "USER_initialization.F90, USER_initialize_thickness: " // &
97 "Unmodified user routine called - you must edit the routine to use it")
99 just_read = .false. ;
if (
present(just_read_params)) just_read = just_read_params
101 if (just_read)
return
112 real,
dimension(SZIB_(G), SZJ_(G), SZK_(G)),
intent(out) :: u
113 real,
dimension(SZI_(G), SZJB_(G), SZK_(G)),
intent(out) :: v
118 logical,
optional,
intent(in) :: just_read_params
124 "USER_initialization.F90, USER_initialize_velocity: " // &
125 "Unmodified user routine called - you must edit the routine to use it")
127 just_read = .false. ;
if (
present(just_read_params)) just_read = just_read_params
129 if (just_read)
return
142 real,
dimension(SZI_(G),SZJ_(G), SZK_(G)),
intent(out) :: t
143 real,
dimension(SZI_(G),SZJ_(G), SZK_(G)),
intent(out) :: s
147 type(
eos_type),
pointer :: eqn_of_state
149 logical,
optional,
intent(in) :: just_read_params
155 "USER_initialization.F90, USER_init_temperature_salinity: " // &
156 "Unmodified user routine called - you must edit the routine to use it")
158 just_read = .false. ;
if (
present(just_read_params)) just_read = just_read_params
160 if (just_read)
return
173 logical,
intent(in) :: use_temp
183 real,
dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
186 "USER_initialization.F90, USER_initialize_sponges: " // &
187 "Unmodified user routine called - you must edit the routine to use it")
219 "USER_initialization.F90, USER_set_rotation: " // &
220 "Unmodified user routine called - you must edit the routine to use it")
233 #include "version_variable.h"
234 character(len=40) :: mdl =
"user_initialization"
subroutine, public user_initialize_sponges(G, GV, use_temp, tv, param_file, CSp, h)
Set up the sponges.
integer, parameter, public obc_direction_n
Indicates the boundary is an effective northern boundary.
integer, parameter, public obc_direction_s
Indicates the boundary is an effective southern boundary.
Provides a transparent vertical ocean grid type and supporting routines.
subroutine, public user_initialize_thickness(h, G, GV, param_file, just_read_params)
initialize thicknesses.
subroutine, public set_up_sponge_field(sp_val, f_ptr, G, nlay, CS, sp_val_i_mean)
This subroutine stores the reference profile for the variable whose address is given by f_ptr....
An overloaded interface to log version information about modules.
Pointers to an assortment of thermodynamic fields that may be available, including potential temperat...
integer, parameter, public obc_direction_e
Indicates the boundary is an effective eastern boundary.
integer, parameter, public obc_direction_w
Indicates the boundary is an effective western boundary.
integer, parameter, public obc_simple
Indicates the use of a simple inflow open boundary.
Contains a shareable dynamic type for describing horizontal grids and metric data and utilty routines...
subroutine, public user_set_obc_data(OBC, tv, G, param_file, tr_Reg)
This subroutine sets the properties of flow at open boundary conditions.
subroutine write_user_log(param_file)
Write output about the parameter values being used.
subroutine, public mom_mesg(message, verb, all_print)
This provides a convenient interface for writing an informative comment.
Provides subroutines for quantities specific to the equation of state.
This module contains the tracer_registry_type and the subroutines that handle registration of tracers...
A structure that can be parsed to read and document run-time parameters.
An overloaded interface to read and log the values of various types of parameters.
Describes various unit conversion factors.
subroutine, public user_set_rotation(G, param_file)
A control structure for the equation of state.
Describes the vertical ocean grid, including unit conversion factors.
Provides transparent structures with groups of MOM6 variables and supporting routines.
subroutine, public user_set_coord(Rlay, g_prime, GV, US, param_file, eqn_of_state)
Set vertical coordinates.
Controls where open boundary conditions are applied.
The MOM6 facility to parse input files for runtime parameters.
Implements sponge regions in isopycnal mode.
subroutine, public user_initialize_topography(D, G, param_file, max_depth, US)
Initialize topography.
Calculate the derivatives of density with temperature and salinity from T, S, and P.
subroutine, public user_initialize_velocity(u, v, G, US, param_file, just_read_params)
initialize velocities.
Type to carry basic tracer information.
Provides the ocean grid type.
This control structure holds memory and parameters for the MOM_sponge module.
Provides a transparent unit rescaling type to facilitate dimensional consistency testing.
logical function, public is_root_pe()
This returns .true. if the current PE is the root PE.
subroutine, public mom_error(level, message, all_print)
This provides a convenient interface for writing an mpp_error message with run-time filter based on a...
subroutine, public user_init_temperature_salinity(T, S, G, param_file, eqn_of_state, just_read_params)
This function puts the initial layer temperatures and salinities into T(:,:,:) and S(:,...
integer, parameter, public obc_none
Indicates the use of no open boundary.
subroutine, public initialize_sponge(Iresttime, int_height, G, param_file, CS, GV, Iresttime_i_mean, int_height_i_mean)
This subroutine determines the number of points which are within sponges in this computational domain...
logical first_call
A module variable that should not be used.
Routines for error handling and I/O management.
Describes the horizontal ocean grid with only dynamic memory arrays.
Ocean grid type. See mom_grid for details.
A template of a user to code up customized initial conditions.
Calculates density of sea water from T, S and P.