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 <Kokkos_DefaultNode.hpp>
00048 
00049 namespace Tpetra {
00050 
00076   template <class Node>
00077   class MpiPlatform : public Teuchos::Describable {
00078   public:
00081     typedef Node NodeType;
00082 
00084 
00085 
00098     explicit MpiPlatform(const RCP<Node> &node) :
00099       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00100       node_ (node)
00101     {}
00102 
00128     MpiPlatform (const RCP<Node> &node, 
00129      const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm)
00130       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00131   node_ (node)
00132     {}
00133 
00135     virtual ~MpiPlatform() {}
00136 
00138 
00140 
00141 
00143     RCP<const Comm<int> > getComm() const {
00144       return comm_; 
00145     }
00146 
00148     RCP<Node> getNode() const {
00149       return node_;
00150     }
00151 
00153 
00154   protected: 
00156     RCP<Teuchos::MpiComm<int> > comm_;
00157 
00159     RCP<Node> node_;
00160 
00161   private:
00163     MpiPlatform (const MpiPlatform<Node> &platform);
00164 
00166     MpiPlatform& operator= (const MpiPlatform<Node> &platform);
00167   };
00168 
00169 
00185   template <>
00186   class MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> : 
00187     public Teuchos::Describable {
00188   public:
00191     typedef Kokkos::DefaultNode::DefaultNodeType NodeType;
00192 
00194 
00195 
00203     MpiPlatform () :
00204       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00205       node_ (Kokkos::DefaultNode::getDefaultNode ())
00206     {}
00207 
00223     explicit MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node) :
00224       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00225       node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
00226     {}
00227 
00256     MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node, 
00257      const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm) 
00258       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00259   node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
00260     {}
00261 
00263     virtual ~MpiPlatform() {}
00264 
00266 
00268 
00269 
00271     RCP<const Comm<int> > getComm() const {
00272       return comm_; 
00273     }
00274 
00280     RCP<Kokkos::DefaultNode::DefaultNodeType> getNode() const {
00281       return node_;
00282     }
00283 
00285 
00286   private:
00288     MpiPlatform (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);
00289 
00291     MpiPlatform& operator= (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);
00292 
00293   protected: 
00295     RCP<Teuchos::MpiComm<int> > comm_;
00296 
00298     RCP<Kokkos::DefaultNode::DefaultNodeType> node_;
00299   };
00300 
00301 
00302 } // namespace Tpetra
00303 
00304 #endif // TPETRA_MPIPLATFORM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines