Xpetra_MpiPlatform.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef XPETRA_MPIPLATFORM_HPP
#define XPETRA_MPIPLATFORM_HPP

#include <Teuchos_DefaultMpiComm.hpp>
#include <Teuchos_Describable.hpp>
#include <Tpetra_KokkosCompat_DefaultNode.hpp>

#include "Xpetra_ConfigDefs.hpp"

namespace Xpetra {


template <class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class MpiPlatform : public Teuchos::Describable {
 public:
  typedef Node NodeType;


  explicit MpiPlatform(Teuchos::RCP<Node> node);

  MpiPlatform(Teuchos::RCP<Node> node, const Teuchos::RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm);

  ~MpiPlatform();




  Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;


 private:
  Teuchos::RCP<Teuchos::MpiComm<int> > comm_;
  MpiPlatform(const MpiPlatform<Node> &platform);
};

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

template <class Node>
MpiPlatform<Node>::MpiPlatform(Teuchos::RCP<Node> /* node */)
  : comm_(Teuchos::createMpiComm<int>(Teuchos::opaqueWrapper<MPI_Comm>(MPI_COMM_WORLD))) {}  // CHECK: ALLOW MPI_COMM_WORLD

template <class Node>
MpiPlatform<Node>::~MpiPlatform() {}

template <class Node>
MpiPlatform<Node>::MpiPlatform(const MpiPlatform<Node> &platform) {
  comm_ = platform.comm_;
}

template <class Node>
Teuchos::RCP<const Teuchos::Comm<int> >
MpiPlatform<Node>::getComm() const {
  return comm_;
}

}  // namespace Xpetra

#endif  // XPETRA_MPIPLATFORM_HPP