\hypertarget{classwave__functions__module}{\section{wave\-\_\-functions\-\_\-module \-Module \-Reference}
\label{classwave__functions__module}\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}}
}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
subroutine, public \hyperlink{classwave__functions__module_ab009f30c73e11889fad940d93ab03558}{update\-\_\-means\-\_\-wave\-\_\-flow} (s, par)
\item 
subroutine, public \hyperlink{classwave__functions__module_a6e654f430c50269d25ff36cdb9c40b38}{slope2\-D} (h, nx, ny, dsu, dnv, dhdx, dhdy, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_ac86a4e3f8d48b6046cf1725874f202e9}{advecxho} (ee, cgx, xadvec, nx, ny, ntheta, dnu, dsu, dsdnzi, scheme, wete, dt, dsz)
\item 
subroutine, public \hyperlink{classwave__functions__module_aef63eeaa1753de6121df294d3ae093ac}{advecthetaho} (ee, ctheta, thetaadvec, nx, ny, ntheta, dtheta, scheme, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_ab1e0e75821f1bf9f561b8e0b342e582f}{advecyho} (ee, cgy, yadvec, nx, ny, ntheta, dsv, dnv, dsdnzi, scheme, wete, dt, dnz)
\item 
subroutine, public \hyperlink{classwave__functions__module_a90a13775d09ab86fb989d750f32300e5}{advecwx} (arrin2d, xwadvec, kmx, nx, ny, dsu, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_aa298caf6d8517dd404269fe88a914db5}{advecwy} (arrin2d, ywadvec, kmy, nx, ny, dnv, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_a36e67eb2cfa5afcca8031035a72e1881}{advecqx} (c, arrin2d, xwadvec, nx, ny, dsu, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_af5ac7a2884bace327b7a71df2c1e2cf8}{advecqy} (c, arrin2d, ywadvec, nx, ny, dnv, wete)
\item 
subroutine, public \hyperlink{classwave__functions__module_af2bdc1ca4e87d44be170898f97ab3b99}{dispersion} (par, s, h)
\item 
elemental function, public \hyperlink{classwave__functions__module_a7d08af8778da8a8924fe89596267ea4e}{iteratedispersion} (\-L0, \-Lestimate, px, h)
\item 
subroutine, public \hyperlink{classwave__functions__module_a7a82438f96707b9f6e6fe44ec48b8689}{breakerdelay} (par, s)
\item 
subroutine, public \hyperlink{classwave__functions__module_abffc0b0e970ff75959ab145fe4a15d7d}{wave\-\_\-dispersion} (s, par, use\-Average\-Depth\-Switch)
\item 
subroutine, public \hyperlink{classwave__functions__module_a4ba42900ad4ceded3d62f861f7d58a53}{compute\-\_\-wave\-\_\-direction\-\_\-velocities} (s, par, flavour, dhdx, dhdy, dudx, dudy, dvdx, dvdy, sinh2kh)
\item 
subroutine, public \hyperlink{classwave__functions__module_a277c212624ccc6d9f0f9b1ea793e0098}{compute\-\_\-wave\-\_\-forces} (s)
\item 
subroutine, public \hyperlink{classwave__functions__module_af5bd30968b010fa20fc5586f6605fe7f}{compute\-\_\-stokes\-\_\-drift} (s, par)
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}


\-Definition at line 1 of file wave\-\_\-functions.\-F90.



\subsection{\-Member \-Function/\-Subroutine \-Documentation}
\hypertarget{classwave__functions__module_a36e67eb2cfa5afcca8031035a72e1881}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecqx@{advecqx}}
\index{advecqx@{advecqx}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecqx}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecqx} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{c, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{arrin2d, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{xwadvec, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsu, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a36e67eb2cfa5afcca8031035a72e1881}


\-Definition at line 585 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_af5ac7a2884bace327b7a71df2c1e2cf8}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecqy@{advecqy}}
\index{advecqy@{advecqy}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecqy}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecqy} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{c, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{arrin2d, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{ywadvec, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnv, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_af5ac7a2884bace327b7a71df2c1e2cf8}


\-Definition at line 627 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_aef63eeaa1753de6121df294d3ae093ac}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecthetaho@{advecthetaho}}
\index{advecthetaho@{advecthetaho}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecthetaho}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecthetaho} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{ee, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{ctheta, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{thetaadvec, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{integer}]{ntheta, }
\item[{real$\ast$8}]{dtheta, }
\item[{integer, intent(in)}]{scheme, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_aef63eeaa1753de6121df294d3ae093ac}


\-Definition at line 253 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a90a13775d09ab86fb989d750f32300e5}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecwx@{advecwx}}
\index{advecwx@{advecwx}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecwx}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecwx} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{arrin2d, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{xwadvec, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{kmx, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsu, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a90a13775d09ab86fb989d750f32300e5}


\-Definition at line 509 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_aa298caf6d8517dd404269fe88a914db5}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecwy@{advecwy}}
\index{advecwy@{advecwy}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecwy}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecwy} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{arrin2d, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{ywadvec, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{kmy, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnv, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_aa298caf6d8517dd404269fe88a914db5}


\-Definition at line 544 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_ac86a4e3f8d48b6046cf1725874f202e9}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecxho@{advecxho}}
\index{advecxho@{advecxho}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecxho}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecxho} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{ee, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{cgx, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{xadvec, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{integer}]{ntheta, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnu, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsu, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsdnzi, }
\item[{integer, intent(in)}]{scheme, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete, }
\item[{real$\ast$8, intent(in)}]{dt, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsz}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_ac86a4e3f8d48b6046cf1725874f202e9}


\-Definition at line 116 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_ab1e0e75821f1bf9f561b8e0b342e582f}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!advecyho@{advecyho}}
\index{advecyho@{advecyho}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{advecyho}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::advecyho} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{ee, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{cgy, }
\item[{real$\ast$8, dimension(nx+1,ny+1,ntheta)}]{yadvec, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{integer}]{ntheta, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsv, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnv, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsdnzi, }
\item[{integer, intent(in)}]{scheme, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete, }
\item[{real$\ast$8, intent(in)}]{dt, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnz}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_ab1e0e75821f1bf9f561b8e0b342e582f}


\-Definition at line 373 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a7a82438f96707b9f6e6fe44ec48b8689}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!breakerdelay@{breakerdelay}}
\index{breakerdelay@{breakerdelay}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{breakerdelay}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::breakerdelay} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters})}]{par, }
\item[{type(spacepars), target}]{s}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a7a82438f96707b9f6e6fe44ec48b8689}


\-Definition at line 812 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_af5bd30968b010fa20fc5586f6605fe7f}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!compute\-\_\-stokes\-\_\-drift@{compute\-\_\-stokes\-\_\-drift}}
\index{compute\-\_\-stokes\-\_\-drift@{compute\-\_\-stokes\-\_\-drift}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{compute\-\_\-stokes\-\_\-drift}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::compute\-\_\-stokes\-\_\-drift} (
\begin{DoxyParamCaption}
\item[{type(spacepars), target}]{s, }
\item[{type({\bf parameters})}]{par}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_af5bd30968b010fa20fc5586f6605fe7f}


\-Definition at line 1274 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a4ba42900ad4ceded3d62f861f7d58a53}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!compute\-\_\-wave\-\_\-direction\-\_\-velocities@{compute\-\_\-wave\-\_\-direction\-\_\-velocities}}
\index{compute\-\_\-wave\-\_\-direction\-\_\-velocities@{compute\-\_\-wave\-\_\-direction\-\_\-velocities}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{compute\-\_\-wave\-\_\-direction\-\_\-velocities}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::compute\-\_\-wave\-\_\-direction\-\_\-velocities} (
\begin{DoxyParamCaption}
\item[{type(spacepars), target}]{s, }
\item[{type({\bf parameters})}]{par, }
\item[{integer, intent(in)}]{flavour, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dhdx, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dhdy, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dudx, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dudy, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dvdx, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{dvdy, }
\item[{real$\ast$8, dimension(s\%nx+1,s\%ny+1), intent(in)}]{sinh2kh}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a4ba42900ad4ceded3d62f861f7d58a53}


\-Definition at line 1072 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a277c212624ccc6d9f0f9b1ea793e0098}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!compute\-\_\-wave\-\_\-forces@{compute\-\_\-wave\-\_\-forces}}
\index{compute\-\_\-wave\-\_\-forces@{compute\-\_\-wave\-\_\-forces}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{compute\-\_\-wave\-\_\-forces}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::compute\-\_\-wave\-\_\-forces} (
\begin{DoxyParamCaption}
\item[{type(spacepars), target}]{s}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a277c212624ccc6d9f0f9b1ea793e0098}


\-Definition at line 1196 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_af2bdc1ca4e87d44be170898f97ab3b99}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!dispersion@{dispersion}}
\index{dispersion@{dispersion}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{dispersion}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::dispersion} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters})}]{par, }
\item[{type(spacepars)}]{s, }
\item[{real$\ast$8, dimension(1\-:s\%nx+1,1\-:s\%ny+1), intent(in)}]{h}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_af2bdc1ca4e87d44be170898f97ab3b99}


\-Definition at line 658 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a7d08af8778da8a8924fe89596267ea4e}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!iteratedispersion@{iteratedispersion}}
\index{iteratedispersion@{iteratedispersion}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{iteratedispersion}]{\setlength{\rightskip}{0pt plus 5cm}elemental function, public {\bf wave\-\_\-functions\-\_\-module\-::iteratedispersion} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, intent(in)}]{\-L0, }
\item[{real$\ast$8, intent(in)}]{\-Lestimate, }
\item[{real$\ast$8, intent(in)}]{px, }
\item[{real$\ast$8, intent(in)}]{h}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a7d08af8778da8a8924fe89596267ea4e}


\-Definition at line 773 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_a6e654f430c50269d25ff36cdb9c40b38}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!slope2\-D@{slope2\-D}}
\index{slope2\-D@{slope2\-D}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{slope2\-D}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::slope2\-D} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{h, }
\item[{integer}]{nx, }
\item[{integer}]{ny, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dsu, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dnv, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dhdx, }
\item[{real$\ast$8, dimension(nx+1,ny+1)}]{dhdy, }
\item[{integer, dimension(nx+1,ny+1), intent(in)}]{wete}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_a6e654f430c50269d25ff36cdb9c40b38}


\-Definition at line 52 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_ab009f30c73e11889fad940d93ab03558}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!update\-\_\-means\-\_\-wave\-\_\-flow@{update\-\_\-means\-\_\-wave\-\_\-flow}}
\index{update\-\_\-means\-\_\-wave\-\_\-flow@{update\-\_\-means\-\_\-wave\-\_\-flow}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{update\-\_\-means\-\_\-wave\-\_\-flow}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::update\-\_\-means\-\_\-wave\-\_\-flow} (
\begin{DoxyParamCaption}
\item[{type(spacepars), target}]{s, }
\item[{type({\bf parameters})}]{par}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_ab009f30c73e11889fad940d93ab03558}


\-Definition at line 13 of file wave\-\_\-functions.\-F90.

\hypertarget{classwave__functions__module_abffc0b0e970ff75959ab145fe4a15d7d}{\index{wave\-\_\-functions\-\_\-module@{wave\-\_\-functions\-\_\-module}!wave\-\_\-dispersion@{wave\-\_\-dispersion}}
\index{wave\-\_\-dispersion@{wave\-\_\-dispersion}!wave_functions_module@{wave\-\_\-functions\-\_\-module}}
\subsubsection[{wave\-\_\-dispersion}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf wave\-\_\-functions\-\_\-module\-::wave\-\_\-dispersion} (
\begin{DoxyParamCaption}
\item[{type(spacepars), target}]{s, }
\item[{type({\bf parameters})}]{par, }
\item[{integer, intent(in), optional}]{use\-Average\-Depth\-Switch}
\end{DoxyParamCaption}
)}}\label{classwave__functions__module_abffc0b0e970ff75959ab145fe4a15d7d}


\-Definition at line 893 of file wave\-\_\-functions.\-F90.



\-The documentation for this module was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
\-C\-:/repositories/\-X\-Beach/trunk/src/xbeachlibrary/\hyperlink{wave__functions_8_f90}{wave\-\_\-functions.\-F90}\end{DoxyCompactItemize}
