\hypertarget{f_8h}{
\section{D:/Basile/Visual\-Cpp\-Projects/hydro\-MEX3/hydro\-MEX3/f.h File Reference}
\label{f_8h}\index{D:/Basile/VisualCppProjects/hydroMEX3/hydroMEX3/f.h@{D:/Basile/VisualCppProjects/hydroMEX3/hydroMEX3/f.h}}
}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=336pt]{f_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static int \hyperlink{f_8h_1fef977d88f69785269a54b9229e6a33}{f} (realtype t, N\_\-Vector y, N\_\-Vector ydot, void $\ast$f\_\-data)
\item 
void \hyperlink{f_8h_24102a4d62e2b51baee103e790570cc5}{solver\_\-init} (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$f\_\-dat)
\begin{CompactList}\small\item\em Solver initialisation. \item\end{CompactList}\item 
void \hyperlink{f_8h_60226ceb6bc6fc436c4b9cf34340f070}{solve\_\-ODE} (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$f\_\-dat, realtype tout)
\begin{CompactList}\small\item\em ODE solving. \item\end{CompactList}\item 
void \hyperlink{f_8h_f6088f75e5ffd83c522018dbbf1e5c9f}{solver\_\-free} (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$f\_\-dat)
\begin{CompactList}\small\item\em Free solver memory. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
\begin{Desc}
\item[Author:]\href{mailto:basile.graf@epfl.ch}{\tt basile.graf@epfl.ch}\end{Desc}
This file contains stuff related to evaluation of $ f $ in $ \frac{\partial\vec{q}}{\partial t}=f(\vec{q}, \vec{Q}, \vec{p}) $ and stuff related to the ODE solver (initialisation, solving, closing) 

Definition in file \hyperlink{f_8h-source}{f.h}.

\subsection{Function Documentation}
\hypertarget{f_8h_1fef977d88f69785269a54b9229e6a33}{
\index{f.h@{f.h}!f@{f}}
\index{f@{f}!f.h@{f.h}}
\subsubsection[f]{\setlength{\rightskip}{0pt plus 5cm}static int f (realtype {\em t}, N\_\-Vector {\em y}, N\_\-Vector {\em ydot}, void $\ast$ {\em f\_\-data})\hspace{0.3cm}{\tt  \mbox{[}static\mbox{]}}}}
\label{f_8h_1fef977d88f69785269a54b9229e6a33}


\hypertarget{f_8h_60226ceb6bc6fc436c4b9cf34340f070}{
\index{f.h@{f.h}!solve_ODE@{solve\_\-ODE}}
\index{solve_ODE@{solve\_\-ODE}!f.h@{f.h}}
\subsubsection[solve\_\-ODE]{\setlength{\rightskip}{0pt plus 5cm}void solve\_\-ODE (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$ {\em f\_\-dat}, realtype {\em tout})}}
\label{f_8h_60226ceb6bc6fc436c4b9cf34340f070}


ODE solving. 

Solve the ODE from current time up to $ t_{out} $ \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em $\ast$f\_\-dat,:}]pointer to structure of type \hyperlink{struct_o_d_e__data}{ODE\_\-data} \item[{\em tout,:}]output time \end{description}
\end{Desc}


Definition at line 233 of file f.cpp.

References ODE\_\-data::Cumul\-Num\-Of\-Steps, ODE\_\-data::cvode\_\-mem, ODE\_\-data::d, ODE\_\-data::flag, store\_\-state(), datas::t, ODE\_\-data::time\_\-param, and ODE\_\-data::y.

Referenced by mex\-Function().\hypertarget{f_8h_f6088f75e5ffd83c522018dbbf1e5c9f}{
\index{f.h@{f.h}!solver_free@{solver\_\-free}}
\index{solver_free@{solver\_\-free}!f.h@{f.h}}
\subsubsection[solver\_\-free]{\setlength{\rightskip}{0pt plus 5cm}void solver\_\-free (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$ {\em f\_\-dat})}}
\label{f_8h_f6088f75e5ffd83c522018dbbf1e5c9f}


Free solver memory. 

Free solver memory \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em $\ast$f\_\-dat,:}]pointer to structure of type \hyperlink{struct_o_d_e__data}{ODE\_\-data} \end{description}
\end{Desc}


Definition at line 255 of file f.cpp.

References ODE\_\-data::cvode\_\-mem, and ODE\_\-data::y.

Referenced by mex\-Function().\hypertarget{f_8h_24102a4d62e2b51baee103e790570cc5}{
\index{f.h@{f.h}!solver_init@{solver\_\-init}}
\index{solver_init@{solver\_\-init}!f.h@{f.h}}
\subsubsection[solver\_\-init]{\setlength{\rightskip}{0pt plus 5cm}void solver\_\-init (\hyperlink{struct_o_d_e__data}{ODE\_\-data} $\ast$ {\em f\_\-dat})}}
\label{f_8h_24102a4d62e2b51baee103e790570cc5}


Solver initialisation. 

Solver initialisation \par
 Don't forgett to call \hyperlink{f_8cpp_f6088f75e5ffd83c522018dbbf1e5c9f}{solver\_\-free()}! \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em $\ast$f\_\-dat,:}]pointer to structure of type \hyperlink{struct_o_d_e__data}{ODE\_\-data} \end{description}
\end{Desc}


Definition at line 154 of file f.cpp.

References ODE\_\-data::abstol, ODE\_\-data::cvode\_\-mem, Ith, NEQ, ODE\_\-data::state, and ODE\_\-data::y.

Referenced by mex\-Function().