Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_Details_extractMpiCommFromTeuchos.cpp
1// @HEADER
2// ***********************************************************************
3//
4// Tpetra: Templated Linear Algebra Services Package
5// Copyright (2008) Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ************************************************************************
40// @HEADER
41
43
44#ifdef HAVE_TPETRACORE_MPI
45# include "Teuchos_DefaultMpiComm.hpp"
46# include "Teuchos_DefaultSerialComm.hpp"
47# include <stdexcept>
48#endif // HAVE_TPETRACORE_MPI
49
50namespace Tpetra {
51namespace Details {
52
53#ifdef HAVE_TPETRACORE_MPI
54MPI_Comm
55extractMpiCommFromTeuchos (const Teuchos::Comm<int>& comm)
56{
57 using ::Teuchos::MpiComm;
58 using ::Teuchos::SerialComm;
59
60 const MpiComm<int>* mpiComm = dynamic_cast<const MpiComm<int>* > (&comm);
61 if (mpiComm != NULL) { // It's an MpiComm; extract the MPI_Comm
62 MPI_Comm rawComm = * (mpiComm->getRawMpiComm ());
63 return rawComm;
64 }
65 else {
66 const SerialComm<int>* serialComm =
67 dynamic_cast<const SerialComm<int>* > (&comm);
68 if (serialComm != NULL) {
69 return MPI_COMM_SELF; // single-process comm including this process
70 }
71 else {
72 throw std::invalid_argument ("Tpetra::Details::extractMpiCommFromTeuchos: "
73 "Input Teuchos::Comm is "
74 "neither a Teuchos::MpiComm, "
75 "nor a Teuchos::SerialComm. "
76 "As a result, I don't know "
77 "how to get the MPI_Comm out of it.");
78 }
79 }
80}
81#endif // HAVE_TPETRACORE_MPI
82
83#ifdef HAVE_TPETRACORE_MPI
84bool teuchosCommIsAnMpiComm (const Teuchos::Comm<int>& comm)
85{
86 const Teuchos::MpiComm<int>* mpiComm =
87 dynamic_cast<const Teuchos::MpiComm<int>* > (&comm);
88 return mpiComm != nullptr;
89}
90#else
91bool teuchosCommIsAnMpiComm (const Teuchos::Comm<int>&)
92{
93 return false;
94}
95#endif // HAVE_TPETRACORE_MPI
96
97} // namespace Details
98} // namespace Tpetra
99
Declaration of Tpetra::Details::extractMpiCommFromTeuchos.
Implementation details of Tpetra.
bool teuchosCommIsAnMpiComm(const Teuchos::Comm< int > &)
Is the given Comm a Teuchos::MpiComm<int> instance?
Namespace Tpetra contains the class and methods constituting the Tpetra library.