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 
00060 template<typename Ordinal>
00061 class DefaultComm {
00062 public:
00063 
00069   static Teuchos::RCP<const Comm<Ordinal> > getComm();
00070 
00073   static Teuchos::RCP<const Comm<Ordinal> >
00074   getDefaultSerialComm( const Teuchos::RCP<const Comm<Ordinal> > &comm );
00075 
00076 private:
00077 
00078   static Teuchos::RCP<const Comm<Ordinal> > comm_;
00079   static Teuchos::RCP<const Comm<Ordinal> > defaultSerialComm_;
00080 
00081 };
00082 
00083 // ///////////////////////////
00084 // Template Implementations
00085 
00086 template<typename Ordinal>
00087 Teuchos::RCP<const Teuchos::Comm<Ordinal> >
00088 DefaultComm<Ordinal>::getComm()
00089 {
00090   if(!comm_.get()) {
00091 #ifdef HAVE_MPI
00092     comm_ = rcp(new MpiComm<Ordinal>(opaqueWrapper((MPI_Comm)MPI_COMM_WORLD)));
00093 #else // HAVE_MPI    
00094     comm_ = rcp(new SerialComm<Ordinal>());
00095 #endif // HAVE_MPI    
00096   }
00097   return comm_;
00098 }
00099 
00100 template<typename Ordinal>
00101 Teuchos::RCP<const Teuchos::Comm<Ordinal> >
00102 DefaultComm<Ordinal>::getDefaultSerialComm(
00103   const Teuchos::RCP<const Comm<Ordinal> > &comm
00104   )
00105 {
00106   if( comm.get() )
00107     return comm;
00108   else
00109     return defaultSerialComm_;
00110 }
00111 
00112 template<typename Ordinal>
00113 Teuchos::RCP<const Teuchos::Comm<Ordinal> >
00114 DefaultComm<Ordinal>::comm_ = Teuchos::null;
00115 
00116 template<typename Ordinal>
00117 Teuchos::RCP<const Teuchos::Comm<Ordinal> >
00118 DefaultComm<Ordinal>::defaultSerialComm_
00119 = Teuchos::rcp(new Teuchos::SerialComm<Ordinal>());
00120 
00121 } // namespace Teuchos
00122 
00123 #endif // TEUCHOS_DEFAULT_COMM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines