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

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

Moved oasis-mct_5.0 in oasis3-mct/branches directory.

File size: 3.9 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+gathscatvinit Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit}}
3
4
5Generic interface to oasis\+\_\+mpi\+\_\+gath\+Scat\+V\+Init. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit_a15fc3df477e1fa561fcee17ed718bff8}{oasis\+\_\+mpi\+\_\+gathscatvinitr1} (comm, rootid, loc\+Arr, glob1\+D\+Arr, glob\+Size, displs, string)
12\begin{DoxyCompactList}\small\item\em Initialize variables for \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__gatherv}{oasis\+\_\+mpi\+\_\+gatherv} and \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}{oasis\+\_\+mpi\+\_\+scatterv}. \end{DoxyCompactList}\end{DoxyCompactItemize}
13
14
15\subsection{Detailed Description}
16Generic interface to oasis\+\_\+mpi\+\_\+gath\+Scat\+V\+Init.
17
18Definition at line 73 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
19
20
21
22\subsection{Member Function/\+Subroutine Documentation}
23\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit_a15fc3df477e1fa561fcee17ed718bff8}\label{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit_a15fc3df477e1fa561fcee17ed718bff8}} 
24\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit}!oasis\+\_\+mpi\+\_\+gathscatvinitr1@{oasis\+\_\+mpi\+\_\+gathscatvinitr1}}
25\index{oasis\+\_\+mpi\+\_\+gathscatvinitr1@{oasis\+\_\+mpi\+\_\+gathscatvinitr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit}}
26\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+gathscatvinitr1()}{oasis\_mpi\_gathscatvinitr1()}}
27{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+gathscatvinit\+::oasis\+\_\+mpi\+\_\+gathscatvinitr1 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{rootid,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(in)}]{loc\+Arr,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), pointer}]{glob1\+D\+Arr,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), pointer}]{glob\+Size,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), pointer}]{displs,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
28
29
30
31Initialize variables for \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__gatherv}{oasis\+\_\+mpi\+\_\+gatherv} and \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}{oasis\+\_\+mpi\+\_\+scatterv}.
32
33This method initializes glob1\+D\+Arr, glob\+Size, and displs for use in the \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__gatherv}{oasis\+\_\+mpi\+\_\+gatherv} and \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}{oasis\+\_\+mpi\+\_\+scatterv} routines. loc\+Arr is the distributed array to gather from or scatter to.
34
35
36\begin{DoxyParams}[1]{Parameters}
37\mbox{\tt in}  & {\em comm} & mpi communicator\\
38\hline
39\mbox{\tt in}  & {\em rootid} & M\+PI task to gather/scatter on\\
40\hline
41\mbox{\tt in}  & {\em locarr} & Local array of distributed data\\
42\hline
43 & {\em glob1darr} & Global 1D array of gathered data\\
44\hline
45 & {\em globsize} & Size of each distributed piece\\
46\hline
47 & {\em displs} & Displacements for receive\\
48\hline
49\mbox{\tt in}  & {\em string} & to identify caller \\
50\hline
51\end{DoxyParams}
52
53
54Definition at line 1048 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
55
56
57
58The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
59\item 
60/home/globc2/tcraig/oasis3-\/mct.\+trunk/lib/psmile/src/\hyperlink{mod__oasis__mpi_8_f90}{mod\+\_\+oasis\+\_\+mpi.\+F90}\end{DoxyCompactItemize}
Note: See TracBrowser for help on using the repository browser.