Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_DefaultComm.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_DEFAULT_COMM_HPP
00043 #define TEUCHOS_DEFAULT_COMM_HPP
00044 
00045 #include "Teuchos_RCP.hpp"
00046 #include "Teuchos_DefaultSerialComm.hpp"
00047 #ifdef HAVE_MPI
00048 #  include "Teuchos_DefaultMpiComm.hpp"
00049 #endif
00050 
00051 namespace Teuchos {
00052 
00079 template<typename OrdinalType>
00080 class DefaultComm {
00081 public:
00082 
00091   static Teuchos::RCP<const Comm<OrdinalType> > getComm();
00092 
00097   static Teuchos::RCP<const Comm<OrdinalType> >
00098   getDefaultSerialComm( const Teuchos::RCP<const Comm<OrdinalType> > &comm );
00099 
00100 private:
00101 
00107   static Teuchos::RCP<const Comm<OrdinalType> > comm_;
00108 
00110   static Teuchos::RCP<const Comm<OrdinalType> > defaultSerialComm_;
00111 };
00112 
00113 
00114 template<typename OrdinalType>
00115 Teuchos::RCP<const Teuchos::Comm<OrdinalType> >
00116 DefaultComm<OrdinalType>::getComm()
00117 {
00118   if(!comm_.get()) {
00119 #ifdef HAVE_MPI
00120     comm_ = rcp(new MpiComm<OrdinalType>(opaqueWrapper((MPI_Comm)MPI_COMM_WORLD)));
00121 #else // HAVE_MPI    
00122     comm_ = rcp(new SerialComm<OrdinalType>());
00123 #endif // HAVE_MPI    
00124   }
00125   return comm_;
00126 }
00127 
00128 template<typename OrdinalType>
00129 Teuchos::RCP<const Teuchos::Comm<OrdinalType> >
00130 DefaultComm<OrdinalType>::getDefaultSerialComm(
00131   const Teuchos::RCP<const Comm<OrdinalType> > &comm
00132   )
00133 {
00134   if( comm.get() )
00135     return comm;
00136   else
00137     return defaultSerialComm_;
00138 }
00139 
00140 template<typename OrdinalType>
00141 Teuchos::RCP<const Teuchos::Comm<OrdinalType> >
00142 DefaultComm<OrdinalType>::comm_ = Teuchos::null;
00143 
00144 template<typename OrdinalType>
00145 Teuchos::RCP<const Teuchos::Comm<OrdinalType> >
00146 DefaultComm<OrdinalType>::defaultSerialComm_
00147 = Teuchos::rcp(new Teuchos::SerialComm<OrdinalType>());
00148 
00149 } // namespace Teuchos
00150 
00151 #endif // TEUCHOS_DEFAULT_COMM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines