Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Details_extractMpiCommFromTeuchos.hpp
Go to the documentation of this file.
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 
42 #ifndef TPETRA_DETAILS_EXTRACTMPICOMMFROMTEUCHOS_HPP
43 #define TPETRA_DETAILS_EXTRACTMPICOMMFROMTEUCHOS_HPP
44 
50 
51 #include "TpetraCore_config.h"
52 #ifdef HAVE_TPETRACORE_MPI
53 # include <mpi.h> // MPI_Comm
54 #endif // HAVE_TPETRACORE_MPI
55 
56 #ifndef DOXYGEN_SHOULD_SKIP_THIS
57 namespace Teuchos {
58  // forward declaration of Comm
59  template<class OrdinalType> class Comm;
60 } // namespace Teuchos
61 #endif // NOT DOXYGEN_SHOULD_SKIP_THIS
62 
63 namespace Tpetra {
64 namespace Details {
65 
66 #ifdef HAVE_TPETRACORE_MPI
67 MPI_Comm
75 extractMpiCommFromTeuchos (const Teuchos::Comm<int>& comm);
76 #endif // HAVE_TPETRACORE_MPI
77 
79 bool teuchosCommIsAnMpiComm (const Teuchos::Comm<int>& comm);
80 
81 } // namespace Details
82 } // namespace Tpetra
83 
84 #endif // TPETRA_DETAILS_EXTRACTMPICOMMFROMTEUCHOS_HPP
bool teuchosCommIsAnMpiComm(const Teuchos::Comm< int > &)
Is the given Comm a Teuchos::MpiComm&lt;int&gt; instance?