Detailed Description

Initializes fixed aspects of the model, such as horizontal grid metrics, topography and Coriolis.

Functions/Subroutines
subroutine, public	mom_initialize_fixed (G, US, OBC, PF, write_geom, output_dir)
	MOM_initialize_fixed sets up time-invariant quantities related to MOM6's horizontal grid, bathymetry, and the Coriolis parameter. More...

subroutine, public	mom_initialize_topography (D, max_depth, G, PF, US)
	MOM_initialize_topography makes the appropriate call to set up the bathymetry. At this point the topography is in units of [m], but this can be changed later. More...

Function/Subroutine Documentation

◆ mom_initialize_fixed()

subroutine, public mom_fixed_initialization::mom_initialize_fixed	(	type(dyn_horgrid_type), intent(inout)	G,
		type(unit_scale_type), intent(in)	US,
		type(ocean_obc_type), pointer	OBC,
		type(param_file_type), intent(in)	PF,
		logical, intent(in)	write_geom,
		character(len=*), intent(in)	output_dir
	)

MOM_initialize_fixed sets up time-invariant quantities related to MOM6's horizontal grid, bathymetry, and the Coriolis parameter.

Parameters

[in,out]	g	The ocean's grid structure.
[in]	us	A dimensional unit scaling type
	obc	Open boundary structure.
[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.

Definition at line 56 of file MOM_fixed_initialization.F90.

   type(dyn_horgrid_type),  intent(inout) :: G    !< The ocean's grid structure.
   type(unit_scale_type),   intent(in)    :: US   !< A dimensional unit scaling type
   type(ocean_OBC_type),    pointer       :: OBC  !< Open boundary structure.
   type(param_file_type),   intent(in)    :: PF   !< A structure indicating the open file
                                                  !! to parse for model parameter values.
   logical,                 intent(in)    :: write_geom !< If true, write grid geometry files.
   character(len=*),        intent(in)    :: output_dir !< The directory into which to write files.
  
   ! Local
   character(len=200) :: inputdir   ! The directory where NetCDF input files are.
   character(len=200) :: config
   character(len=40)  :: mdl = "MOM_fixed_initialization" ! This module's name.
   logical :: debug
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
  
   call calltree_enter("MOM_initialize_fixed(), MOM_fixed_initialization.F90")
   call log_version(pf, mdl, version, "")
   call get_param(pf, mdl, "DEBUG", debug, default=.false.)
  
   call get_param(pf, mdl, "INPUTDIR", inputdir, &
          "The directory in which input files are found.", default=".")
   inputdir = slasher(inputdir)
  
   ! Set up the parameters of the physical domain (i.e. the grid), G
   call set_grid_metrics(g, pf, us)
  
   ! Set up the bottom depth, G%bathyT either analytically or from file
   ! This also sets G%max_depth based on the input parameter MAXIMUM_DEPTH,
   ! or, if absent, is diagnosed as G%max_depth = max( G%D(:,:) )
   call mom_initialize_topography(g%bathyT, g%max_depth, g, pf, us)
 !  call rescale_dyn_horgrid_bathymetry(G, US%Z_to_m)
  
   ! To initialize masks, the bathymetry in halo regions must be filled in
   call pass_var(g%bathyT, g%Domain)
  
   ! Determine the position of any open boundaries
   call open_boundary_config(g, us, pf, obc)
  
   ! Make bathymetry consistent with open boundaries
   call open_boundary_impose_normal_slope(obc, g, g%bathyT)
  
   ! This call sets masks that prohibit flow over any point interpreted as land
   call initialize_masks(g, pf, us)
  
   ! Make OBC mask consistent with land mask
   call open_boundary_impose_land_mask(obc, g, g%areaCu, g%areaCv, us)
  
   if (debug) then
     call hchksum(g%bathyT, 'MOM_initialize_fixed: depth ', g%HI, haloshift=1, scale=us%Z_to_m)
     call hchksum(g%mask2dT, 'MOM_initialize_fixed: mask2dT ', g%HI)
     call uvchksum('MOM_initialize_fixed: mask2dC[uv]', g%mask2dCu, &
                   g%mask2dCv, g%HI)
     call qchksum(g%mask2dBu, 'MOM_initialize_fixed: mask2dBu ', g%HI)
   endif
  
   ! Modulate geometric scales according to geography.
   call get_param(pf, mdl, "CHANNEL_CONFIG", config, &
                  "A parameter that determines which set of channels are \n"//&
                  "restricted to specific  widths.  Options are:\n"//&
                  " \t none - All channels have the grid width.\n"//&
                  " \t global_1deg - Sets 16 specific channels appropriate \n"//&
                  " \t\t for a 1-degree model, as used in CM2G.\n"//&
                  " \t list - Read the channel locations and widths from a \n"//&
                  " \t\t text file, like MOM_channel_list in the MOM_SIS \n"//&
                  " \t\t test case.\n"//&
                  " \t file - Read open face widths everywhere from a \n"//&
                  " \t\t NetCDF file on the model grid.", &
                  default="none")
   select case ( trim(config) )
     case ("none")
     case ("list") ; call reset_face_lengths_list(g, pf, us)
     case ("file") ; call reset_face_lengths_file(g, pf, us)
     case ("global_1deg") ; call reset_face_lengths_named(g, pf, trim(config), us)
     case default ; call mom_error(fatal, "MOM_initialize_fixed: "// &
       "Unrecognized channel configuration "//trim(config))
   end select
  
   !   This call sets the topography at velocity points.
   if (g%bathymetry_at_vel) then
     call get_param(pf, mdl, "VELOCITY_DEPTH_CONFIG", config, &
                    "A string that determines how the topography is set at "//&
                    "velocity points. This may be 'min' or 'max'.", &
                    default="max")
     select case ( trim(config) )
       case ("max") ; call set_velocity_depth_max(g)
       case ("min") ; call set_velocity_depth_min(g)
       case default ; call mom_error(fatal, "MOM_initialize_fixed: "// &
         "Unrecognized velocity depth configuration "//trim(config))
     end select
   endif
  
 !    Calculate the value of the Coriolis parameter at the latitude   !
 !  of the q grid points [s-1].
   call mom_initialize_rotation(g%CoriolisBu, g, pf, us=us)
 !   Calculate the components of grad f (beta)
   call mom_calculate_grad_coriolis(g%dF_dx, g%dF_dy, g, us=us)
   if (debug) then
     call qchksum(g%CoriolisBu, "MOM_initialize_fixed: f ", g%HI, scale=us%s_to_T)
     call hchksum(g%dF_dx, "MOM_initialize_fixed: dF_dx ", g%HI, scale=us%m_to_L*us%s_to_T)
     call hchksum(g%dF_dy, "MOM_initialize_fixed: dF_dy ", g%HI, scale=us%m_to_L*us%s_to_T)
   endif
  
   call initialize_grid_rotation_angle(g, pf)
  
 ! Compute global integrals of grid values for later use in scalar diagnostics !
   call compute_global_grid_integrals(g, us=us)
  
 ! Write out all of the grid data used by this run.
   if (write_geom) call write_ocean_geometry_file(g, pf, output_dir, us=us)
  
   call calltree_leave('MOM_initialize_fixed()')
  

References mom_error_handler::calltree_enter(), mom_error_handler::calltree_leave(), mom_shared_initialization::compute_global_grid_integrals(), mom_grid_initialize::initialize_masks(), mom_initialize_topography(), mom_open_boundary::open_boundary_impose_land_mask(), mom_grid_initialize::set_grid_metrics(), and mom_shared_initialization::write_ocean_geometry_file().

Referenced by mom::initialize_mom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mom_initialize_topography()

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

MOM_initialize_topography makes the appropriate call to set up the bathymetry. At this point the topography is in units of [m], but this can be changed later.