source: CPL/oasis3-mct_5.0/doc/doxygen/latex/interfacemod__oasis__mpi_1_1oasis__mpi__scatterv.tex @ 6328

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

First import of oasis3-mct_5.0 (from oasis git server, branch OASIS3-MCT_5.0)

File size: 3.6 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+scatterv Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv}}
3
4
5Generic interfaces into an M\+PI vector scatter. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv_a3fcba01cf7b4de3c6c05fa8999f5c00d}{oasis\+\_\+mpi\+\_\+scattervr1} (locarr, loc\+Size, glob1\+Darr, glob\+Size, displs, rootid, comm, string)
12\begin{DoxyCompactList}\small\item\em Scatter a vector of global data from a rootid. \end{DoxyCompactList}\end{DoxyCompactItemize}
13
14
15\subsection{Detailed Description}
16Generic interfaces into an M\+PI vector scatter.
17
18Definition at line 83 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
19
20
21
22\subsection{Member Function/\+Subroutine Documentation}
23\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv_a3fcba01cf7b4de3c6c05fa8999f5c00d}\label{interfacemod__oasis__mpi_1_1oasis__mpi__scatterv_a3fcba01cf7b4de3c6c05fa8999f5c00d}} 
24\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv}!oasis\+\_\+mpi\+\_\+scattervr1@{oasis\+\_\+mpi\+\_\+scattervr1}}
25\index{oasis\+\_\+mpi\+\_\+scattervr1@{oasis\+\_\+mpi\+\_\+scattervr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv}}
26\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+scattervr1()}{oasis\_mpi\_scattervr1()}}
27{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+scatterv\+::oasis\+\_\+mpi\+\_\+scattervr1 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(out)}]{locarr,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{loc\+Size,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(in)}]{glob1\+Darr,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(in)}]{glob\+Size,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(in)}]{displs,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{rootid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
28
29
30
31Scatter a vector of global data from a rootid.
32
33This method passes in glob1\+D\+Arr, glob\+Size, and displs computed in the \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit}{oasis\+\_\+mpi\+\_\+gathscatvinit} routine and uses that information to scatter glob1\+Darr on processor rootid in communicator comm to locarr on other processors.
34
35
36\begin{DoxyParams}[1]{Parameters}
37\mbox{\tt out}  & {\em locarr} & Local array\\
38\hline
39\mbox{\tt in}  & {\em glob1darr} & Global 1D array to send from\\
40\hline
41\mbox{\tt in}  & {\em locsize} & Number to receive this PE\\
42\hline
43\mbox{\tt in}  & {\em globsize} & Number to send to each PE\\
44\hline
45\mbox{\tt in}  & {\em displs} & Displacements for send\\
46\hline
47\mbox{\tt in}  & {\em rootid} & M\+PI task to scatter on\\
48\hline
49\mbox{\tt in}  & {\em comm} & mpi communicator\\
50\hline
51\mbox{\tt in}  & {\em string} & to identify caller \\
52\hline
53\end{DoxyParams}
54
55
56Definition at line 1191 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
57
58
59
60The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
61\item 
62/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.