Teuchos - Trilinos Tools Package Version of the Day
Teuchos_GlobalMPISession.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_GLOBAL_MPI_SESSION_HPP
00043 #define TEUCHOS_GLOBAL_MPI_SESSION_HPP
00044 
00049 #include "Teuchos_ArrayView.hpp"
00050 
00051 
00052 namespace Teuchos {
00053 
00102 class TEUCHOSCORE_LIB_DLL_EXPORT GlobalMPISession
00103 {
00104 public:
00105 
00107 
00108 
00143   GlobalMPISession( int* argc, char*** argv, std::ostream *out = &std::cout );
00144 
00146   ~GlobalMPISession();
00147 
00149 
00151 
00152 
00160   static bool mpiIsInitialized();
00161 
00167   static bool mpiIsFinalized();
00168 
00179   static int getRank();
00180 
00191   static int getNProc();
00192 
00201   static void barrier();
00202 
00219   static int sum(int localVal);
00220 
00236   static void allGather(int localVal, const ArrayView<int> &allVals);
00237 
00239 
00240 private:
00241 
00242   static bool haveMPIState_;
00243   static bool mpiIsFinalized_;
00244   static int rank_;
00245   static int nProc_;
00246 
00247   static void initialize( std::ostream *out );
00248 
00249   static void justInTimeInitialize();
00250 
00251 };
00252 
00253 } // namespace Teuchos
00254 
00255 #endif // TEUCHOS_GLOBAL_MPI_SESSION_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines