\hypertarget{classwaveparams}{\section{waveparams \-Module \-Reference}
\label{classwaveparams}\index{waveparams@{waveparams}}
}
\subsection*{\-Data \-Types}
\begin{DoxyCompactItemize}
\item 
type \hyperlink{structwaveparams_1_1waveparameters}{waveparameters}
\end{DoxyCompactItemize}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
subroutine, public \hyperlink{classwaveparams_aae5a8119ca22159abbff1392354a1631}{makebcf} (par, s, wp)
\begin{DoxyCompactList}\small\item\em \-Creates energy and flux boundary condition files ($\ast$.bcf). \end{DoxyCompactList}\item 
subroutine \hyperlink{classwaveparams_a364bd34f669afcf170a333b392727a75}{build\-\_\-jonswap} (par, s, wp, fname)
\item 
subroutine \hyperlink{classwaveparams_a4807c6ec60c15dcff4e549d68d3dbaf4}{swanreader} (par, s, wp, fname)
\item 
subroutine \hyperlink{classwaveparams_ab3e1d579510633f1606fb73ecb678837}{vardensreader} (par, s, wp, fname)
\item 
subroutine \hyperlink{classwaveparams_ae70cd53ba3f401c18d31897acb066a0e}{build\-\_\-etdir} (par, s, wp, \-Ebcfname)
\item 
subroutine \hyperlink{classwaveparams_a26815dfe6ac206f8fb1c25900315e347}{build\-\_\-boundw} (par, s, wp, qbcfname)
\item 
subroutine \hyperlink{classwaveparams_a0c9650bb967e3c644196ce64fabc54da}{jonswapgk} (x, gam, y)
\item 
subroutine \hyperlink{classwaveparams_a893ac376221219856c6adb614ef0df36}{tp\-Dcalc} (\-Sf, f, \-Trep, trepfac, switch)
\end{DoxyCompactItemize}
\subsection*{\-Private \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
subroutine \hyperlink{classwaveparams_ad3ade38313b03a86fbc33a79b495765d}{frange} (par, \-Sf, firstp, lastp, findlineout)
\item 
subroutine \hyperlink{classwaveparams_ac3d6a077248b973d0598a19edeeb1d6c}{bc\-\_\-disper} (k1, w1, m, h, g)
\item 
subroutine \hyperlink{classwaveparams_a326b025c8687a3f2ecd832ad36b2c566}{init\-\_\-seed}
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}


\-Definition at line 1 of file waveparams.\-F90.



\subsection{\-Member \-Function/\-Subroutine \-Documentation}
\hypertarget{classwaveparams_ac3d6a077248b973d0598a19edeeb1d6c}{\index{waveparams@{waveparams}!bc\-\_\-disper@{bc\-\_\-disper}}
\index{bc\-\_\-disper@{bc\-\_\-disper}!waveparams@{waveparams}}
\subsubsection[{bc\-\_\-disper}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::bc\-\_\-disper} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(m), intent(out)}]{k1, }
\item[{real$\ast$8, dimension(m), intent(in)}]{w1, }
\item[{integer, intent(in)}]{m, }
\item[{real$\ast$8, intent(in)}]{h, }
\item[{real$\ast$8, intent(in)}]{g}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classwaveparams_ac3d6a077248b973d0598a19edeeb1d6c}


\-Definition at line 1940 of file waveparams.\-F90.

\hypertarget{classwaveparams_a26815dfe6ac206f8fb1c25900315e347}{\index{waveparams@{waveparams}!build\-\_\-boundw@{build\-\_\-boundw}}
\index{build\-\_\-boundw@{build\-\_\-boundw}!waveparams@{waveparams}}
\subsubsection[{build\-\_\-boundw}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::build\-\_\-boundw} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(in)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp, }
\item[{character(len=$\ast$), intent(in)}]{qbcfname}
\end{DoxyParamCaption}
)}}\label{classwaveparams_a26815dfe6ac206f8fb1c25900315e347}


\-Definition at line 1539 of file waveparams.\-F90.

\hypertarget{classwaveparams_ae70cd53ba3f401c18d31897acb066a0e}{\index{waveparams@{waveparams}!build\-\_\-etdir@{build\-\_\-etdir}}
\index{build\-\_\-etdir@{build\-\_\-etdir}!waveparams@{waveparams}}
\subsubsection[{build\-\_\-etdir}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::build\-\_\-etdir} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(in)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp, }
\item[{character(len=$\ast$), intent(in)}]{\-Ebcfname}
\end{DoxyParamCaption}
)}}\label{classwaveparams_ae70cd53ba3f401c18d31897acb066a0e}


\-Definition at line 907 of file waveparams.\-F90.

\hypertarget{classwaveparams_a364bd34f669afcf170a333b392727a75}{\index{waveparams@{waveparams}!build\-\_\-jonswap@{build\-\_\-jonswap}}
\index{build\-\_\-jonswap@{build\-\_\-jonswap}!waveparams@{waveparams}}
\subsubsection[{build\-\_\-jonswap}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::build\-\_\-jonswap} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(inout)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp, }
\item[{character(len=$\ast$)}]{fname}
\end{DoxyParamCaption}
)}}\label{classwaveparams_a364bd34f669afcf170a333b392727a75}


\-Definition at line 207 of file waveparams.\-F90.

\hypertarget{classwaveparams_ad3ade38313b03a86fbc33a79b495765d}{\index{waveparams@{waveparams}!frange@{frange}}
\index{frange@{frange}!waveparams@{waveparams}}
\subsubsection[{frange}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::frange} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters})}]{par, }
\item[{real$\ast$8, dimension(\-:), intent(in)}]{\-Sf, }
\item[{integer, intent(out)}]{firstp, }
\item[{integer, intent(out)}]{lastp, }
\item[{real$\ast$8, dimension(\-:), intent(out)}]{findlineout}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classwaveparams_ad3ade38313b03a86fbc33a79b495765d}


\-Definition at line 1872 of file waveparams.\-F90.

\hypertarget{classwaveparams_a326b025c8687a3f2ecd832ad36b2c566}{\index{waveparams@{waveparams}!init\-\_\-seed@{init\-\_\-seed}}
\index{init\-\_\-seed@{init\-\_\-seed}!waveparams@{waveparams}}
\subsubsection[{init\-\_\-seed}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::init\-\_\-seed} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classwaveparams_a326b025c8687a3f2ecd832ad36b2c566}


\-Definition at line 2009 of file waveparams.\-F90.

\hypertarget{classwaveparams_a0c9650bb967e3c644196ce64fabc54da}{\index{waveparams@{waveparams}!jonswapgk@{jonswapgk}}
\index{jonswapgk@{jonswapgk}!waveparams@{waveparams}}
\subsubsection[{jonswapgk}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::jonswapgk} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(\-:), intent(in)}]{x, }
\item[{real$\ast$8, intent(in)}]{gam, }
\item[{real$\ast$8, dimension(\-:), intent(inout)}]{y}
\end{DoxyParamCaption}
)}}\label{classwaveparams_a0c9650bb967e3c644196ce64fabc54da}


\-Definition at line 1826 of file waveparams.\-F90.

\hypertarget{classwaveparams_aae5a8119ca22159abbff1392354a1631}{\index{waveparams@{waveparams}!makebcf@{makebcf}}
\index{makebcf@{makebcf}!waveparams@{waveparams}}
\subsubsection[{makebcf}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf waveparams\-::makebcf} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(inout)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp}
\end{DoxyParamCaption}
)}}\label{classwaveparams_aae5a8119ca22159abbff1392354a1631}


\-Creates energy and flux boundary condition files ($\ast$.bcf). 


\begin{DoxyParams}{\-Parameters}
{\em par} & struct with values from params.\-txt \\
\hline
{\em s} & struct with grid information \\
\hline
{\em wp} & struct with wave information \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{\-Returns}
void 
\end{DoxyReturn}
\begin{DoxyRefDesc}{\-Todo}
\item[\hyperlink{todo__todo000001}{\-Todo}]clean up \end{DoxyRefDesc}


\-Definition at line 37 of file waveparams.\-F90.

\hypertarget{classwaveparams_a4807c6ec60c15dcff4e549d68d3dbaf4}{\index{waveparams@{waveparams}!swanreader@{swanreader}}
\index{swanreader@{swanreader}!waveparams@{waveparams}}
\subsubsection[{swanreader}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::swanreader} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(inout)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp, }
\item[{character(len=$\ast$), intent(in)}]{fname}
\end{DoxyParamCaption}
)}}\label{classwaveparams_a4807c6ec60c15dcff4e549d68d3dbaf4}


\-Definition at line 427 of file waveparams.\-F90.

\hypertarget{classwaveparams_a893ac376221219856c6adb614ef0df36}{\index{waveparams@{waveparams}!tp\-Dcalc@{tp\-Dcalc}}
\index{tp\-Dcalc@{tp\-Dcalc}!waveparams@{waveparams}}
\subsubsection[{tp\-Dcalc}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::tp\-Dcalc} (
\begin{DoxyParamCaption}
\item[{real$\ast$8, dimension(\-:), intent(in)}]{\-Sf, }
\item[{real$\ast$8, dimension(\-:), intent(in)}]{f, }
\item[{real$\ast$8, intent(out)}]{\-Trep, }
\item[{real$\ast$8, intent(in)}]{trepfac, }
\item[{integer, intent(in)}]{switch}
\end{DoxyParamCaption}
)}}\label{classwaveparams_a893ac376221219856c6adb614ef0df36}


\-Definition at line 1911 of file waveparams.\-F90.

\hypertarget{classwaveparams_ab3e1d579510633f1606fb73ecb678837}{\index{waveparams@{waveparams}!vardensreader@{vardensreader}}
\index{vardensreader@{vardensreader}!waveparams@{waveparams}}
\subsubsection[{vardensreader}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf waveparams\-::vardensreader} (
\begin{DoxyParamCaption}
\item[{type({\bf parameters}), intent(inout)}]{par, }
\item[{type({\bf spacepars}), intent(in)}]{s, }
\item[{type({\bf waveparameters}), intent(inout)}]{wp, }
\item[{character(len=$\ast$), intent(in)}]{fname}
\end{DoxyParamCaption}
)}}\label{classwaveparams_ab3e1d579510633f1606fb73ecb678837}


\-Definition at line 777 of file waveparams.\-F90.



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