Tpetra Matrix/Vector Services Version of the Day
Tpetra_MpiPlatform.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) Sandia Corporation
00006 // 
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 TPETRA_MPIPLATFORM_HPP
00043 #define TPETRA_MPIPLATFORM_HPP
00044 
00045 #include <Teuchos_DefaultMpiComm.hpp>
00046 #include <Teuchos_Describable.hpp>
00047 #include <Tpetra_ConfigDefs.hpp>
00048 #include <Kokkos_DefaultNode.hpp>
00049 
00050 namespace Tpetra {
00051 
00077   template <class Node>
00078   class MpiPlatform : public Teuchos::Describable {
00079   public:
00082     typedef Node NodeType;
00083 
00085 
00086 
00099     explicit MpiPlatform(const RCP<Node> &node) :
00100       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00101       node_ (node)
00102     {}
00103 
00129     MpiPlatform (const RCP<Node> &node, 
00130                  const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm)
00131       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00132         node_ (node)
00133     {}
00134 
00136     virtual ~MpiPlatform() {}
00137 
00139 
00141 
00142 
00144     RCP<const Comm<int> > getComm() const {
00145       return comm_; 
00146     }
00147 
00149     RCP<Node> getNode() const {
00150       return node_;
00151     }
00152 
00154 
00155   protected: 
00157     RCP<Teuchos::MpiComm<int> > comm_;
00158 
00160     RCP<Node> node_;
00161 
00162   private:
00164     MpiPlatform (const MpiPlatform<Node> &platform);
00165 
00167     MpiPlatform& operator= (const MpiPlatform<Node> &platform);
00168   };
00169 
00170 
00186   template <>
00187   class MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> : 
00188     public Teuchos::Describable {
00189   public:
00192     typedef Kokkos::DefaultNode::DefaultNodeType NodeType;
00193 
00195 
00196 
00204     MpiPlatform () :
00205       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00206       node_ (Kokkos::DefaultNode::getDefaultNode ())
00207     {}
00208 
00224     explicit MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node) :
00225       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00226       node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
00227     {}
00228 
00257     MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node, 
00258                  const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm) 
00259       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00260         node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
00261     {}
00262 
00264     virtual ~MpiPlatform() {}
00265 
00267 
00269 
00270 
00272     RCP<const Comm<int> > getComm() const {
00273       return comm_; 
00274     }
00275 
00281     RCP<Kokkos::DefaultNode::DefaultNodeType> getNode() const {
00282       return node_;
00283     }
00284 
00286 
00287   private:
00289     MpiPlatform (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);
00290 
00292     MpiPlatform& operator= (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);
00293 
00294   protected: 
00296     RCP<Teuchos::MpiComm<int> > comm_;
00297 
00299     RCP<Kokkos::DefaultNode::DefaultNodeType> node_;
00300   };
00301 
00302 
00303 } // namespace Tpetra
00304 
00305 #endif // TPETRA_MPIPLATFORM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines