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 
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>
65  public:
67  typedef Node NodeType;
69 
70 
72  explicit MpiPlatform(Teuchos::RCP<Node> node);
73 
76 
78  ~MpiPlatform();
79 
81 
83 
84 
87 
90 
92 
93  protected:
96 
97  private:
99  MpiPlatform(const MpiPlatform<Node> &platform);
100  };
101 
102  template <class Node>
104  : node_(node) {
105  comm_ = Teuchos::createMpiComm<int>(rawMpiComm);
106  }
107 
108  template <class Node>
110  : node_(node) {
111  comm_ = Teuchos::createMpiComm<int>(Teuchos::opaqueWrapper<MPI_Comm>(MPI_COMM_WORLD));
112  }
113 
114  template <class Node>
116 
117  template <class Node>
119  comm_ = platform.comm_;
120  }
121 
122  template <class Node>
125  return comm_;
126  }
127 
128  template <class Node>
130  { return node_; }
131 
132 } // namespace Xpetra
133 
134 #endif // XPETRA_MPIPLATFORM_HPP
135 
MpiPlatform(Teuchos::RCP< Node > node)
Constructor.
A implementation of the Platform class for MPI-based platforms.
Teuchos::RCP< Node > getNode() const
Get Get a node for parallel computation.
Teuchos::RCP< Node > node_
Node object instantiated for the platform.
Xpetra namespace
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.