Detailed Description

Solve the layer continuity equation.

Data Types
type	continuity_cs
	Control structure for mom_continuity. More...

Functions/Subroutines
subroutine, public	continuity (u, v, hin, h, uh, vh, dt, G, GV, US, CS, uhbt, vhbt, OBC, visc_rem_u, visc_rem_v, u_cor, v_cor, BT_cont)
	Time steps the layer thicknesses, using a monotonically limited, directionally split PPM scheme, based on Lin (1994). More...

subroutine, public	continuity_init (Time, G, GV, US, param_file, diag, CS)
	Initializes continuity_cs. More...

integer function, public	continuity_stencil (CS)
	continuity_stencil returns the continuity solver stencil size More...

subroutine, public	continuity_end (CS)
	Destructor for continuity_cs. More...

Variables
integer, parameter	ppm_scheme = 1
	Enumerated constant to select PPM. More...

character(len=20), parameter	ppm_string = "PPM"
	String to select PPM. More...

Function/Subroutine Documentation

◆ continuity()

subroutine, public mom_continuity::continuity	(	real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(in)	u,
		real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(in)	v,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in)	hin,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(inout)	h,
		real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(out)	uh,
		real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(out)	vh,
		real, intent(in)	dt,
		type(ocean_grid_type), intent(inout)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		type(continuity_cs), pointer	CS,
		real, dimension( g %isdb: g %iedb, g %jsd: g %jed), intent(in), optional	uhbt,
		real, dimension( g %isd: g %ied, g %jsdb: g %jedb), intent(in), optional	vhbt,
		type(ocean_obc_type), optional, pointer	OBC,
		real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(in), optional	visc_rem_u,
		real, dimension(szi_(g),szjb_(g),szk_(g)), intent(in), optional	visc_rem_v,
		real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(out), optional	u_cor,
		real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(out), optional	v_cor,
		type(bt_cont_type), optional, pointer	BT_cont
	)

Time steps the layer thicknesses, using a monotonically limited, directionally split PPM scheme, based on Lin (1994).

Parameters

[in,out]	g	Ocean grid structure.
[in]	gv	Vertical grid structure.
[in]	u	Zonal velocity [L T-1 ~> m s-1].
[in]	v	Meridional velocity [L T-1 ~> m s-1].
[in]	hin	Initial layer thickness [H ~> m or kg m-2].
[in,out]	h	Final layer thickness [H ~> m or kg m-2].
[out]	uh	Volume flux through zonal faces =
[out]	vh	Volume flux through meridional faces =
[in]	dt	Time increment [T ~> s].
[in]	us	A dimensional unit scaling type
	cs	Control structure for mom_continuity.
[in]	uhbt	The vertically summed volume
[in]	vhbt	The vertically summed volume
	obc	Open boundaries control structure.
[in]	visc_rem_u	Both the fraction of
[in]	visc_rem_v	Both the fraction of
[out]	u_cor	The zonal velocities that
[out]	v_cor	The meridional velocities that
	bt_cont	A structure with elements

Definition at line 44 of file MOM_continuity.F90.

   type(ocean_grid_type),   intent(inout) :: G   !< Ocean grid structure.
   type(verticalGrid_type), intent(in)    :: GV  !< Vertical grid structure.
   real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                            intent(in)    :: u   !< Zonal velocity [L T-1 ~> m s-1].
   real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                            intent(in)    :: v   !< Meridional velocity [L T-1 ~> m s-1].
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  &
                            intent(in)    :: hin !< Initial layer thickness [H ~> m or kg m-2].
   real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  &
                            intent(inout) :: h   !< Final layer thickness [H ~> m or kg m-2].
   real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                            intent(out)   :: uh  !< Volume flux through zonal faces =
                                                 !! u*h*dy [H L2 T-1 ~> m3 s-1 or kg s-1].
   real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                            intent(out)   :: vh  !< Volume flux through meridional faces =
                                                 !! v*h*dx [H L2 T-1 ~> m3 s-1 or kg s-1].
   real,                    intent(in)    :: dt  !< Time increment [T ~> s].
   type(unit_scale_type),   intent(in)    :: US  !< A dimensional unit scaling type
   type(continuity_CS),     pointer       :: CS  !< Control structure for mom_continuity.
   real, dimension(SZIB_(G),SZJ_(G)), &
                  optional, intent(in)    :: uhbt !< The vertically summed volume
                                                 !! flux through zonal faces [H L2 T-1 ~> m3 s-1 or kg s-1].
   real, dimension(SZI_(G),SZJB_(G)), &
                  optional, intent(in)    :: vhbt !< The vertically summed volume
                                                 !! flux through meridional faces [H L2 T-1 ~> m3 s-1 or kg s-1].
   type(ocean_OBC_type), &
                  optional, pointer       :: OBC !< Open boundaries control structure.
   real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                  optional, intent(in)    :: visc_rem_u !< Both the fraction of
           !! zonal momentum that remains after a time-step of viscosity, and the fraction of a time-step's
           !! worth of a barotropic acceleration that a layer experiences after viscosity is applied.
           !! Non-dimensional between 0 (at the bottom) and 1 (far above the bottom).
   real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                  optional, intent(in)    :: visc_rem_v !< Both the fraction of
           !! meridional momentum that remains after a time-step of viscosity, and the fraction of a time-step's
           !! worth of a barotropic acceleration that a layer experiences after viscosity is applied.
           !! Non-dimensional between 0 (at the bottom) and 1 (far above the bottom).
   real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                  optional, intent(out)   :: u_cor !< The zonal velocities that
           !! give uhbt as the depth-integrated transport [L T-1 ~> m s-1].
   real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                  optional, intent(out)   :: v_cor !< The meridional velocities that
           !! give vhbt as the depth-integrated transport [L T-1 ~> m s-1].
   type(BT_cont_type), &
                  optional, pointer       :: BT_cont !< A structure with elements
           !! that describe the effective open face areas as a function of barotropic flow.
  
   if (present(visc_rem_u) .neqv. present(visc_rem_v)) call mom_error(fatal, &
       "MOM_continuity: Either both visc_rem_u and visc_rem_v or neither"// &
        " one must be present in call to continuity.")
   if (present(u_cor) .neqv. present(v_cor)) call mom_error(fatal, &
       "MOM_continuity: Either both u_cor and v_cor or neither"// &
        " one must be present in call to continuity.")
  
   if (cs%continuity_scheme == ppm_scheme) then
     call continuity_ppm(u, v, hin, h, uh, vh, dt, g, gv, us, cs%PPM_CSp, uhbt, vhbt, obc, &
                         visc_rem_u, visc_rem_v, u_cor, v_cor, bt_cont=bt_cont)
   else
     call mom_error(fatal, "continuity: Unrecognized value of continuity_scheme")
   endif
  

References mom_error_handler::mom_error(), and ppm_scheme.

Referenced by mom_dynamics_unsplit::step_mom_dyn_unsplit(), and mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ continuity_end()

subroutine, public mom_continuity::continuity_end ( type(continuity_cs), pointer CS )

Destructor for continuity_cs.

Parameters

cs	Control structure for mom_continuity.

Definition at line 169 of file MOM_continuity.F90.

   type(continuity_CS), pointer :: CS !< Control structure for mom_continuity.
  
   if (cs%continuity_scheme == ppm_scheme) then
     call continuity_ppm_end(cs%PPM_CSp)
   endif
  
   deallocate(cs)
  

References mom_continuity_ppm::continuity_ppm_end(), and ppm_scheme.

Here is the call graph for this function:

◆ continuity_init()

subroutine, public mom_continuity::continuity_init	(	type(time_type), intent(in), target	Time,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		type(param_file_type), intent(in)	param_file,
		type(diag_ctrl), intent(inout), target	diag,
		type(continuity_cs), pointer	CS
	)

Initializes continuity_cs.

Parameters

[in]	time	Current model time.
[in]	g	Ocean grid structure.
[in]	gv	Vertical grid structure.
[in]	us	A dimensional unit scaling type
[in]	param_file	Parameter file handles.
[in,out]	diag	Diagnostics control structure.
	cs	Control structure for mom_continuity.

Definition at line 109 of file MOM_continuity.F90.

   type(time_type), target, intent(in)    :: Time       !< Current model time.
   type(ocean_grid_type),   intent(in)    :: G          !< Ocean grid structure.
   type(verticalGrid_type), intent(in)    :: GV         !< Vertical grid structure.
   type(unit_scale_type),   intent(in)    :: US  !< A dimensional unit scaling type
   type(param_file_type),   intent(in)    :: param_file !< Parameter file handles.
   type(diag_ctrl), target, intent(inout) :: diag       !< Diagnostics control structure.
   type(continuity_CS),     pointer       :: CS         !< Control structure for mom_continuity.
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
   character(len=40)  :: mdl = "MOM_continuity" ! This module's name.
   character(len=20)  :: tmpstr
  
   if (associated(cs)) then
     call mom_error(warning, "continuity_init called with associated control structure.")
     return
   endif
   allocate(cs)
  
   ! Read all relevant parameters and write them to the model log.
   call log_version(param_file, mdl, version, "")
   call get_param(param_file, mdl, "CONTINUITY_SCHEME", tmpstr, &
                  "CONTINUITY_SCHEME selects the discretization for the "//&
                  "continuity solver. The only valid value currently is: \n"//&
                  "\t PPM - use a positive-definite (or monotonic) \n"//&
                  "\t       piecewise parabolic reconstruction solver.", &
                  default=ppm_string)
  
   tmpstr = uppercase(tmpstr) ; cs%continuity_scheme = 0
   select case (trim(tmpstr))
     case (ppm_string) ; cs%continuity_scheme = ppm_scheme
     case default
       call mom_mesg('continuity_init: CONTINUITY_SCHEME ="'//trim(tmpstr)//'"', 0)
       call mom_mesg("continuity_init: The only valid value is currently "// &
                      trim(ppm_string), 0)
       call mom_error(fatal, "continuity_init: Unrecognized setting "// &
             "#define CONTINUITY_SCHEME "//trim(tmpstr)//" found in input file.")
   end select
  
   if (cs%continuity_scheme == ppm_scheme) then
     call continuity_ppm_init(time, g, gv, us, param_file, diag, cs%PPM_CSp)
   endif
  

References mom_error_handler::mom_error(), mom_error_handler::mom_mesg(), ppm_scheme, ppm_string, and mom_string_functions::uppercase().

Referenced by mom_dynamics_unsplit::initialize_dyn_unsplit(), and mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ continuity_stencil()

integer function, public mom_continuity::continuity_stencil ( type(continuity_cs), pointer CS )

continuity_stencil returns the continuity solver stencil size

Parameters

cs	Module's control structure.

Returns: The continuity solver stencil size with the current settings.

Definition at line 156 of file MOM_continuity.F90.

   type(continuity_CS), pointer       :: CS  !< Module's control structure.
   integer ::  stencil !< The continuity solver stencil size with the current settings.
  
   stencil = 1
  
   if (cs%continuity_scheme == ppm_scheme) then
     stencil = continuity_ppm_stencil(cs%PPM_CSp)
   endif
  

References ppm_scheme.

Referenced by mom_dynamics_split_rk2::step_mom_dyn_split_rk2().

Here is the caller graph for this function:

Variable Documentation

◆ ppm_scheme

integer, parameter mom_continuity::ppm_scheme = 1

Enumerated constant to select PPM.

Definition at line 35 of file MOM_continuity.F90.

35 integer, parameter :: PPM_SCHEME = 1 !< Enumerated constant to select PPM

Referenced by continuity(), continuity_end(), continuity_init(), and continuity_stencil().

◆ ppm_string

character(len=20), parameter mom_continuity::ppm_string = "PPM"

private

String to select PPM.

Definition at line 36 of file MOM_continuity.F90.

36 character(len=20), parameter :: PPM_STRING = "PPM" !< String to select PPM

Referenced by continuity_init().

Detailed Description

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ continuity()

◆ continuity_end()

◆ continuity_init()

◆ continuity_stencil()

Variable Documentation

◆ ppm_scheme

◆ ppm_string