Detailed Description

A template of a user to code up customized initial conditions.

This subroutine initializes the fields for the simulations. The one argument passed to initialize, Time, is set to the current time of the simulation. The fields which are initialized here are:

u - Zonal velocity [m s-1].
v - Meridional velocity [m s-1].
h - Layer thickness [H ~> m or kg m-2]. (Must be positive.)
GbathyT - Basin depth [Z ~> m]. (Must be positive.)
GCoriolisBu - The Coriolis parameter [T-1 ~> s-1].
GVg_prime - The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].
GVRlay - Layer potential density (coordinate variable) [R ~> kg m-3]. If ENABLE_THERMODYNAMICS is defined:
T - Temperature [degC].
S - Salinity [psu]. If BULKMIXEDLAYER is defined:
Rml - Mixed layer and buffer layer potential densities [kg m-3]. If SPONGE is defined:
A series of subroutine calls are made to set up the damping rates and reference profiles for all variables that are damped in the sponge.

Any user provided tracer code is also first linked through this subroutine.

These variables are all set in the set of subroutines (in this file) USER_initialize_bottom_depth, USER_initialize_thickness, USER_initialize_velocity, USER_initialize_temperature_salinity, USER_initialize_mixed_layer_density, USER_initialize_sponges, USER_set_coord, and USER_set_ref_profile.

The names of these subroutines should be self-explanatory. They start with "USER_" to indicate that they will likely have to be modified for each simulation to set the initial conditions and boundary conditions. Most of these take two arguments: an integer argument specifying whether the fields are to be calculated internally or read from a NetCDF file; and a string giving the path to that file. If the field is initialized internally, the path is ignored.

Functions/Subroutines
subroutine, public	user_set_coord (Rlay, g_prime, GV, US, param_file, eqn_of_state)
	Set vertical coordinates. More...

subroutine, public	user_initialize_topography (D, G, param_file, max_depth, US)
	Initialize topography. More...

subroutine, public	user_initialize_thickness (h, G, GV, param_file, just_read_params)
	initialize thicknesses. More...

subroutine, public	user_initialize_velocity (u, v, G, US, param_file, just_read_params)
	initialize velocities. More...

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(:,:,:). More...

subroutine, public	user_initialize_sponges (G, GV, use_temp, tv, param_file, CSp, h)
	Set up the sponges. More...

subroutine, public	user_set_obc_data (OBC, tv, G, param_file, tr_Reg)
	This subroutine sets the properties of flow at open boundary conditions. More...

subroutine, public	user_set_rotation (G, param_file)

subroutine	write_user_log (param_file)
	Write output about the parameter values being used. More...

Variables
logical	first_call = .true.
	A module variable that should not be used. More...

Function/Subroutine Documentation

◆ user_init_temperature_salinity()

subroutine, public user_initialization::user_init_temperature_salinity	(	real, dimension(szi_(g),szj_(g), szk_(g)), intent(out)	T,
		real, dimension(szi_(g),szj_(g), szk_(g)), intent(out)	S,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(eos_type), pointer	eqn_of_state,
		logical, intent(in), optional	just_read_params
	)

This function puts the initial layer temperatures and salinities into T(:,:,:) and S(:,:,:).

Parameters

[in]	g	Ocean grid structure.
[out]	t	Potential temperature [degC].
[out]	s	Salinity [ppt].
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	eqn_of_state	Integer that selects the equation of state.
[in]	just_read_params	If present and true, this call will only read parameters without changing T & S.

Definition at line 141 of file user_initialization.F90.

   type(ocean_grid_type),                     intent(in)  :: G !< Ocean grid structure.
   real, dimension(SZI_(G),SZJ_(G), SZK_(G)), intent(out) :: T !< Potential temperature [degC].
   real, dimension(SZI_(G),SZJ_(G), SZK_(G)), intent(out) :: S !< Salinity [ppt].
   type(param_file_type),                     intent(in)  :: param_file !< A structure indicating the
                                                             !! open file to parse for model
                                                             !! parameter values.
   type(EOS_type),                            pointer     :: eqn_of_state !< Integer that selects the
                                                             !! equation of state.
   logical,       optional, intent(in)  :: just_read_params !< If present and true, this call will only
                                                            !! read parameters without changing T & S.
  
   logical :: just_read    ! If true, just read parameters but set nothing.
  
   call mom_error(fatal, &
     "USER_initialization.F90, USER_init_temperature_salinity: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   just_read = .false. ; if (present(just_read_params)) just_read = just_read_params
  
   if (just_read) return ! All run-time parameters have been read, so return.
  
   t(:,:,1) = 0.0
   s(:,:,1) = 0.0
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Here is the call graph for this function:

◆ user_initialize_sponges()

subroutine, public user_initialization::user_initialize_sponges	(	type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		logical, intent(in)	use_temp,
		type(thermo_var_ptrs), intent(in)	tv,
		type(param_file_type), intent(in)	param_file,
		type(sponge_cs), pointer	CSp,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke), intent(in)	h
	)

Set up the sponges.

Parameters

[in]	g	Ocean grid structure.
[in]	gv	The ocean's vertical grid structure.
[in]	use_temp	If true, temperature and salinity are state variables.
[in]	tv	A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	csp	A pointer to the sponge control structure.
[in]	h	Layer thicknesses [H ~> m or kg m-2].

Definition at line 171 of file user_initialization.F90.

   type(ocean_grid_type),   intent(in) :: G             !< Ocean grid structure.
   type(verticalGrid_type), intent(in) :: GV            !< The ocean's vertical grid structure.
   logical,                 intent(in) :: use_temp      !< If true, temperature and salinity are state variables.
   type(thermo_var_ptrs),   intent(in) :: tv            !< A structure containing pointers
                                                        !! to any available thermodynamic
                                                        !! fields, potential temperature and
                                                        !! salinity or mixed layer density.
                                                        !! Absent fields have NULL ptrs.
   type(param_file_type),   intent(in) :: param_file    !< A structure indicating the
                                                        !! open file to parse for model
                                                        !! parameter values.
   type(sponge_CS),         pointer    :: CSp           !< A pointer to the sponge control structure.
   real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
                            intent(in) :: h             !< Layer thicknesses [H ~> m or kg m-2].
   call mom_error(fatal, &
     "USER_initialization.F90, USER_initialize_sponges: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Referenced by mom_state_initialization::mom_initialize_state().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_initialize_thickness()

subroutine, public user_initialization::user_initialize_thickness	(	real, dimension(szi_(g),szj_(g),szk_(gv)), intent(out)	h,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(param_file_type), intent(in)	param_file,
		logical, intent(in), optional	just_read_params
	)

initialize thicknesses.

Parameters

[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[out]	h	The thicknesses being initialized [H ~> m or kg m-2].
[in]	param_file	A structure indicating the open file to parse for model parameter values.
[in]	just_read_params	If present and true, this call will only read parameters without changing h.

Definition at line 84 of file user_initialization.F90.

   type(ocean_grid_type),   intent(in)  :: G  !< The ocean's grid structure.
   type(verticalGrid_type), intent(in)  :: GV !< The ocean's vertical grid structure.
   real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
                            intent(out) :: h  !< The thicknesses being initialized [H ~> m or kg m-2].
   type(param_file_type),   intent(in)  :: param_file !< A structure indicating the open
                                              !! file to parse for model parameter values.
   logical,       optional, intent(in)  :: just_read_params !< If present and true, this call will
                                              !! only read parameters without changing h.
  
   logical :: just_read    ! If true, just read parameters but set nothing.
  
   call mom_error(fatal, &
     "USER_initialization.F90, USER_initialize_thickness: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   just_read = .false. ; if (present(just_read_params)) just_read = just_read_params
  
   if (just_read) return ! All run-time parameters have been read, so return.
  
   h(:,:,1) = 0.0 ! h should be set [H ~> m or kg m-2].
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Here is the call graph for this function:

◆ user_initialize_topography()

subroutine, public user_initialization::user_initialize_topography	(	real, dimension(g%isd:g%ied,g%jsd:g%jed), intent(out)	D,
		type(dyn_horgrid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		real, intent(in)	max_depth,
		type(unit_scale_type), intent(in), optional	US
	)

Initialize topography.

Parameters

[in]	g	The dynamic horizontal grid type
[out]	d	Ocean bottom depth in m or Z if US is present
[in]	param_file	Parameter file structure
[in]	max_depth	Maximum model depth in the units of D
[in]	us	A dimensional unit scaling type

Definition at line 65 of file user_initialization.F90.

   type(dyn_horgrid_type),          intent(in)  :: G !< The dynamic horizontal grid type
   real, dimension(G%isd:G%ied,G%jsd:G%jed), &
                                    intent(out) :: D !< Ocean bottom depth in m or Z if US is present
   type(param_file_type),           intent(in)  :: param_file !< Parameter file structure
   real,                            intent(in)  :: max_depth !< Maximum model depth in the units of D
   type(unit_scale_type), optional, intent(in)  :: US !< A dimensional unit scaling type
  
   call mom_error(fatal, &
     "USER_initialization.F90, USER_initialize_topography: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   d(:,:) = 0.0
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Referenced by mom_fixed_initialization::mom_initialize_topography().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_initialize_velocity()

subroutine, public user_initialization::user_initialize_velocity	(	real, dimension(szib_(g), szj_(g), szk_(g)), intent(out)	u,
		real, dimension(szi_(g), szjb_(g), szk_(g)), intent(out)	v,
		type(ocean_grid_type), intent(in)	G,
		type(unit_scale_type), intent(in)	US,
		type(param_file_type), intent(in)	param_file,
		logical, intent(in), optional	just_read_params
	)

initialize velocities.

Parameters

[in]	g	Ocean grid structure.
[out]	u	i-component of velocity [L T-1 ~> m s-1]
[out]	v	j-component of velocity [L T-1 ~> m s-1]
[in]	us	A dimensional unit scaling type
[in]	param_file	A structure indicating the open file to parse for model parameter values.
[in]	just_read_params	If present and true, this call will only read parameters without changing h.

Definition at line 111 of file user_initialization.F90.

   type(ocean_grid_type),                       intent(in)  :: G !< Ocean grid structure.
   real, dimension(SZIB_(G), SZJ_(G), SZK_(G)), intent(out) :: u !< i-component of velocity [L T-1 ~> m s-1]
   real, dimension(SZI_(G), SZJB_(G), SZK_(G)), intent(out) :: v !< j-component of velocity [L T-1 ~> m s-1]
   type(unit_scale_type),                       intent(in)  :: US !< A dimensional unit scaling type
   type(param_file_type),                       intent(in)  :: param_file !< A structure indicating the
                                                             !! open file to parse for model
                                                             !! parameter values.
   logical,       optional, intent(in)  :: just_read_params !< If present and true, this call will
                                                       !! only read parameters without changing h.
  
   logical :: just_read    ! If true, just read parameters but set nothing.
  
   call mom_error(fatal, &
     "USER_initialization.F90, USER_initialize_velocity: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   just_read = .false. ; if (present(just_read_params)) just_read = just_read_params
  
   if (just_read) return ! All run-time parameters have been read, so return.
  
   u(:,:,1) = 0.0
   v(:,:,1) = 0.0
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Here is the call graph for this function:

◆ user_set_coord()

subroutine, public user_initialization::user_set_coord	(	real, dimension(:), intent(out)	Rlay,
		real, dimension(:), intent(out)	g_prime,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		type(param_file_type), intent(in)	param_file,
		type(eos_type), pointer	eqn_of_state
	)

Set vertical coordinates.

Parameters

[in]	gv	The ocean's vertical grid structure.
[out]	rlay	Layer potential density [R ~> kg m-3].
[out]	g_prime	The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].
[in]	us	A dimensional unit scaling type
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	eqn_of_state	Integer that selects the equation of state.

Definition at line 41 of file user_initialization.F90.

   type(verticalGrid_type), intent(in)  :: GV         !< The ocean's vertical grid
                                                      !! structure.
   real, dimension(:),      intent(out) :: Rlay       !< Layer potential density [R ~> kg m-3].
   real, dimension(:),      intent(out) :: g_prime    !< The reduced gravity at
                                                      !! each interface [L2 Z-1 T-2 ~> m s-2].
   type(unit_scale_type),   intent(in)  :: US         !< A dimensional unit scaling type
   type(param_file_type),   intent(in)  :: param_file !< A structure indicating the
                                                      !! open file to parse for model
                                                      !! parameter values.
   type(EOS_type),          pointer     :: eqn_of_state !< Integer that selects the
                                                      !! equation of state.
  
   call mom_error(fatal, &
     "USER_initialization.F90, USER_set_coord: " // &
     "Unmodified user routine called - you must edit the routine to use it")
   rlay(:) = 0.0
   g_prime(:) = 0.0
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Referenced by mom_coord_initialization::mom_initialize_coord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ user_set_obc_data()

subroutine, public user_initialization::user_set_obc_data	(	type(ocean_obc_type), pointer	OBC,
		type(thermo_var_ptrs), intent(in)	tv,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(tracer_registry_type), pointer	tr_Reg
	)

This subroutine sets the properties of flow at open boundary conditions.

Parameters

	obc	This open boundary condition type specifies whether, where, and what open boundary conditions are used.
[in]	tv	A structure containing pointers to any available thermodynamic fields, including potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
[in]	g	The ocean's grid structure.
[in]	param_file	A structure indicating the open file to parse for model parameter values.
	tr_reg	Tracer registry.

Definition at line 195 of file user_initialization.F90.

   type(ocean_OBC_type),       pointer    :: OBC   !< This open boundary condition type specifies
                                                   !! whether, where, and what open boundary
                                                   !! conditions are used.
   type(thermo_var_ptrs),      intent(in) :: tv    !< A structure containing pointers to any
                                        !! available thermodynamic fields, including potential
                                        !! temperature and salinity or mixed layer density. Absent
                                        !! fields have NULL ptrs.
   type(ocean_grid_type),      intent(in) :: G     !< The ocean's grid structure.
   type(param_file_type),      intent(in) :: param_file !< A structure indicating the
                                                   !! open file to parse for model
                                                   !! parameter values.
   type(tracer_registry_type), pointer    :: tr_Reg !< Tracer registry.
 !  call MOM_error(FATAL, &
 !   "USER_initialization.F90, USER_set_OBC_data: " // &
 !   "Unmodified user routine called - you must edit the routine to use it")
  
   if (first_call) call write_user_log(param_file)
  

References first_call, and write_user_log().

Here is the call graph for this function:

◆ user_set_rotation()

subroutine, public user_initialization::user_set_rotation	(	type(ocean_grid_type), intent(inout)	G,
		type(param_file_type), intent(in)	param_file
	)

Parameters

[in,out]	g	The ocean's grid structure
[in]	param_file	A structure to parse for run-time parameters

Definition at line 216 of file user_initialization.F90.

   type(ocean_grid_type), intent(inout) :: G    !< The ocean's grid structure
   type(param_file_type), intent(in)    :: param_file !< A structure to parse for run-time parameters
   call mom_error(fatal, &
     "USER_initialization.F90, USER_set_rotation: " // &
     "Unmodified user routine called - you must edit the routine to use it")
  
   if (first_call) call write_user_log(param_file)
  

References first_call, mom_error_handler::mom_error(), and write_user_log().

Here is the call graph for this function:

◆ write_user_log()

subroutine user_initialization::write_user_log ( type(param_file_type), intent(in) param_file )

private

Write output about the parameter values being used.

Parameters

[in] param_file A structure indicating the open file to parse for model parameter values.

Definition at line 228 of file user_initialization.F90.

   type(param_file_type), intent(in) :: param_file !< A structure indicating the
                                                   !! open file to parse for model
                                                   !! parameter values.
  
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
   character(len=40)  :: mdl = "user_initialization" ! This module's name.
  
   call log_version(param_file, mdl, version)
   first_call = .false.
  

References first_call.

Referenced by user_init_temperature_salinity(), user_initialize_sponges(), user_initialize_thickness(), user_initialize_topography(), user_initialize_velocity(), user_set_coord(), user_set_obc_data(), and user_set_rotation().

Here is the caller graph for this function:

Variable Documentation

◆ first_call

logical user_initialization::first_call = .true.

private

A module variable that should not be used.

Todo:: Move this module variable into a control structure.

Definition at line 35 of file user_initialization.F90.

35 logical :: first_call = .true.

Referenced by user_init_temperature_salinity(), user_initialize_sponges(), user_initialize_thickness(), user_initialize_topography(), user_initialize_velocity(), user_set_coord(), user_set_obc_data(), user_set_rotation(), and write_user_log().

Detailed Description

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ user_init_temperature_salinity()

◆ user_initialize_sponges()

◆ user_initialize_thickness()

◆ user_initialize_topography()

◆ user_initialize_velocity()

◆ user_set_coord()

◆ user_set_obc_data()

◆ user_set_rotation()

◆ write_user_log()

Variable Documentation

◆ first_call