\hypertarget{classsolver__module}{\section{solver\-\_\-module \-Module \-Reference}
\label{classsolver__module}\index{solver\-\_\-module@{solver\-\_\-module}}
}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
subroutine, public \hyperlink{classsolver__module_aad4a22baedff9b7125cfa302abbcf6e4}{solver\-\_\-init} (nx, ny, par)
\item 
subroutine, public \hyperlink{classsolver__module_a8032b27bd6ad538cec2929f6ba3ff727}{solver\-\_\-free}
\item 
subroutine, public \hyperlink{classsolver__module_a88ffefad1611f3d059a222aff2cc8ff9}{solver\-\_\-solvemat} (amat, rhs, x, nx, ny, par)
\item 
subroutine, public \hyperlink{classsolver__module_a3004986d08bf0ebd029577698b25d5a8}{solver\-\_\-tridiag} (amat, rhs, x, cmat, nx, ny, fixshallow)
\item 
subroutine, public \hyperlink{classsolver__module_a8fa5884c7225dee87ba9a4deef787bc7}{solver\-\_\-sip} (amat, rhs, x, res, cmat, it, nx, ny)
\end{DoxyCompactItemize}
\subsection*{\-Private \-Attributes}
\begin{DoxyCompactItemize}
\item 
logical \hyperlink{classsolver__module_ab7061bf13616fc88ded2a28ab71de523}{initialized} = .false.
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_a1de2e9431158fe3dd38fe67fd0e03f25}{itmea} = 0
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_adb32f07dfde34b234006864572aabda7}{itmin} = 0
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_aa214b0c87e4820728b3ef660c7853b74}{itmax} = 0
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_a3bfe9e3dadc97811b489441e81759472}{ittot} = 0
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_addbd08ccaaf5f1710207be1c4ff9a221}{itcal} = 0
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_adb4d1ac7b5d483f16077646899ffb05f}{itnconv} = 0
\item 
real(kind=r\-Kind) \hyperlink{classsolver__module_a97a5e7e1c979ed5aa0c9bb53315c0a27}{reps} = 0.\-005\-\_\-r\-Kind
\item 
real(kind=r\-Kind) \hyperlink{classsolver__module_ae4242c95b48694efe91fa09611ad3d31}{alpha} = 0.\-94\-\_\-r\-Kind
\item 
integer(kind=i\-Kind) \hyperlink{classsolver__module_aecee5b925400d18c46a8a1bcdff9c75f}{maxit} = 30
\item 
real(kind=r\-Kind), dimension(\-:,\-:), \*
allocatable \hyperlink{classsolver__module_aa06495f39324a128c710441a2c8fdb66}{residual}
\item 
real(kind=r\-Kind), dimension(\-:,\-:,\-:), \*
allocatable \hyperlink{classsolver__module_a66a3e613813f82ab3fd36bf9bb95b566}{work}
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}


\-Definition at line 9 of file solver.\-F90.



\subsection{\-Member \-Function/\-Subroutine \-Documentation}
\hypertarget{classsolver__module_a8032b27bd6ad538cec2929f6ba3ff727}{\index{solver\-\_\-module@{solver\-\_\-module}!solver\-\_\-free@{solver\-\_\-free}}
\index{solver\-\_\-free@{solver\-\_\-free}!solver_module@{solver\-\_\-module}}
\subsubsection[{solver\-\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf solver\-\_\-module\-::solver\-\_\-free} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classsolver__module_a8032b27bd6ad538cec2929f6ba3ff727}


\-Definition at line 130 of file solver.\-F90.

\hypertarget{classsolver__module_aad4a22baedff9b7125cfa302abbcf6e4}{\index{solver\-\_\-module@{solver\-\_\-module}!solver\-\_\-init@{solver\-\_\-init}}
\index{solver\-\_\-init@{solver\-\_\-init}!solver_module@{solver\-\_\-module}}
\subsubsection[{solver\-\_\-init}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf solver\-\_\-module\-::solver\-\_\-init} (
\begin{DoxyParamCaption}
\item[{integer, intent(in)}]{nx, }
\item[{integer, intent(in)}]{ny, }
\item[{type({\bf parameters}), intent(in)}]{par}
\end{DoxyParamCaption}
)}}\label{classsolver__module_aad4a22baedff9b7125cfa302abbcf6e4}


\-Definition at line 71 of file solver.\-F90.

\hypertarget{classsolver__module_a8fa5884c7225dee87ba9a4deef787bc7}{\index{solver\-\_\-module@{solver\-\_\-module}!solver\-\_\-sip@{solver\-\_\-sip}}
\index{solver\-\_\-sip@{solver\-\_\-sip}!solver_module@{solver\-\_\-module}}
\subsubsection[{solver\-\_\-sip}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf solver\-\_\-module\-::solver\-\_\-sip} (
\begin{DoxyParamCaption}
\item[{real(kind=r\-Kind), dimension(5,nx+1,ny+1), intent(in)}]{amat, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1), intent(in)}]{rhs, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1), intent(inout)}]{x, }
\item[{real(kind=r\-Kind), dimension(1\-:nx+1,1\-:ny+1), intent(inout)}]{res, }
\item[{real(kind=r\-Kind), dimension(5,1\-:nx+1,1\-:ny+1), intent(inout)}]{cmat, }
\item[{integer(kind=i\-Kind), intent(out)}]{it, }
\item[{integer, intent(in)}]{nx, }
\item[{integer, intent(in)}]{ny}
\end{DoxyParamCaption}
)}}\label{classsolver__module_a8fa5884c7225dee87ba9a4deef787bc7}


\-Definition at line 309 of file solver.\-F90.

\hypertarget{classsolver__module_a88ffefad1611f3d059a222aff2cc8ff9}{\index{solver\-\_\-module@{solver\-\_\-module}!solver\-\_\-solvemat@{solver\-\_\-solvemat}}
\index{solver\-\_\-solvemat@{solver\-\_\-solvemat}!solver_module@{solver\-\_\-module}}
\subsubsection[{solver\-\_\-solvemat}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf solver\-\_\-module\-::solver\-\_\-solvemat} (
\begin{DoxyParamCaption}
\item[{real(kind=r\-Kind), dimension(5,nx+1,ny+1)}]{amat, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1)}]{rhs, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1), intent(inout)}]{x, }
\item[{integer, intent(in)}]{nx, }
\item[{integer, intent(in)}]{ny, }
\item[{type({\bf parameters}), intent(in)}]{par}
\end{DoxyParamCaption}
)}}\label{classsolver__module_a88ffefad1611f3d059a222aff2cc8ff9}


\-Definition at line 145 of file solver.\-F90.

\hypertarget{classsolver__module_a3004986d08bf0ebd029577698b25d5a8}{\index{solver\-\_\-module@{solver\-\_\-module}!solver\-\_\-tridiag@{solver\-\_\-tridiag}}
\index{solver\-\_\-tridiag@{solver\-\_\-tridiag}!solver_module@{solver\-\_\-module}}
\subsubsection[{solver\-\_\-tridiag}]{\setlength{\rightskip}{0pt plus 5cm}subroutine, public {\bf solver\-\_\-module\-::solver\-\_\-tridiag} (
\begin{DoxyParamCaption}
\item[{real(kind=r\-Kind), dimension(5,nx+1,ny+1), intent(in)}]{amat, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1), intent(in)}]{rhs, }
\item[{real(kind=r\-Kind), dimension(nx+1,ny+1), intent(inout)}]{x, }
\item[{real(kind=r\-Kind), dimension(1\-:nx+1), intent(inout)}]{cmat, }
\item[{integer, intent(in)}]{nx, }
\item[{integer, intent(in)}]{ny, }
\item[{logical, intent(in), optional}]{fixshallow}
\end{DoxyParamCaption}
)}}\label{classsolver__module_a3004986d08bf0ebd029577698b25d5a8}


\-Definition at line 222 of file solver.\-F90.



\subsection{\-Member \-Data \-Documentation}
\hypertarget{classsolver__module_ae4242c95b48694efe91fa09611ad3d31}{\index{solver\-\_\-module@{solver\-\_\-module}!alpha@{alpha}}
\index{alpha@{alpha}!solver_module@{solver\-\_\-module}}
\subsubsection[{alpha}]{\setlength{\rightskip}{0pt plus 5cm}real(kind=r\-Kind) {\bf solver\-\_\-module\-::alpha} = 0.\-94\-\_\-r\-Kind\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_ae4242c95b48694efe91fa09611ad3d31}


\-Definition at line 40 of file solver.\-F90.

\hypertarget{classsolver__module_ab7061bf13616fc88ded2a28ab71de523}{\index{solver\-\_\-module@{solver\-\_\-module}!initialized@{initialized}}
\index{initialized@{initialized}!solver_module@{solver\-\_\-module}}
\subsubsection[{initialized}]{\setlength{\rightskip}{0pt plus 5cm}logical {\bf solver\-\_\-module\-::initialized} = .false.\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_ab7061bf13616fc88ded2a28ab71de523}


\-Definition at line 30 of file solver.\-F90.

\hypertarget{classsolver__module_addbd08ccaaf5f1710207be1c4ff9a221}{\index{solver\-\_\-module@{solver\-\_\-module}!itcal@{itcal}}
\index{itcal@{itcal}!solver_module@{solver\-\_\-module}}
\subsubsection[{itcal}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::itcal} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_addbd08ccaaf5f1710207be1c4ff9a221}


\-Definition at line 36 of file solver.\-F90.

\hypertarget{classsolver__module_aa214b0c87e4820728b3ef660c7853b74}{\index{solver\-\_\-module@{solver\-\_\-module}!itmax@{itmax}}
\index{itmax@{itmax}!solver_module@{solver\-\_\-module}}
\subsubsection[{itmax}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::itmax} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_aa214b0c87e4820728b3ef660c7853b74}


\-Definition at line 34 of file solver.\-F90.

\hypertarget{classsolver__module_a1de2e9431158fe3dd38fe67fd0e03f25}{\index{solver\-\_\-module@{solver\-\_\-module}!itmea@{itmea}}
\index{itmea@{itmea}!solver_module@{solver\-\_\-module}}
\subsubsection[{itmea}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::itmea} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_a1de2e9431158fe3dd38fe67fd0e03f25}


\-Definition at line 32 of file solver.\-F90.

\hypertarget{classsolver__module_adb32f07dfde34b234006864572aabda7}{\index{solver\-\_\-module@{solver\-\_\-module}!itmin@{itmin}}
\index{itmin@{itmin}!solver_module@{solver\-\_\-module}}
\subsubsection[{itmin}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::itmin} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_adb32f07dfde34b234006864572aabda7}


\-Definition at line 33 of file solver.\-F90.

\hypertarget{classsolver__module_adb4d1ac7b5d483f16077646899ffb05f}{\index{solver\-\_\-module@{solver\-\_\-module}!itnconv@{itnconv}}
\index{itnconv@{itnconv}!solver_module@{solver\-\_\-module}}
\subsubsection[{itnconv}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::itnconv} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_adb4d1ac7b5d483f16077646899ffb05f}


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

\hypertarget{classsolver__module_a3bfe9e3dadc97811b489441e81759472}{\index{solver\-\_\-module@{solver\-\_\-module}!ittot@{ittot}}
\index{ittot@{ittot}!solver_module@{solver\-\_\-module}}
\subsubsection[{ittot}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::ittot} = 0\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_a3bfe9e3dadc97811b489441e81759472}


\-Definition at line 35 of file solver.\-F90.

\hypertarget{classsolver__module_aecee5b925400d18c46a8a1bcdff9c75f}{\index{solver\-\_\-module@{solver\-\_\-module}!maxit@{maxit}}
\index{maxit@{maxit}!solver_module@{solver\-\_\-module}}
\subsubsection[{maxit}]{\setlength{\rightskip}{0pt plus 5cm}integer(kind=i\-Kind) {\bf solver\-\_\-module\-::maxit} = 30\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_aecee5b925400d18c46a8a1bcdff9c75f}


\-Definition at line 41 of file solver.\-F90.

\hypertarget{classsolver__module_a97a5e7e1c979ed5aa0c9bb53315c0a27}{\index{solver\-\_\-module@{solver\-\_\-module}!reps@{reps}}
\index{reps@{reps}!solver_module@{solver\-\_\-module}}
\subsubsection[{reps}]{\setlength{\rightskip}{0pt plus 5cm}real(kind=r\-Kind) {\bf solver\-\_\-module\-::reps} = 0.\-005\-\_\-r\-Kind\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_a97a5e7e1c979ed5aa0c9bb53315c0a27}


\-Definition at line 39 of file solver.\-F90.

\hypertarget{classsolver__module_aa06495f39324a128c710441a2c8fdb66}{\index{solver\-\_\-module@{solver\-\_\-module}!residual@{residual}}
\index{residual@{residual}!solver_module@{solver\-\_\-module}}
\subsubsection[{residual}]{\setlength{\rightskip}{0pt plus 5cm}real(kind=r\-Kind), dimension(\-:,\-:), allocatable {\bf solver\-\_\-module\-::residual}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_aa06495f39324a128c710441a2c8fdb66}


\-Definition at line 44 of file solver.\-F90.

\hypertarget{classsolver__module_a66a3e613813f82ab3fd36bf9bb95b566}{\index{solver\-\_\-module@{solver\-\_\-module}!work@{work}}
\index{work@{work}!solver_module@{solver\-\_\-module}}
\subsubsection[{work}]{\setlength{\rightskip}{0pt plus 5cm}real(kind=r\-Kind), dimension(\-:,\-:,\-:), allocatable {\bf solver\-\_\-module\-::work}\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classsolver__module_a66a3e613813f82ab3fd36bf9bb95b566}


\-Definition at line 45 of file solver.\-F90.



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