source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/latex/namespacemod__oasis__mem.tex @ 6331

Last change on this file since 6331 was 6331, checked in by aclsce, 15 months ago

Moved oasis-mct_5.0 in oasis3-mct/branches directory.
File size: 5.3 KB
Line 
1\hypertarget{namespacemod__oasis__mem}{}\section{mod\+\_\+oasis\+\_\+mem Module Reference}
2\label{namespacemod__oasis__mem}\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
3
4
5Provides methods for querying memory use. 
6
7
8\subsection*{Functions/\+Subroutines}
9\begin{DoxyCompactItemize}
10\item 
11subroutine, public \hyperlink{namespacemod__oasis__mem_a104b7e7e85cd79e731a6e12a14358bbb}{oasis\+\_\+mem\+\_\+init} (iunit)
12\begin{DoxyCompactList}\small\item\em Initialize memory conversion to MB. \end{DoxyCompactList}\item 
13subroutine, public \hyperlink{namespacemod__oasis__mem_a2e20a40b48c7a7572f72da1b5d109ce3}{oasis\+\_\+mem\+\_\+getusage} (r\+\_\+msize, r\+\_\+mrss)
14\begin{DoxyCompactList}\small\item\em Determine memory use. \end{DoxyCompactList}\item 
15subroutine, public \hyperlink{namespacemod__oasis__mem_ac628b504553edbe9345cd070a8db2634}{oasis\+\_\+mem\+\_\+print} (iunit, string)
16\begin{DoxyCompactList}\small\item\em Print memory use. \end{DoxyCompactList}\end{DoxyCompactItemize}
17\subsection*{Variables}
18\begin{DoxyCompactItemize}
19\item 
20real(ip\+\_\+double\+\_\+p) \hyperlink{namespacemod__oasis__mem_a7c262f1c120ed57d527ee3de91552ee9}{mb\+\_\+blk} = 1.\+0\+\_\+ip\+\_\+double\+\_\+p
21\item 
22logical \hyperlink{namespacemod__oasis__mem_aad83c95e1a17a31825eb9c4e1c663aa1}{initset} = .false.
23\end{DoxyCompactItemize}
24
25
26\subsection{Detailed Description}
27Provides methods for querying memory use.
28
29\subsection{Function/\+Subroutine Documentation}
30\mbox{\Hypertarget{namespacemod__oasis__mem_a2e20a40b48c7a7572f72da1b5d109ce3}\label{namespacemod__oasis__mem_a2e20a40b48c7a7572f72da1b5d109ce3}} 
31\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}!oasis\+\_\+mem\+\_\+getusage@{oasis\+\_\+mem\+\_\+getusage}}
32\index{oasis\+\_\+mem\+\_\+getusage@{oasis\+\_\+mem\+\_\+getusage}!mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
33\subsubsection{\texorpdfstring{oasis\+\_\+mem\+\_\+getusage()}{oasis\_mem\_getusage()}}
34{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+mem\+::oasis\+\_\+mem\+\_\+getusage (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), intent(out)}]{r\+\_\+msize,  }\item[{real(ip\+\_\+double\+\_\+p), intent(out)}]{r\+\_\+mrss }\end{DoxyParamCaption})}
35
36
37
38Determine memory use.
39
40
41\begin{DoxyParams}[1]{Parameters}
42\mbox{\tt out}  & {\em r\+\_\+msize} & memory usage value\\
43\hline
44\mbox{\tt out}  & {\em r\+\_\+mrss} & memory usage value \\
45\hline
46\end{DoxyParams}
47
48
49Definition at line 88 of file mod\+\_\+oasis\+\_\+mem.\+F90.
50
51\mbox{\Hypertarget{namespacemod__oasis__mem_a104b7e7e85cd79e731a6e12a14358bbb}\label{namespacemod__oasis__mem_a104b7e7e85cd79e731a6e12a14358bbb}} 
52\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}!oasis\+\_\+mem\+\_\+init@{oasis\+\_\+mem\+\_\+init}}
53\index{oasis\+\_\+mem\+\_\+init@{oasis\+\_\+mem\+\_\+init}!mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
54\subsubsection{\texorpdfstring{oasis\+\_\+mem\+\_\+init()}{oasis\_mem\_init()}}
55{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+mem\+::oasis\+\_\+mem\+\_\+init (\begin{DoxyParamCaption}\item[{integer, optional}]{iunit }\end{DoxyParamCaption})}
56
57
58
59Initialize memory conversion to MB.
60
61
62\begin{DoxyParams}{Parameters}
63{\em iunit} & output unit number for optional writes \\
64\hline
65\end{DoxyParams}
66
67
68Definition at line 34 of file mod\+\_\+oasis\+\_\+mem.\+F90.
69
70\mbox{\Hypertarget{namespacemod__oasis__mem_ac628b504553edbe9345cd070a8db2634}\label{namespacemod__oasis__mem_ac628b504553edbe9345cd070a8db2634}} 
71\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}!oasis\+\_\+mem\+\_\+print@{oasis\+\_\+mem\+\_\+print}}
72\index{oasis\+\_\+mem\+\_\+print@{oasis\+\_\+mem\+\_\+print}!mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
73\subsubsection{\texorpdfstring{oasis\+\_\+mem\+\_\+print()}{oasis\_mem\_print()}}
74{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+mem\+::oasis\+\_\+mem\+\_\+print (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{iunit,  }\item[{character(len=$\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})}
75
76
77
78Print memory use.
79
80
81\begin{DoxyParams}[1]{Parameters}
82\mbox{\tt in}  & {\em iunit} & unit number to write to\\
83\hline
84\mbox{\tt in}  & {\em string} & optional string \\
85\hline
86\end{DoxyParams}
87
88
89Definition at line 119 of file mod\+\_\+oasis\+\_\+mem.\+F90.
90
91
92
93\subsection{Variable Documentation}
94\mbox{\Hypertarget{namespacemod__oasis__mem_aad83c95e1a17a31825eb9c4e1c663aa1}\label{namespacemod__oasis__mem_aad83c95e1a17a31825eb9c4e1c663aa1}} 
95\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}!initset@{initset}}
96\index{initset@{initset}!mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
97\subsubsection{\texorpdfstring{initset}{initset}}
98{\footnotesize\ttfamily logical mod\+\_\+oasis\+\_\+mem\+::initset = .false.\hspace{0.3cm}{\ttfamily [private]}}
99
100
101
102Definition at line 25 of file mod\+\_\+oasis\+\_\+mem.\+F90.
103
104\mbox{\Hypertarget{namespacemod__oasis__mem_a7c262f1c120ed57d527ee3de91552ee9}\label{namespacemod__oasis__mem_a7c262f1c120ed57d527ee3de91552ee9}} 
105\index{mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}!mb\+\_\+blk@{mb\+\_\+blk}}
106\index{mb\+\_\+blk@{mb\+\_\+blk}!mod\+\_\+oasis\+\_\+mem@{mod\+\_\+oasis\+\_\+mem}}
107\subsubsection{\texorpdfstring{mb\+\_\+blk}{mb\_blk}}
108{\footnotesize\ttfamily real(ip\+\_\+double\+\_\+p) mod\+\_\+oasis\+\_\+mem\+::mb\+\_\+blk = 1.\+0\+\_\+ip\+\_\+double\+\_\+p\hspace{0.3cm}{\ttfamily [private]}}
109
110
111
112Definition at line 24 of file mod\+\_\+oasis\+\_\+mem.\+F90.
113
Note: See TracBrowser for help on using the repository browser.