Detailed Description

Initial conditions and forcing for the single column model (SCM) CVMix test set.

Data Types
type	scm_cvmix_tests_cs
	Container for surface forcing parameters. More...

Functions/Subroutines
subroutine, public	scm_cvmix_tests_ts_init (T, S, h, G, GV, US, param_file, just_read_params)
	Initializes temperature and salinity for the SCM CVMix test example. More...

subroutine, public	scm_cvmix_tests_surface_forcing_init (Time, G, param_file, CS)
	Initializes surface forcing for the CVMix test case suite. More...

subroutine, public	scm_cvmix_tests_wind_forcing (state, forces, day, G, US, CS)

subroutine, public	scm_cvmix_tests_buoyancy_forcing (state, fluxes, day, G, US, CS)

Variables
character(len=40)	mdl = "SCM_CVMix_tests"
	This module's name. More...

Function/Subroutine Documentation

◆ scm_cvmix_tests_buoyancy_forcing()

subroutine, public scm_cvmix_tests::scm_cvmix_tests_buoyancy_forcing	(	type(surface), intent(in)	state,
		type(forcing), intent(inout)	fluxes,
		type(time_type), intent(in)	day,
		type(ocean_grid_type), intent(inout)	G,
		type(unit_scale_type), intent(in)	US,
		type(scm_cvmix_tests_cs), pointer	CS
	)

Parameters

[in]	state	Surface state structure
[in,out]	fluxes	Surface fluxes structure
[in]	day	Current model time
[in,out]	g	Grid structure
[in]	us	A dimensional unit scaling type
	cs	Container for SCM parameters

Definition at line 231 of file SCM_CVMix_tests.F90.

   type(surface),            intent(in)    :: state  !< Surface state structure
   type(forcing),            intent(inout) :: fluxes !< Surface fluxes structure
   type(time_type),          intent(in)    :: day    !< Current model time
   type(ocean_grid_type),    intent(inout) :: G      !< Grid structure
   type(unit_scale_type),    intent(in)    :: US     !< A dimensional unit scaling type
   type(SCM_CVMix_tests_CS), pointer       :: CS     !< Container for SCM parameters
  
   ! Local variables
   integer :: i, j, is, ie, js, je, Isq, Ieq, Jsq, Jeq
   integer :: isd, ied, jsd, jed, IsdB, IedB, JsdB, JedB
   real :: PI
  
   pi = 4.0*atan(1.0)
  
   ! Bounds for loops and memory allocation
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec
   isq = g%IscB ; ieq = g%IecB ; jsq = g%JscB ; jeq = g%JecB
   isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed
   isdb = g%IsdB ; iedb = g%IedB ; jsdb = g%JsdB ; jedb = g%JedB
  
   if (cs%UseHeatFlux) then
     ! Note CVMix test inputs give Heat flux in [m K/s]
     ! therefore must convert to W/m2 by multiplying
     ! by Rho0*Cp
     do j=jsq,jeq ; do i=is,ie
       fluxes%sens(i,j) = cs%surf_HF * cs%Rho0 * fluxes%C_p
     enddo ; enddo
   endif
  
   if (cs%UseEvaporation) then
     do j=jsq,jeq ; do i=is,ie
     ! Note CVMix test inputs give evaporation in [m s-1]
     ! This therefore must be converted to mass flux in [R Z T-1 ~> kg m-2 s-1]
     ! by multiplying by density and some unit conversion factors.
       fluxes%evap(i,j) = cs%surf_evap * us%kg_m3_to_R*us%m_to_Z*us%T_to_s * cs%Rho0
     enddo ; enddo
   endif
  
   if (cs%UseDiurnalSW) then
     do j=jsq,jeq ; do i=is,ie
     ! Note CVMix test inputs give max sw rad in [m K/s]
     ! therefore must convert to W/m2 by multiplying
     ! by Rho0*Cp
     ! Note diurnal cycle peaks at Noon.
       fluxes%sw(i,j) = cs%Max_sw * max(0.0,cos(2*pi*     &
            (time_type_to_real(day)/86400.-0.5))) * cs%RHO0 * fluxes%C_p
     enddo ; enddo
   endif
  

◆ scm_cvmix_tests_surface_forcing_init()

subroutine, public scm_cvmix_tests::scm_cvmix_tests_surface_forcing_init	(	type(time_type), intent(in)	Time,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(scm_cvmix_tests_cs), pointer	CS
	)

Initializes surface forcing for the CVMix test case suite.

Parameters

[in]	time	Model time
[in]	g	Grid structure
[in]	param_file	Input parameter structure
	cs	Parameter container

Definition at line 129 of file SCM_CVMix_tests.F90.

   type(time_type),          intent(in) :: Time       !< Model time
   type(ocean_grid_type),    intent(in) :: G          !< Grid structure
   type(param_file_type),    intent(in) :: param_file !< Input parameter structure
   type(SCM_CVMix_tests_CS), pointer    :: CS         !< Parameter container
  
  
   ! This include declares and sets the variable "version".
 # include "version_variable.h"
   type(unit_scale_type), pointer :: US => null() !< A dimensional unit scaling type
  
   us => g%US
  
   if (associated(cs)) then
     call mom_error(fatal, "SCM_CVMix_tests_surface_forcing_init called with an 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, "SCM_USE_WIND_STRESS",              &
                  cs%UseWindStress, "Wind Stress switch "//            &
                  "used in the SCM CVMix surface forcing.",            &
                  units='', default=.false.)
   call get_param(param_file, mdl, "SCM_USE_HEAT_FLUX",                &
                  cs%UseHeatFlux, "Heat flux switch "//                &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='', default=.false.)
   call get_param(param_file, mdl, "SCM_USE_EVAPORATION",              &
                  cs%UseEvaporation, "Evaporation switch "//           &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='', default=.false.)
   call get_param(param_file, mdl, "SCM_USE_DIURNAL_SW",               &
                  cs%UseDiurnalSW, "Diurnal sw radation switch "//     &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='', default=.false.)
   if (cs%UseWindStress) then
     call get_param(param_file, mdl, "SCM_TAU_X",                      &
                  cs%tau_x, "Constant X-dir wind stress "//            &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='N/m2', scale=us%kg_m3_to_R*us%m_s_to_L_T**2*us%L_to_Z, fail_if_missing=.true.)
     call get_param(param_file, mdl, "SCM_TAU_Y",                      &
                  cs%tau_y, "Constant y-dir wind stress "//            &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='N/m2', scale=us%kg_m3_to_R*us%m_s_to_L_T**2*us%L_to_Z, fail_if_missing=.true.)
   endif
   if (cs%UseHeatFlux) then
     call get_param(param_file, mdl, "SCM_HEAT_FLUX",                  &
                  cs%surf_HF, "Constant surface heat flux "//          &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='m K/s', fail_if_missing=.true.)
   endif
   if (cs%UseEvaporation) then
     call get_param(param_file, mdl, "SCM_EVAPORATION",                &
                  cs%surf_evap, "Constant surface evaporation "//      &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='m/s', fail_if_missing=.true.)
   endif
   if (cs%UseDiurnalSW) then
     call get_param(param_file, mdl, "SCM_DIURNAL_SW_MAX",             &
                  cs%Max_sw, "Maximum diurnal sw radiation "//         &
                  "used in the SCM CVMix test surface forcing.",       &
                  units='m K/s', fail_if_missing=.true.)
   endif
  

References mdl, and mom_error_handler::mom_error().

Here is the call graph for this function:

◆ scm_cvmix_tests_ts_init()

subroutine, public scm_cvmix_tests::scm_cvmix_tests_ts_init	(	real, dimension(nimem_,njmem_, nkmem_), intent(out)	T,
		real, dimension(nimem_,njmem_, nkmem_), intent(out)	S,
		real, dimension(nimem_,njmem_, nkmem_), intent(in)	h,
		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,
		logical, intent(in), optional	just_read_params
	)

Initializes temperature and salinity for the SCM CVMix test example.

Parameters

[out]	t	Potential temperature [degC]
[out]	s	Salinity [psu]
[in]	h	Layer thickness [H ~> m or kg m-2]
[in]	g	Grid structure
[in]	gv	Vertical grid structure
[in]	us	A dimensional unit scaling type
[in]	param_file	Input parameter structure
[in]	just_read_params	If present and true, this call will only read parameters without changing h.

Definition at line 56 of file SCM_CVMix_tests.F90.

   real, dimension(NIMEM_,NJMEM_, NKMEM_), intent(out) :: T  !< Potential temperature [degC]
   real, dimension(NIMEM_,NJMEM_, NKMEM_), intent(out) :: S  !< Salinity [psu]
   real, dimension(NIMEM_,NJMEM_, NKMEM_), intent(in)  :: h  !< Layer thickness [H ~> m or kg m-2]
   type(ocean_grid_type),                  intent(in)  :: G  !< 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 !< Input parameter structure
   logical,       optional, intent(in)  :: just_read_params !< If present and true, this call will
                                                       !! only read parameters without changing h.
   ! Local variables
   real :: UpperLayerTempMLD !< Upper layer Temp MLD thickness [Z ~> m].
   real :: UpperLayerSaltMLD !< Upper layer Salt MLD thickness [Z ~> m].
   real :: UpperLayerTemp !< Upper layer temperature (SST if thickness 0) [degC]
   real :: UpperLayerSalt !< Upper layer salinity (SSS if thickness 0) [ppt]
   real :: LowerLayerTemp !< Temp at top of lower layer [degC]
   real :: LowerLayerSalt !< Salt at top of lower layer [ppt]
   real :: LowerLayerdTdz !< Temp gradient in lower layer [degC / Z ~> degC m-1].
   real :: LowerLayerdSdz !< Salt gradient in lower layer [ppt / Z ~> ppt m-1].
   real :: LowerLayerMinTemp !< Minimum temperature in lower layer [degC]
   real :: zC, DZ, top, bottom ! Depths and thicknesses [Z ~> m].
   logical :: just_read    ! If true, just read parameters but set nothing.
   integer :: i, j, k, is, ie, js, je, isd, ied, jsd, jed, nz
  
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = g%ke
   isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed
  
  
   just_read = .false. ; if (present(just_read_params)) just_read = just_read_params
  
   if (.not.just_read) call log_version(param_file, mdl, version)
   call get_param(param_file, mdl, "SCM_TEMP_MLD", upperlayertempmld, &
                  'Initial temp mixed layer depth', &
                  units='m', default=0.0, scale=us%m_to_Z, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_SALT_MLD", upperlayersaltmld, &
                  'Initial salt mixed layer depth', &
                  units='m', default=0.0, scale=us%m_to_Z, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L1_SALT", upperlayersalt, &
                  'Layer 2 surface salinity', units='1e-3', default=35.0, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L1_TEMP", upperlayertemp, &
                  'Layer 1 surface temperature', units='C', default=20.0, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L2_SALT", lowerlayersalt, &
                  'Layer 2 surface salinity', units='1e-3', default=35.0, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L2_TEMP", lowerlayertemp, &
                  'Layer 2 surface temperature', units='C', default=20.0, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L2_DTDZ", lowerlayerdtdz,     &
                  'Initial temperature stratification in layer 2', &
                  units='C/m', default=0.0, scale=us%Z_to_m, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L2_DSDZ", lowerlayerdsdz,  &
                  'Initial salinity stratification in layer 2', &
                  units='PPT/m', default=0.0, scale=us%Z_to_m, do_not_log=just_read)
   call get_param(param_file, mdl, "SCM_L2_MINTEMP",lowerlayermintemp, &
                  'Layer 2 minimum temperature', units='C', default=4.0, do_not_log=just_read)
  
   if (just_read) return ! All run-time parameters have been read, so return.
  
   do j=js,je ; do i=is,ie
     top = 0. ! Reference to surface
     bottom = 0.
     do k=1,nz
       bottom = bottom - h(i,j,k)*gv%H_to_Z ! Interface below layer [Z ~> m]
       zc = 0.5*( top + bottom )        ! Z of middle of layer [Z ~> m]
       dz = min(0., zc + upperlayertempmld)
       t(i,j,k) = max(lowerlayermintemp,lowerlayertemp + lowerlayerdtdz * dz)
       dz = min(0., zc + upperlayersaltmld)
       s(i,j,k) = lowerlayersalt + lowerlayerdsdz * dz
       top = bottom
     enddo ! k
   enddo ; enddo
  

References mdl.

Referenced by mom_state_initialization::mom_initialize_state().

Here is the caller graph for this function:

◆ scm_cvmix_tests_wind_forcing()

subroutine, public scm_cvmix_tests::scm_cvmix_tests_wind_forcing	(	type(surface), intent(in)	state,
		type(mech_forcing), intent(inout)	forces,
		type(time_type), intent(in)	day,
		type(ocean_grid_type), intent(inout)	G,
		type(unit_scale_type), intent(in)	US,
		type(scm_cvmix_tests_cs), pointer	CS
	)

Parameters

[in]	state	Surface state structure
[in,out]	forces	A structure with the driving mechanical forces
[in]	day	Time in days
[in,out]	g	Grid structure
[in]	us	A dimensional unit scaling type
	cs	Container for SCM parameters

Definition at line 198 of file SCM_CVMix_tests.F90.

   type(surface),            intent(in)    :: state  !< Surface state structure
   type(mech_forcing),       intent(inout) :: forces !< A structure with the driving mechanical forces
   type(time_type),          intent(in)    :: day    !< Time in days
   type(ocean_grid_type),    intent(inout) :: G      !< Grid structure
   type(unit_scale_type),    intent(in)    :: US     !< A dimensional unit scaling type
   type(SCM_CVMix_tests_CS), pointer       :: CS     !< Container for SCM parameters
   ! Local variables
   integer :: i, j, is, ie, js, je, Isq, Ieq, Jsq, Jeq
   integer :: isd, ied, jsd, jed, IsdB, IedB, JsdB, JedB
   real    :: mag_tau
   ! Bounds for loops and memory allocation
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec
   isq = g%IscB ; ieq = g%IecB ; jsq = g%JscB ; jeq = g%JecB
   isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed
   isdb = g%IsdB ; iedb = g%IedB ; jsdb = g%JsdB ; jedb = g%JedB
  
   do j=js,je ; do i=isq,ieq
     forces%taux(i,j) = cs%tau_x
   enddo ; enddo
   do j=jsq,jeq ; do i=is,ie
     forces%tauy(i,j) = cs%tau_y
   enddo ; enddo
   call pass_vector(forces%taux, forces%tauy, g%Domain, to_all)
  
   mag_tau = sqrt(cs%tau_x*cs%tau_x + cs%tau_y*cs%tau_y)
   if (associated(forces%ustar)) then ; do j=js,je ; do i=is,ie
     forces%ustar(i,j) = sqrt( us%L_to_Z * mag_tau / (us%kg_m3_to_R*cs%Rho0) )
   enddo ; enddo ; endif
  

References mom_domains::to_all.

Variable Documentation

◆ mdl

character(len=40) scm_cvmix_tests::mdl = "SCM_CVMix_tests"

private

This module's name.

Definition at line 50 of file SCM_CVMix_tests.F90.

50 character(len=40) :: mdl = "SCM_CVMix_tests" !< This module's name.

Referenced by scm_cvmix_tests_surface_forcing_init(), and scm_cvmix_tests_ts_init().

Detailed Description

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ scm_cvmix_tests_buoyancy_forcing()

◆ scm_cvmix_tests_surface_forcing_init()

◆ scm_cvmix_tests_ts_init()

◆ scm_cvmix_tests_wind_forcing()

Variable Documentation

◆ mdl