\hypertarget{classxbeach__bmi}{\section{xbeach\-\_\-bmi \-Module \-Reference}
\label{classxbeach__bmi}\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}}
}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
subroutine \hyperlink{classxbeach__bmi_a89eed08be7c6ad6451651703c55faac4}{get\-\_\-var\-\_\-type} (c\-\_\-var\-\_\-name, c\-\_\-type\-\_\-name)
\item 
subroutine \hyperlink{classxbeach__bmi_a7e07912697de534dac755ec88c5d8a98}{get\-\_\-current\-\_\-time} (time)
\end{DoxyCompactItemize}
\subsection*{\-Private \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
integer(c\-\_\-int) function \hyperlink{classxbeach__bmi_a71deffbd14cd48fc80cf390807571cad}{finalize} ()
\item 
integer(c\-\_\-int) function \hyperlink{classxbeach__bmi_aab11de777a7108baa7a8c0df96e0d7f6}{initialize} (c\-\_\-configfile)
\item 
integer(c\-\_\-int) function \hyperlink{classxbeach__bmi_a583c70350dfb1bd6662314e590956449}{update} (dt)
\begin{DoxyCompactList}\small\item\em \-Performs a single timestep with the current model. \end{DoxyCompactList}\item 
subroutine \hyperlink{classxbeach__bmi_a22721fe43bcddf4e6c4acdcb389bb198}{get\-\_\-var\-\_\-rank} (c\-\_\-var\-\_\-name, rank)
\item 
subroutine \hyperlink{classxbeach__bmi_a94927455df84f8fc07bcb3253d64708c}{set\-\_\-current\-\_\-time} (xptr)
\item 
subroutine \hyperlink{classxbeach__bmi_a4a1225317eb6e6f3f691508b7cb3b229}{get\-\_\-start\-\_\-time} (time)
\item 
subroutine \hyperlink{classxbeach__bmi_a229893345b279120ff5a2e0863442343}{get\-\_\-time\-\_\-step} (timestep)
\item 
subroutine \hyperlink{classxbeach__bmi_aaa61115c9b7f95f95562d6a89829bc0f}{get\-\_\-end\-\_\-time} (time)
\end{DoxyCompactItemize}
\subsection*{\-Private \-Attributes}
\begin{DoxyCompactItemize}
\item 
integer(c\-\_\-int), parameter \hyperlink{classxbeach__bmi_aa463c37ff989fac4356db0d202d62845}{\-M\-A\-X\-D\-I\-M\-S} = 6
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}


\-Definition at line 1 of file xbeach\-\_\-bmi.\-f90.



\subsection{\-Member \-Function/\-Subroutine \-Documentation}
\hypertarget{classxbeach__bmi_a71deffbd14cd48fc80cf390807571cad}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!finalize@{finalize}}
\index{finalize@{finalize}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{finalize}]{\setlength{\rightskip}{0pt plus 5cm}integer(c\-\_\-int) function {\bf xbeach\-\_\-bmi\-::finalize} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a71deffbd14cd48fc80cf390807571cad}


\-Definition at line 35 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a7e07912697de534dac755ec88c5d8a98}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-current\-\_\-time@{get\-\_\-current\-\_\-time}}
\index{get\-\_\-current\-\_\-time@{get\-\_\-current\-\_\-time}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-current\-\_\-time}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-current\-\_\-time} (
\begin{DoxyParamCaption}
\item[{real(c\-\_\-double)}]{time}
\end{DoxyParamCaption}
)}}\label{classxbeach__bmi_a7e07912697de534dac755ec88c5d8a98}


\-Definition at line 158 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_aaa61115c9b7f95f95562d6a89829bc0f}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-end\-\_\-time@{get\-\_\-end\-\_\-time}}
\index{get\-\_\-end\-\_\-time@{get\-\_\-end\-\_\-time}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-end\-\_\-time}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-end\-\_\-time} (
\begin{DoxyParamCaption}
\item[{real(c\-\_\-double)}]{time}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_aaa61115c9b7f95f95562d6a89829bc0f}


\-Definition at line 191 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a4a1225317eb6e6f3f691508b7cb3b229}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-start\-\_\-time@{get\-\_\-start\-\_\-time}}
\index{get\-\_\-start\-\_\-time@{get\-\_\-start\-\_\-time}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-start\-\_\-time}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-start\-\_\-time} (
\begin{DoxyParamCaption}
\item[{real(c\-\_\-double)}]{time}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a4a1225317eb6e6f3f691508b7cb3b229}


\-Definition at line 170 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a229893345b279120ff5a2e0863442343}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-time\-\_\-step@{get\-\_\-time\-\_\-step}}
\index{get\-\_\-time\-\_\-step@{get\-\_\-time\-\_\-step}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-time\-\_\-step}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-time\-\_\-step} (
\begin{DoxyParamCaption}
\item[{real(c\-\_\-double)}]{timestep}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a229893345b279120ff5a2e0863442343}


\-Definition at line 178 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a22721fe43bcddf4e6c4acdcb389bb198}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-var\-\_\-rank@{get\-\_\-var\-\_\-rank}}
\index{get\-\_\-var\-\_\-rank@{get\-\_\-var\-\_\-rank}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-var\-\_\-rank}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-var\-\_\-rank} (
\begin{DoxyParamCaption}
\item[{character(kind=c\-\_\-char), dimension($\ast$), intent(in)}]{c\-\_\-var\-\_\-name, }
\item[{integer(c\-\_\-int), intent(out)}]{rank}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a22721fe43bcddf4e6c4acdcb389bb198}


\-Definition at line 118 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a89eed08be7c6ad6451651703c55faac4}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!get\-\_\-var\-\_\-type@{get\-\_\-var\-\_\-type}}
\index{get\-\_\-var\-\_\-type@{get\-\_\-var\-\_\-type}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{get\-\_\-var\-\_\-type}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::get\-\_\-var\-\_\-type} (
\begin{DoxyParamCaption}
\item[{character(kind=c\-\_\-char), dimension($\ast$), intent(in)}]{c\-\_\-var\-\_\-name, }
\item[{character(kind=c\-\_\-char), dimension(maxstringlen), intent(out)}]{c\-\_\-type\-\_\-name}
\end{DoxyParamCaption}
)}}\label{classxbeach__bmi_a89eed08be7c6ad6451651703c55faac4}


\-Definition at line 82 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_aab11de777a7108baa7a8c0df96e0d7f6}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!initialize@{initialize}}
\index{initialize@{initialize}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{initialize}]{\setlength{\rightskip}{0pt plus 5cm}integer(c\-\_\-int) function {\bf xbeach\-\_\-bmi\-::initialize} (
\begin{DoxyParamCaption}
\item[{character(kind=c\-\_\-char), dimension($\ast$), intent(in)}]{c\-\_\-configfile}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_aab11de777a7108baa7a8c0df96e0d7f6}


\-Definition at line 43 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a94927455df84f8fc07bcb3253d64708c}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!set\-\_\-current\-\_\-time@{set\-\_\-current\-\_\-time}}
\index{set\-\_\-current\-\_\-time@{set\-\_\-current\-\_\-time}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{set\-\_\-current\-\_\-time}]{\setlength{\rightskip}{0pt plus 5cm}subroutine {\bf xbeach\-\_\-bmi\-::set\-\_\-current\-\_\-time} (
\begin{DoxyParamCaption}
\item[{type(c\-\_\-ptr)}]{xptr}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a94927455df84f8fc07bcb3253d64708c}


\-Definition at line 141 of file xbeach\-\_\-bmi.\-f90.

\hypertarget{classxbeach__bmi_a583c70350dfb1bd6662314e590956449}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!update@{update}}
\index{update@{update}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{update}]{\setlength{\rightskip}{0pt plus 5cm}integer(c\-\_\-int) function {\bf xbeach\-\_\-bmi\-::update} (
\begin{DoxyParamCaption}
\item[{real(c\-\_\-double)}]{dt}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_a583c70350dfb1bd6662314e590956449}


\-Performs a single timestep with the current model. 



\-Definition at line 61 of file xbeach\-\_\-bmi.\-f90.



\subsection{\-Member \-Data \-Documentation}
\hypertarget{classxbeach__bmi_aa463c37ff989fac4356db0d202d62845}{\index{xbeach\-\_\-bmi@{xbeach\-\_\-bmi}!\-M\-A\-X\-D\-I\-M\-S@{\-M\-A\-X\-D\-I\-M\-S}}
\index{\-M\-A\-X\-D\-I\-M\-S@{\-M\-A\-X\-D\-I\-M\-S}!xbeach_bmi@{xbeach\-\_\-bmi}}
\subsubsection[{\-M\-A\-X\-D\-I\-M\-S}]{\setlength{\rightskip}{0pt plus 5cm}integer(c\-\_\-int), parameter {\bf xbeach\-\_\-bmi\-::\-M\-A\-X\-D\-I\-M\-S} = 6\hspace{0.3cm}{\ttfamily  \mbox{[}private\mbox{]}}}}\label{classxbeach__bmi_aa463c37ff989fac4356db0d202d62845}


\-Definition at line 28 of file xbeach\-\_\-bmi.\-f90.



\-The documentation for this module was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
\-C\-:/repositories/\-X\-Beach/trunk/src/xbeachlibrary/\hyperlink{xbeach__bmi_8f90}{xbeach\-\_\-bmi.\-f90}\end{DoxyCompactItemize}
