Detailed Description

Container for all surface wave related parameters.

Definition at line 47 of file MOM_wave_interface.F90.

Collaboration diagram for mom_wave_interface::wave_parameters_cs:

Public variables and constants
logical, public	usewaves
	Flag to enable surface gravity wave feature. More...

logical, public	lagrangianmixing
	This feature is in development and not ready True if Stokes drift is present and mixing should be applied to Lagrangian current (mean current + Stokes drift). See Reichl et al., 2016 KPP-LT approach. More...

logical, public	stokesmixing
	This feature is in development and not ready. True if vertical mixing of momentum should be applied directly to Stokes current (with separate mixing parameter for Eulerian mixing contribution). See Harcourt 2013, 2015 Second-Moment approach. More...

logical, public	coriolisstokes
	This feature is in development and not ready. More...

integer, public	stklevelmode =1
	Sets if Stokes drift is defined at mid-points or layer averaged. Set to 0 if mid-point and set to 1 if average value of Stokes drift over level. If advecting with Stokes transport, 1 is the correct approach. More...

real, dimension(:), allocatable, public	wavenum_cen
	Wavenumber bands for read/coupled [m-1]. More...

real, dimension(:), allocatable, public	freq_cen
	Frequency bands for read/coupled [s-1]. More...

real, dimension(:), allocatable, public	prescribedsurfstkx
	Surface Stokes drift if prescribed [m s-1]. More...

real, dimension(:), allocatable, public	prescribedsurfstky
	Surface Stokes drift if prescribed [m s-1]. More...

real, dimension(:,:,:), allocatable, public	us_x
	3d zonal Stokes drift profile [m s-1] More...

real, dimension(:,:,:), allocatable, public	us_y
	3d meridional Stokes drift profile [m s-1] More...

real, dimension(:,:), allocatable, public	la_sl
	SL Langmuir number (directionality factored later) More...

real, dimension(:,:), allocatable, public	la_turb
	Aligned Turbulent Langmuir number. More...

real, dimension(:,:), allocatable, public	us0_x
	Surface Stokes Drift (zonal, m/s) More...

real, dimension(:,:), allocatable, public	us0_y
	Surface Stokes Drift (meridional, m/s) More...

real, dimension(:,:,:), allocatable, public	stkx0
	Stokes Drift spectrum (zonal, m/s) More...

real, dimension(:,:,:), allocatable, public	stky0
	Stokes Drift spectrum (meridional, m/s) More...

real, dimension(:,:,:), allocatable, public	kvs
	Viscosity for Stokes Drift shear [Z2 T-1 ~> m2 s-1]. More...

type(time_type), pointer, public	time
	A pointer to the ocean model's clock. More...

type(diag_ctrl), pointer, public	diag
	A structure that is used to regulate the timing of diagnostic output. More...

real	la_min = 0.05
	An arbitrary lower-bound on the Langmuir number. Run-time parameter. Langmuir number is sqrt(u_star/u_stokes). When both are small but u_star is orders of magnitude smaller the Langmuir number could have unintended consequences. Since both are small it can be safely capped to avoid such consequences. More...


integer, public	id_surfacestokes_x = -1
	Diagnostic handles. More...

integer, public	id_surfacestokes_y = -1
	Diagnostic handles. More...

integer, public	id_3dstokes_x = -1
	Diagnostic handles. More...

integer, public	id_3dstokes_y = -1
	Diagnostic handles. More...

integer, public	id_la_turb = -1
	Diagnostic handles. More...

Variables and constants

◆ coriolisstokes

logical, public mom_wave_interface::wave_parameters_cs::coriolisstokes

This feature is in development and not ready.

Definition at line 62 of file MOM_wave_interface.F90.

62 logical, public :: CoriolisStokes !< This feature is in development and not ready.

◆ diag

type(diag_ctrl), pointer, public mom_wave_interface::wave_parameters_cs::diag

A structure that is used to regulate the timing of diagnostic output.

Definition at line 111 of file MOM_wave_interface.F90.

111 type(diag_ctrl), pointer, public :: diag !< A structure that is used to regulate the

◆ freq_cen

real, dimension(:), allocatable, public mom_wave_interface::wave_parameters_cs::freq_cen

Frequency bands for read/coupled [s-1].

Definition at line 73 of file MOM_wave_interface.F90.

73 real, allocatable, dimension(:), public :: &

74 Freq_Cen !< Frequency bands for read/coupled [s-1]

◆ id_3dstokes_x

integer, public mom_wave_interface::wave_parameters_cs::id_3dstokes_x = -1

Diagnostic handles.

Definition at line 123 of file MOM_wave_interface.F90.

123 integer, public :: id_3dstokes_x = -1 , id_3dstokes_y = -1

◆ id_3dstokes_y

integer, public mom_wave_interface::wave_parameters_cs::id_3dstokes_y = -1

Diagnostic handles.

Definition at line 123 of file MOM_wave_interface.F90.

◆ id_la_turb

integer, public mom_wave_interface::wave_parameters_cs::id_la_turb = -1

Diagnostic handles.

Definition at line 124 of file MOM_wave_interface.F90.

124 integer, public :: id_La_turb = -1

◆ id_surfacestokes_x

integer, public mom_wave_interface::wave_parameters_cs::id_surfacestokes_x = -1

Diagnostic handles.

Definition at line 122 of file MOM_wave_interface.F90.

122 integer, public :: id_surfacestokes_x = -1 , id_surfacestokes_y = -1

◆ id_surfacestokes_y

integer, public mom_wave_interface::wave_parameters_cs::id_surfacestokes_y = -1

Diagnostic handles.

Definition at line 122 of file MOM_wave_interface.F90.

◆ kvs

real, dimension(:,:,:), allocatable, public mom_wave_interface::wave_parameters_cs::kvs

Viscosity for Stokes Drift shear [Z2 T-1 ~> m2 s-1].

Definition at line 106 of file MOM_wave_interface.F90.

106 real, allocatable, dimension(:,:,:), public :: &

107 KvS !< Viscosity for Stokes Drift shear [Z2 T-1 ~> m2 s-1]

◆ la_min

real mom_wave_interface::wave_parameters_cs::la_min = 0.05

An arbitrary lower-bound on the Langmuir number. Run-time parameter. Langmuir number is sqrt(u_star/u_stokes). When both are small but u_star is orders of magnitude smaller the Langmuir number could have unintended consequences. Since both are small it can be safely capped to avoid such consequences.

Definition at line 119 of file MOM_wave_interface.F90.

119 real :: La_min = 0.05

◆ la_sl

real, dimension(:,:), allocatable, public mom_wave_interface::wave_parameters_cs::la_sl

SL Langmuir number (directionality factored later)

Definition at line 87 of file MOM_wave_interface.F90.

   real, allocatable, dimension(:,:), public :: &
        La_SL,&            !< SL Langmuir number (directionality factored later)
                           !! Horizontal -> H points
        la_turb            !< Aligned Turbulent Langmuir number

◆ la_turb

real, dimension(:,:), allocatable, public mom_wave_interface::wave_parameters_cs::la_turb

Aligned Turbulent Langmuir number.

Definition at line 87 of file MOM_wave_interface.F90.

◆ lagrangianmixing

logical, public mom_wave_interface::wave_parameters_cs::lagrangianmixing

This feature is in development and not ready True if Stokes drift is present and mixing should be applied to Lagrangian current (mean current + Stokes drift). See Reichl et al., 2016 KPP-LT approach.

Definition at line 51 of file MOM_wave_interface.F90.

51 logical, public :: LagrangianMixing !< This feature is in development and not ready

◆ prescribedsurfstkx

real, dimension(:), allocatable, public mom_wave_interface::wave_parameters_cs::prescribedsurfstkx

Surface Stokes drift if prescribed [m s-1].

Definition at line 75 of file MOM_wave_interface.F90.

75 real, allocatable, dimension(:), public :: &

76 PrescribedSurfStkX !< Surface Stokes drift if prescribed [m s-1]

◆ prescribedsurfstky

real, dimension(:), allocatable, public mom_wave_interface::wave_parameters_cs::prescribedsurfstky

Surface Stokes drift if prescribed [m s-1].

Definition at line 77 of file MOM_wave_interface.F90.

77 real, allocatable, dimension(:), public :: &

78 PrescribedSurfStkY !< Surface Stokes drift if prescribed [m s-1]

◆ stklevelmode

integer, public mom_wave_interface::wave_parameters_cs::stklevelmode =1

Sets if Stokes drift is defined at mid-points or layer averaged. Set to 0 if mid-point and set to 1 if average value of Stokes drift over level. If advecting with Stokes transport, 1 is the correct approach.

Definition at line 64 of file MOM_wave_interface.F90.

64 integer, public :: StkLevelMode=1 !< Sets if Stokes drift is defined at mid-points

◆ stkx0

real, dimension(:,:,:), allocatable, public mom_wave_interface::wave_parameters_cs::stkx0

Stokes Drift spectrum (zonal, m/s)

Definition at line 98 of file MOM_wave_interface.F90.

98 real, allocatable, dimension(:,:,:), public :: &

99 STKx0 !< Stokes Drift spectrum (zonal, m/s)

◆ stky0

real, dimension(:,:,:), allocatable, public mom_wave_interface::wave_parameters_cs::stky0

Stokes Drift spectrum (meridional, m/s)

Definition at line 102 of file MOM_wave_interface.F90.

102 real, allocatable, dimension(:,:,:), public :: &

103 STKy0 !< Stokes Drift spectrum (meridional, m/s)

◆ stokesmixing

logical, public mom_wave_interface::wave_parameters_cs::stokesmixing

This feature is in development and not ready. True if vertical mixing of momentum should be applied directly to Stokes current (with separate mixing parameter for Eulerian mixing contribution). See Harcourt 2013, 2015 Second-Moment approach.

Definition at line 56 of file MOM_wave_interface.F90.

56 logical, public :: StokesMixing !< This feature is in development and not ready.

◆ time

type(time_type), pointer, public mom_wave_interface::wave_parameters_cs::time

A pointer to the ocean model's clock.

Definition at line 110 of file MOM_wave_interface.F90.

110 type(time_type), pointer, public :: Time !< A pointer to the ocean model's clock.

◆ us0_x

real, dimension(:,:), allocatable, public mom_wave_interface::wave_parameters_cs::us0_x

Surface Stokes Drift (zonal, m/s)

Definition at line 92 of file MOM_wave_interface.F90.

92 real, allocatable, dimension(:,:), public :: &

93 US0_x !< Surface Stokes Drift (zonal, m/s)

◆ us0_y

real, dimension(:,:), allocatable, public mom_wave_interface::wave_parameters_cs::us0_y

Surface Stokes Drift (meridional, m/s)

Definition at line 95 of file MOM_wave_interface.F90.

95 real, allocatable, dimension(:,:), public :: &

96 US0_y !< Surface Stokes Drift (meridional, m/s)

◆ us_x

real, dimension(:,:,:), allocatable, public mom_wave_interface::wave_parameters_cs::us_x

3d zonal Stokes drift profile [m s-1]

Definition at line 79 of file MOM_wave_interface.F90.

79 real, allocatable, dimension(:,:,:), public :: &

80 Us_x !< 3d zonal Stokes drift profile [m s-1]

◆ us_y

real, dimension(:,:,:), allocatable, public mom_wave_interface::wave_parameters_cs::us_y

3d meridional Stokes drift profile [m s-1]

Definition at line 83 of file MOM_wave_interface.F90.

83 real, allocatable, dimension(:,:,:), public :: &

84 Us_y !< 3d meridional Stokes drift profile [m s-1]

◆ usewaves

logical, public mom_wave_interface::wave_parameters_cs::usewaves

Flag to enable surface gravity wave feature.

Definition at line 50 of file MOM_wave_interface.F90.

50 logical, public :: UseWaves !< Flag to enable surface gravity wave feature

◆ wavenum_cen

real, dimension(:), allocatable, public mom_wave_interface::wave_parameters_cs::wavenum_cen

Wavenumber bands for read/coupled [m-1].

Definition at line 71 of file MOM_wave_interface.F90.

71 real, allocatable, dimension(:), public :: &

72 WaveNum_Cen !< Wavenumber bands for read/coupled [m-1]

The documentation for this type was generated from the following file:

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/user/MOM_wave_interface.F90

Detailed Description

Public variables and constants

Variables and constants

◆ coriolisstokes

◆ diag

◆ freq_cen

◆ id_3dstokes_x

◆ id_3dstokes_y

◆ id_la_turb

◆ id_surfacestokes_x

◆ id_surfacestokes_y

◆ kvs

◆ la_min

◆ la_sl

◆ la_turb

◆ lagrangianmixing

◆ prescribedsurfstkx

◆ prescribedsurfstky

◆ stklevelmode

◆ stkx0

◆ stky0

◆ stokesmixing

◆ time

◆ us0_x

◆ us0_y

◆ us_x

◆ us_y

◆ usewaves

◆ wavenum_cen