\hypertarget{interfacemom__restart_1_1register__restart__pair}{}\section{mom\+\_\+restart\+:\+:register\+\_\+restart\+\_\+pair Interface Reference}
\label{interfacemom__restart_1_1register__restart__pair}\index{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}}


\subsection{Detailed Description}
Register a pair of restart fieilds whose rotations map onto each other. 

Definition at line 120 of file M\+O\+M\+\_\+restart.\+F90.

\subsection*{Private functions}
\begin{DoxyCompactItemize}
\item 
subroutine \hyperlink{interfacemom__restart_1_1register__restart__pair_a3f150d43497d4fd0f911758bad406cb7}{register\+\_\+restart\+\_\+pair\+\_\+ptr2d} (a\+\_\+ptr, b\+\_\+ptr, a\+\_\+desc, b\+\_\+desc, mandatory, CS)
\begin{DoxyCompactList}\small\item\em Register a pair of rotationally equivalent 2d restart fields. \end{DoxyCompactList}\item 
subroutine \hyperlink{interfacemom__restart_1_1register__restart__pair_a65102c3d36f8841e6b8ddb0f8e3a4e0e}{register\+\_\+restart\+\_\+pair\+\_\+ptr3d} (a\+\_\+ptr, b\+\_\+ptr, a\+\_\+desc, b\+\_\+desc, mandatory, CS)
\begin{DoxyCompactList}\small\item\em Register a pair of rotationally equivalent 3d restart fields. \end{DoxyCompactList}\item 
subroutine \hyperlink{interfacemom__restart_1_1register__restart__pair_a9282c17db57256d6c4b9bf0f34e60b6b}{register\+\_\+restart\+\_\+pair\+\_\+ptr4d} (a\+\_\+ptr, b\+\_\+ptr, a\+\_\+desc, b\+\_\+desc, mandatory, CS)
\begin{DoxyCompactList}\small\item\em Register a pair of rotationally equivalent 2d restart fields. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Register a pair of restart fieilds whose rotations map onto each other. 

Definition at line 120 of file M\+O\+M\+\_\+restart.\+F90.



\subsection{Functions and subroutines}
\mbox{\Hypertarget{interfacemom__restart_1_1register__restart__pair_a3f150d43497d4fd0f911758bad406cb7}\label{interfacemom__restart_1_1register__restart__pair_a3f150d43497d4fd0f911758bad406cb7}} 
\index{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}!register\+\_\+restart\+\_\+pair\+\_\+ptr2d@{register\+\_\+restart\+\_\+pair\+\_\+ptr2d}}
\index{register\+\_\+restart\+\_\+pair\+\_\+ptr2d@{register\+\_\+restart\+\_\+pair\+\_\+ptr2d}!mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}}
\subsubsection{\texorpdfstring{register\+\_\+restart\+\_\+pair\+\_\+ptr2d()}{register\_restart\_pair\_ptr2d()}}
{\footnotesize\ttfamily subroutine mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair\+::register\+\_\+restart\+\_\+pair\+\_\+ptr2d (\begin{DoxyParamCaption}\item[{real, dimension(\+:,\+:), intent(in), target}]{a\+\_\+ptr,  }\item[{real, dimension(\+:,\+:), intent(in), target}]{b\+\_\+ptr,  }\item[{type(vardesc), intent(in)}]{a\+\_\+desc,  }\item[{type(vardesc), intent(in)}]{b\+\_\+desc,  }\item[{logical, intent(in)}]{mandatory,  }\item[{type(\hyperlink{structmom__restart_1_1mom__restart__cs}{mom\+\_\+restart\+\_\+cs}), pointer}]{CS }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Register a pair of rotationally equivalent 2d restart fields. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em a\+\_\+ptr} & First field pointer\\
\hline
\mbox{\tt in}  & {\em b\+\_\+ptr} & Second field pointer\\
\hline
\mbox{\tt in}  & {\em a\+\_\+desc} & First field descriptor\\
\hline
\mbox{\tt in}  & {\em b\+\_\+desc} & Second field descriptor\\
\hline
\mbox{\tt in}  & {\em mandatory} & If true, abort if field is missing\\
\hline
 & {\em cs} & M\+OM restart control structure \\
\hline
\end{DoxyParams}


Definition at line 305 of file M\+O\+M\+\_\+restart.\+F90.


\begin{DoxyCode}
305   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: a\_ptr\textcolor{comment}{   !< First field pointer}
306   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: b\_ptr\textcolor{comment}{   !< Second field pointer}
307   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: a\_desc\textcolor{comment}{   !< First field descriptor}
308   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: b\_desc\textcolor{comment}{   !< Second field descriptor}
309   \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{intent(in)} :: mandatory\textcolor{comment}{      !< If true, abort if field is missing}
310   \textcolor{keywordtype}{type}(mom\_restart\_cs), \textcolor{keywordtype}{pointer} :: cs\textcolor{comment}{   !< MOM restart control structure}
311 
312   \textcolor{keywordflow}{if} (modulo(cs%turns, 2) /= 0) \textcolor{keywordflow}{then}
313     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, a\_desc, mandatory, cs)
314     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, b\_desc, mandatory, cs)
315   \textcolor{keywordflow}{else}
316     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, a\_desc, mandatory, cs)
317     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, b\_desc, mandatory, cs)
318 \textcolor{keywordflow}{  endif}
\end{DoxyCode}
\mbox{\Hypertarget{interfacemom__restart_1_1register__restart__pair_a65102c3d36f8841e6b8ddb0f8e3a4e0e}\label{interfacemom__restart_1_1register__restart__pair_a65102c3d36f8841e6b8ddb0f8e3a4e0e}} 
\index{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}!register\+\_\+restart\+\_\+pair\+\_\+ptr3d@{register\+\_\+restart\+\_\+pair\+\_\+ptr3d}}
\index{register\+\_\+restart\+\_\+pair\+\_\+ptr3d@{register\+\_\+restart\+\_\+pair\+\_\+ptr3d}!mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}}
\subsubsection{\texorpdfstring{register\+\_\+restart\+\_\+pair\+\_\+ptr3d()}{register\_restart\_pair\_ptr3d()}}
{\footnotesize\ttfamily subroutine mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair\+::register\+\_\+restart\+\_\+pair\+\_\+ptr3d (\begin{DoxyParamCaption}\item[{real, dimension(\+:,\+:,\+:), intent(in), target}]{a\+\_\+ptr,  }\item[{real, dimension(\+:,\+:,\+:), intent(in), target}]{b\+\_\+ptr,  }\item[{type(vardesc), intent(in)}]{a\+\_\+desc,  }\item[{type(vardesc), intent(in)}]{b\+\_\+desc,  }\item[{logical, intent(in)}]{mandatory,  }\item[{type(\hyperlink{structmom__restart_1_1mom__restart__cs}{mom\+\_\+restart\+\_\+cs}), pointer}]{CS }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Register a pair of rotationally equivalent 3d restart fields. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em a\+\_\+ptr} & First field pointer\\
\hline
\mbox{\tt in}  & {\em b\+\_\+ptr} & Second field pointer\\
\hline
\mbox{\tt in}  & {\em a\+\_\+desc} & First field descriptor\\
\hline
\mbox{\tt in}  & {\em b\+\_\+desc} & Second field descriptor\\
\hline
\mbox{\tt in}  & {\em mandatory} & If true, abort if field is missing\\
\hline
 & {\em cs} & M\+OM restart control structure \\
\hline
\end{DoxyParams}


Definition at line 325 of file M\+O\+M\+\_\+restart.\+F90.


\begin{DoxyCode}
325   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: a\_ptr\textcolor{comment}{   !< First field pointer}
326   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: b\_ptr\textcolor{comment}{   !< Second field pointer}
327   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: a\_desc\textcolor{comment}{   !< First field descriptor}
328   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: b\_desc\textcolor{comment}{   !< Second field descriptor}
329   \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{intent(in)} :: mandatory\textcolor{comment}{      !< If true, abort if field is missing}
330   \textcolor{keywordtype}{type}(mom\_restart\_cs), \textcolor{keywordtype}{pointer} :: cs\textcolor{comment}{   !< MOM restart control structure}
331 
332   \textcolor{keywordflow}{if} (modulo(cs%turns, 2) /= 0) \textcolor{keywordflow}{then}
333     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, a\_desc, mandatory, cs)
334     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, b\_desc, mandatory, cs)
335   \textcolor{keywordflow}{else}
336     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, a\_desc, mandatory, cs)
337     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, b\_desc, mandatory, cs)
338 \textcolor{keywordflow}{  endif}
\end{DoxyCode}
\mbox{\Hypertarget{interfacemom__restart_1_1register__restart__pair_a9282c17db57256d6c4b9bf0f34e60b6b}\label{interfacemom__restart_1_1register__restart__pair_a9282c17db57256d6c4b9bf0f34e60b6b}} 
\index{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}!register\+\_\+restart\+\_\+pair\+\_\+ptr4d@{register\+\_\+restart\+\_\+pair\+\_\+ptr4d}}
\index{register\+\_\+restart\+\_\+pair\+\_\+ptr4d@{register\+\_\+restart\+\_\+pair\+\_\+ptr4d}!mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair@{mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair}}
\subsubsection{\texorpdfstring{register\+\_\+restart\+\_\+pair\+\_\+ptr4d()}{register\_restart\_pair\_ptr4d()}}
{\footnotesize\ttfamily subroutine mom\+\_\+restart\+::register\+\_\+restart\+\_\+pair\+::register\+\_\+restart\+\_\+pair\+\_\+ptr4d (\begin{DoxyParamCaption}\item[{real, dimension(\+:,\+:,\+:,\+:), intent(in), target}]{a\+\_\+ptr,  }\item[{real, dimension(\+:,\+:,\+:,\+:), intent(in), target}]{b\+\_\+ptr,  }\item[{type(vardesc), intent(in)}]{a\+\_\+desc,  }\item[{type(vardesc), intent(in)}]{b\+\_\+desc,  }\item[{logical, intent(in)}]{mandatory,  }\item[{type(\hyperlink{structmom__restart_1_1mom__restart__cs}{mom\+\_\+restart\+\_\+cs}), pointer}]{CS }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Register a pair of rotationally equivalent 2d restart fields. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em a\+\_\+ptr} & First field pointer\\
\hline
\mbox{\tt in}  & {\em b\+\_\+ptr} & Second field pointer\\
\hline
\mbox{\tt in}  & {\em a\+\_\+desc} & First field descriptor\\
\hline
\mbox{\tt in}  & {\em b\+\_\+desc} & Second field descriptor\\
\hline
\mbox{\tt in}  & {\em mandatory} & If true, abort if field is missing\\
\hline
 & {\em cs} & M\+OM restart control structure \\
\hline
\end{DoxyParams}


Definition at line 345 of file M\+O\+M\+\_\+restart.\+F90.


\begin{DoxyCode}
345   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: a\_ptr\textcolor{comment}{ !< First field pointer}
346   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:,:)}, \textcolor{keywordtype}{target}, \textcolor{keywordtype}{intent(in)} :: b\_ptr\textcolor{comment}{ !< Second field pointer}
347   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: a\_desc\textcolor{comment}{   !< First field descriptor}
348   \textcolor{keywordtype}{type}(vardesc), \textcolor{keywordtype}{intent(in)} :: b\_desc\textcolor{comment}{   !< Second field descriptor}
349   \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{intent(in)} :: mandatory\textcolor{comment}{      !< If true, abort if field is missing}
350   \textcolor{keywordtype}{type}(mom\_restart\_cs), \textcolor{keywordtype}{pointer} :: cs\textcolor{comment}{   !< MOM restart control structure}
351 
352   \textcolor{keywordflow}{if} (modulo(cs%turns, 2) /= 0) \textcolor{keywordflow}{then}
353     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, a\_desc, mandatory, cs)
354     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, b\_desc, mandatory, cs)
355   \textcolor{keywordflow}{else}
356     \textcolor{keyword}{call }register\_restart\_field(a\_ptr, a\_desc, mandatory, cs)
357     \textcolor{keyword}{call }register\_restart\_field(b\_ptr, b\_desc, mandatory, cs)
358 \textcolor{keywordflow}{  endif}
\end{DoxyCode}


The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/home/cermak/src/\+M\+O\+M6.\+devrob/src/framework/M\+O\+M\+\_\+restart.\+F90\end{DoxyCompactItemize}
