Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
Teuchos_GlobalMPISession.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_GLOBAL_MPI_SESSION_HPP
43 #define TEUCHOS_GLOBAL_MPI_SESSION_HPP
44 
51 
52 #include "Teuchos_ArrayView.hpp"
53 
54 
55 namespace Teuchos {
56 
66 //
114 {
115 public:
116 
118 
119 
162  GlobalMPISession( int* argc, char*** argv, std::ostream *out = &std::cout );
163 
165  ~GlobalMPISession();
166 
168 
170 
171 
179  static bool mpiIsInitialized();
180 
186  static bool mpiIsFinalized();
187 
198  static int getRank();
199 
210  static int getNProc();
211 
220  static void barrier();
221 
238  static int sum(int localVal);
239 
255  static void allGather(int localVal, const ArrayView<int> &allVals);
256 
257 #ifdef HAVE_TEUCHOSCORE_KOKKOSCORE
258  static std::vector<std::string> getArgv ();
266 #endif // HAVE_TEUCHOSCORE_KOKKOSCORE
267 
268 
269 private:
270 
271  static bool haveMPIState_;
272  static bool mpiIsFinalized_;
273  static int rank_;
274  static int nProc_;
275 #ifdef HAVE_TEUCHOSCORE_KOKKOSCORE
276  static std::vector<std::string> argvCopy_;
284 #endif // HAVE_TEUCHOSCORE_KOKKOSCORE
285 
286  static void initialize( std::ostream *out );
287 
288  static void justInTimeInitialize();
289 
290 };
291 
292 } // namespace Teuchos
293 
294 #endif // TEUCHOS_GLOBAL_MPI_SESSION_HPP
Initialize, finalize, and query the global MPI session.
#define TEUCHOSCORE_LIB_DLL_EXPORT