Tpetra_MpiPlatform.hpp

// @HEADER
// ***********************************************************************
// 
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ************************************************************************
// @HEADER

#ifndef TPETRA_MPIPLATFORM_HPP
#define TPETRA_MPIPLATFORM_HPP

#include <Teuchos_DefaultMpiComm.hpp>
#include <Teuchos_Describable.hpp>
#include <Tpetra_ConfigDefs.hpp>
#include <Kokkos_DefaultNode.hpp>

namespace Tpetra {

  template <class Node>
  class MpiPlatform : public Teuchos::Describable {
  public:
    typedef Node NodeType;



    explicit MpiPlatform(const RCP<Node> &node) :
      comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
      node_ (node)
    {}

    MpiPlatform (const RCP<Node> &node, 
                 const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm)
      : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
        node_ (node)
    {}

    virtual ~MpiPlatform() {}




    RCP<const Comm<int> > getComm() const {
      return comm_; 
    }

    RCP<Node> getNode() const {
      return node_;
    }


  protected: 
    RCP<Teuchos::MpiComm<int> > comm_;

    RCP<Node> node_;

  private:
    MpiPlatform (const MpiPlatform<Node> &platform);

    MpiPlatform& operator= (const MpiPlatform<Node> &platform);
  };


  template <>
  class MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> : 
    public Teuchos::Describable {
  public:
    typedef Kokkos::DefaultNode::DefaultNodeType NodeType;



    MpiPlatform () :
      comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
      node_ (Kokkos::DefaultNode::getDefaultNode ())
    {}

    explicit MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node) :
      comm_ (Teuchos::createMpiComm<int> (Teuchos::opaqueWrapper<MPI_Comm> (MPI_COMM_WORLD))),
      node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
    {}

    MpiPlatform (const RCP<Kokkos::DefaultNode::DefaultNodeType> &node, 
                 const RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm) 
      : comm_ (Teuchos::createMpiComm<int> (rawMpiComm)),
        node_ (node.is_null() ? Kokkos::DefaultNode::getDefaultNode() : node)
    {}

    virtual ~MpiPlatform() {}




    RCP<const Comm<int> > getComm() const {
      return comm_; 
    }

    RCP<Kokkos::DefaultNode::DefaultNodeType> getNode() const {
      return node_;
    }


  private:
    MpiPlatform (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);

    MpiPlatform& operator= (const MpiPlatform<Kokkos::DefaultNode::DefaultNodeType> &platform);

  protected: 
    RCP<Teuchos::MpiComm<int> > comm_;

    RCP<Kokkos::DefaultNode::DefaultNodeType> node_;
  };


} // namespace Tpetra

#endif // TPETRA_MPIPLATFORM_HPP