Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_MpiPlatform.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Xpetra: A linear algebra interface package
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef XPETRA_MPIPLATFORM_HPP
47 #define XPETRA_MPIPLATFORM_HPP
48 
49 #include <Teuchos_DefaultMpiComm.hpp>
50 #include <Teuchos_Describable.hpp>
51 #include <Kokkos_DefaultNode.hpp>
52 
53 #include "Xpetra_ConfigDefs.hpp"
54 
55 namespace Xpetra {
56 
58 
63  template<class Node=KokkosClassic::DefaultNode::DefaultNodeType>
64  class MpiPlatform : public Teuchos::Describable {
65  public:
67  typedef Node NodeType;
69 
70 
72  explicit MpiPlatform(Teuchos::RCP<Node> node);
73 
75  MpiPlatform(Teuchos::RCP<Node> node, const Teuchos::RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm);
76 
78  ~MpiPlatform();
79 
81 
83 
84 
86  Teuchos::RCP< const Teuchos::Comm<int> > getComm() const;
87 
88 
90 
91  private:
92  Teuchos::RCP<Teuchos::MpiComm<int> > comm_;
93  MpiPlatform(const MpiPlatform<Node> &platform);
94  };
95 
96  template <class Node>
97  MpiPlatform<Node>::MpiPlatform(Teuchos::RCP<Node> /* node */, const Teuchos::RCP<const Teuchos::OpaqueWrapper<MPI_Comm> > &rawMpiComm) :
98  comm_ (Teuchos::createMpiComm<int>(rawMpiComm))
99  {}
100 
101  template <class Node>
102  MpiPlatform<Node>::MpiPlatform(Teuchos::RCP<Node> /* node */) :
103  comm_ (Teuchos::createMpiComm<int>(Teuchos::opaqueWrapper<MPI_Comm>(MPI_COMM_WORLD)))
104  {}
105 
106  template <class Node>
108 
109  template <class Node>
111  comm_ = platform.comm_;
112  }
113 
114  template <class Node>
115  Teuchos::RCP< const Teuchos::Comm<int> >
117  return comm_;
118  }
119 
120 
121 } // namespace Xpetra
122 
123 #endif // XPETRA_MPIPLATFORM_HPP
124 
MpiPlatform(Teuchos::RCP< Node > node)
Constructor.
A implementation of the Platform class for MPI-based platforms.
Node NodeType
Typedef indicating the node type over which the platform is templated. This default to the Kokkos def...
Teuchos::RCP< Teuchos::MpiComm< int > > comm_
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Comm Instance.