\hypertarget{structmom__wave__interface_1_1wave__parameters__cs}{}\doxysection{mom\+\_\+wave\+\_\+interface\+::wave\+\_\+parameters\+\_\+cs Type Reference}
\label{structmom__wave__interface_1_1wave__parameters__cs}\index{mom\_wave\_interface::wave\_parameters\_cs@{mom\_wave\_interface::wave\_parameters\_cs}}


\doxysubsection{Detailed Description}
Container for all surface wave related parameters. 

Definition at line 47 of file M\+O\+M\+\_\+wave\+\_\+interface.\+F90.



Collaboration diagram for mom\+\_\+wave\+\_\+interface\+::wave\+\_\+parameters\+\_\+cs\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{structmom__wave__interface_1_1wave__parameters__cs__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public variables and constants}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_af7cd09d9059fb56e638ea88e7848e5ea}\label{structmom__wave__interface_1_1wave__parameters__cs_af7cd09d9059fb56e638ea88e7848e5ea}} 
logical, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_af7cd09d9059fb56e638ea88e7848e5ea}{usewaves}}
\begin{DoxyCompactList}\small\item\em Flag to enable surface gravity wave feature. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_af4427b0a982c7fd947bd32f3bae48e81}\label{structmom__wave__interface_1_1wave__parameters__cs_af4427b0a982c7fd947bd32f3bae48e81}} 
logical, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_af4427b0a982c7fd947bd32f3bae48e81}{lagrangianmixing}}
\begin{DoxyCompactList}\small\item\em 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 K\+P\+P-\/\+LT approach. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a4d6614db099baf7cbd86fe4f3533b809}\label{structmom__wave__interface_1_1wave__parameters__cs_a4d6614db099baf7cbd86fe4f3533b809}} 
logical, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a4d6614db099baf7cbd86fe4f3533b809}{stokesmixing}}
\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a25146741562f4ad32f1adb9480e43923}\label{structmom__wave__interface_1_1wave__parameters__cs_a25146741562f4ad32f1adb9480e43923}} 
logical, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a25146741562f4ad32f1adb9480e43923}{coriolisstokes}}
\begin{DoxyCompactList}\small\item\em This feature is in development and not ready. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_af77e5768c556646e5de9201312978a48}\label{structmom__wave__interface_1_1wave__parameters__cs_af77e5768c556646e5de9201312978a48}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_af77e5768c556646e5de9201312978a48}{stklevelmode}} =1
\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_aa05fccc306b6d9e0f1c73f8e74817368}\label{structmom__wave__interface_1_1wave__parameters__cs_aa05fccc306b6d9e0f1c73f8e74817368}} 
real, dimension(\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_aa05fccc306b6d9e0f1c73f8e74817368}{wavenum\+\_\+cen}}
\begin{DoxyCompactList}\small\item\em Wavenumber bands for read/coupled \mbox{[}m-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a2769119ac673bc982aa10458ead55702}\label{structmom__wave__interface_1_1wave__parameters__cs_a2769119ac673bc982aa10458ead55702}} 
real, dimension(\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a2769119ac673bc982aa10458ead55702}{freq\+\_\+cen}}
\begin{DoxyCompactList}\small\item\em Frequency bands for read/coupled \mbox{[}s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_ae9b60d421487a1739d33dabd0bb492ac}\label{structmom__wave__interface_1_1wave__parameters__cs_ae9b60d421487a1739d33dabd0bb492ac}} 
real, dimension(\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_ae9b60d421487a1739d33dabd0bb492ac}{prescribedsurfstkx}}
\begin{DoxyCompactList}\small\item\em Surface Stokes drift if prescribed \mbox{[}m s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a1768650cb3f360b06ac6424087559f00}\label{structmom__wave__interface_1_1wave__parameters__cs_a1768650cb3f360b06ac6424087559f00}} 
real, dimension(\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a1768650cb3f360b06ac6424087559f00}{prescribedsurfstky}}
\begin{DoxyCompactList}\small\item\em Surface Stokes drift if prescribed \mbox{[}m s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a7262967a39319fe9c67834ed55b8670e}\label{structmom__wave__interface_1_1wave__parameters__cs_a7262967a39319fe9c67834ed55b8670e}} 
real, dimension(\+:,\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a7262967a39319fe9c67834ed55b8670e}{us\+\_\+x}}
\begin{DoxyCompactList}\small\item\em 3d zonal Stokes drift profile \mbox{[}m s-\/1\mbox{]} \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a4164f38a0c0db5ef88d206ec33e42600}\label{structmom__wave__interface_1_1wave__parameters__cs_a4164f38a0c0db5ef88d206ec33e42600}} 
real, dimension(\+:,\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a4164f38a0c0db5ef88d206ec33e42600}{us\+\_\+y}}
\begin{DoxyCompactList}\small\item\em 3d meridional Stokes drift profile \mbox{[}m s-\/1\mbox{]} \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_af8a070d71801862363cbdcf6dfa59218}\label{structmom__wave__interface_1_1wave__parameters__cs_af8a070d71801862363cbdcf6dfa59218}} 
real, dimension(\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_af8a070d71801862363cbdcf6dfa59218}{la\+\_\+sl}}
\begin{DoxyCompactList}\small\item\em SL Langmuir number (directionality factored later) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a33f1e3d0d55400828de43949fc1d37fe}\label{structmom__wave__interface_1_1wave__parameters__cs_a33f1e3d0d55400828de43949fc1d37fe}} 
real, dimension(\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a33f1e3d0d55400828de43949fc1d37fe}{la\+\_\+turb}}
\begin{DoxyCompactList}\small\item\em Aligned Turbulent Langmuir number. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_aee9f62cc240ff56b410db95c90a2be41}\label{structmom__wave__interface_1_1wave__parameters__cs_aee9f62cc240ff56b410db95c90a2be41}} 
real, dimension(\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_aee9f62cc240ff56b410db95c90a2be41}{us0\+\_\+x}}
\begin{DoxyCompactList}\small\item\em Surface Stokes Drift (zonal, m/s) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a47978a7fb4d4586793e84c4148169534}\label{structmom__wave__interface_1_1wave__parameters__cs_a47978a7fb4d4586793e84c4148169534}} 
real, dimension(\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a47978a7fb4d4586793e84c4148169534}{us0\+\_\+y}}
\begin{DoxyCompactList}\small\item\em Surface Stokes Drift (meridional, m/s) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_ab79b75f62b57ed77a42c3e88bdf9ea36}\label{structmom__wave__interface_1_1wave__parameters__cs_ab79b75f62b57ed77a42c3e88bdf9ea36}} 
real, dimension(\+:,\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_ab79b75f62b57ed77a42c3e88bdf9ea36}{stkx0}}
\begin{DoxyCompactList}\small\item\em Stokes Drift spectrum (zonal, m/s) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a5336e3533b6e4a3544300710a5f5ceea}\label{structmom__wave__interface_1_1wave__parameters__cs_a5336e3533b6e4a3544300710a5f5ceea}} 
real, dimension(\+:,\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a5336e3533b6e4a3544300710a5f5ceea}{stky0}}
\begin{DoxyCompactList}\small\item\em Stokes Drift spectrum (meridional, m/s) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_ab05260ee04c6d4749c4f5cbee5d91aa6}\label{structmom__wave__interface_1_1wave__parameters__cs_ab05260ee04c6d4749c4f5cbee5d91aa6}} 
real, dimension(\+:,\+:,\+:), allocatable, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_ab05260ee04c6d4749c4f5cbee5d91aa6}{kvs}}
\begin{DoxyCompactList}\small\item\em Viscosity for Stokes Drift shear \mbox{[}Z2 T-\/1 $\sim$$>$ m2 s-\/1\mbox{]}. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_ab97fbca41af6593a2e1601412253fe47}\label{structmom__wave__interface_1_1wave__parameters__cs_ab97fbca41af6593a2e1601412253fe47}} 
type(time\+\_\+type), pointer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_ab97fbca41af6593a2e1601412253fe47}{time}}
\begin{DoxyCompactList}\small\item\em A pointer to the ocean model\textquotesingle{}s clock. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_abee100b671f387f3c96856b06a221cc1}\label{structmom__wave__interface_1_1wave__parameters__cs_abee100b671f387f3c96856b06a221cc1}} 
type(\mbox{\hyperlink{structmom__diag__mediator_1_1diag__ctrl}{diag\+\_\+ctrl}}), pointer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_abee100b671f387f3c96856b06a221cc1}{diag}}
\begin{DoxyCompactList}\small\item\em A structure that is used to regulate the timing of diagnostic output. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a6e98a5f9dd5947c6ee4073b84ac02693}\label{structmom__wave__interface_1_1wave__parameters__cs_a6e98a5f9dd5947c6ee4073b84ac02693}} 
real \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a6e98a5f9dd5947c6ee4073b84ac02693}{la\+\_\+min}} = 0.\+05
\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\end{DoxyCompactItemize}
\textbf{ }\par
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a41fdb06d2b863eab7d25be13bcabc42b}\label{structmom__wave__interface_1_1wave__parameters__cs_a41fdb06d2b863eab7d25be13bcabc42b}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a41fdb06d2b863eab7d25be13bcabc42b}{id\+\_\+surfacestokes\+\_\+x}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic handles. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_aa8a27984cda428cea56487aaa5ccf4f4}\label{structmom__wave__interface_1_1wave__parameters__cs_aa8a27984cda428cea56487aaa5ccf4f4}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_aa8a27984cda428cea56487aaa5ccf4f4}{id\+\_\+surfacestokes\+\_\+y}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic handles. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a140d4843ae03b85451f14140ed76f140}\label{structmom__wave__interface_1_1wave__parameters__cs_a140d4843ae03b85451f14140ed76f140}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a140d4843ae03b85451f14140ed76f140}{id\+\_\+3dstokes\+\_\+x}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic handles. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a0cec4c75d608e0551dc050321179e84a}\label{structmom__wave__interface_1_1wave__parameters__cs_a0cec4c75d608e0551dc050321179e84a}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a0cec4c75d608e0551dc050321179e84a}{id\+\_\+3dstokes\+\_\+y}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic handles. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{structmom__wave__interface_1_1wave__parameters__cs_a2a1b4b545bfb9b61fcef14ae1932b29c}\label{structmom__wave__interface_1_1wave__parameters__cs_a2a1b4b545bfb9b61fcef14ae1932b29c}} 
integer, public \mbox{\hyperlink{structmom__wave__interface_1_1wave__parameters__cs_a2a1b4b545bfb9b61fcef14ae1932b29c}{id\+\_\+la\+\_\+turb}} = -\/1
\begin{DoxyCompactList}\small\item\em Diagnostic handles. \end{DoxyCompactList}\end{DoxyCompactItemize}



\doxysubsection{Detailed Description}
Container for all surface wave related parameters. 

Definition at line 47 of file M\+O\+M\+\_\+wave\+\_\+interface.\+F90.



The documentation for this type was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/home/cermak/src/\+M\+O\+M6.\+devrob/src/user/M\+O\+M\+\_\+wave\+\_\+interface.\+F90\end{DoxyCompactItemize}
