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 
00074   template <class Node>
00075   class MpiPlatform : public Teuchos::Describable {
00076   public:
00078 
00079 
00081     typedef Node NodeType;
00082 
00084 
00085 
00086 
00096     explicit MpiPlatform (const Teuchos::RCP<Node> &node) :
00097       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00098       node_ (node.is_null () ? KokkosClassic::Details::getNode<Node> () : node)
00099     {}
00100 
00119     MpiPlatform (const Teuchos::RCP<Node> &node, 
00120                  const Teuchos::RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm)
00121       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00122   node_ (node.is_null () ? KokkosClassic::Details::getNode<Node> () : node)
00123     {}
00124 
00135     MpiPlatform (const Teuchos::RCP<Node> &node, MPI_Comm rawMpiComm)
00136       : comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (rawMpiComm))),
00137   node_ (node.is_null () ? KokkosClassic::Details::getNode<Node> () : node)
00138     {}
00139 
00141     virtual ~MpiPlatform() {}
00142 
00144 
00145 
00146 
00148     Teuchos::RCP<const Comm<int> > getComm() const {
00149       return comm_; 
00150     }
00151 
00153     Teuchos::RCP<Node> getNode() const {
00154       return node_;
00155     }
00156 
00158   protected: 
00160     Teuchos::RCP<Teuchos::MpiComm<int> > comm_;
00162     Teuchos::RCP<Node> node_;
00163 
00164   private:
00166     MpiPlatform (const MpiPlatform<Node> &platform);
00168     MpiPlatform& operator= (const MpiPlatform<Node> &platform);
00169   };
00170 
00186   template <>
00187   class MpiPlatform<KokkosClassic::DefaultNode::DefaultNodeType> : 
00188     public Teuchos::Describable {
00189   public:
00191 
00192 
00194     typedef KokkosClassic::DefaultNode::DefaultNodeType NodeType;
00195 
00197 
00198 
00199 
00206     MpiPlatform () :
00207       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00208       node_ (KokkosClassic::DefaultNode::getDefaultNode ())
00209     {}
00210 
00225     explicit MpiPlatform (const RCP<KokkosClassic::DefaultNode::DefaultNodeType> &node) :
00226       comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
00227       node_ (node.is_null() ? KokkosClassic::DefaultNode::getDefaultNode() : node)
00228     {}
00229 
00247     MpiPlatform (const RCP<KokkosClassic::DefaultNode::DefaultNodeType> &node, 
00248                  const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm) 
00249       : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
00250         node_ (node.is_null() ? KokkosClassic::DefaultNode::getDefaultNode() : node)
00251     {}
00252 
00262     MpiPlatform (const RCP<KokkosClassic::DefaultNode::DefaultNodeType> &node, 
00263      MPI_Comm rawMpiComm)
00264       : comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (rawMpiComm))),
00265   node_ (node.is_null() ? KokkosClassic::DefaultNode::getDefaultNode() : node)
00266     {}
00267 
00269     virtual ~MpiPlatform() {}
00270 
00272 
00273 
00274 
00276     RCP<const Comm<int> > getComm() const {
00277       return comm_; 
00278     }
00279 
00281     RCP<KokkosClassic::DefaultNode::DefaultNodeType> getNode() const {
00282       return node_;
00283     }
00284 
00286   private:
00288     MpiPlatform (const MpiPlatform<KokkosClassic::DefaultNode::DefaultNodeType> &platform);
00289 
00291     MpiPlatform& operator= (const MpiPlatform<KokkosClassic::DefaultNode::DefaultNodeType> &platform);
00292 
00293   protected: 
00295     RCP<Teuchos::MpiComm<int> > comm_;
00296 
00298     RCP<KokkosClassic::DefaultNode::DefaultNodeType> node_;
00299   };
00300 
00301 } // namespace Tpetra
00302 
00303 #endif // TPETRA_MPIPLATFORM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines