Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Details_printOnce.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 #if defined(HAVE_TPETRACORE_MPI)
45 # include "Teuchos_DefaultMpiComm.hpp"
46 #else
47 # include "Teuchos_Comm.hpp"
48 #endif // defined(HAVE_TPETRACORE_MPI)
49 
50 namespace { // (anonymous)
51  bool mpiIsInitialized ()
52  {
53 #if defined(HAVE_TPETRACORE_MPI)
54  int isInitialized = 0;
55  try {
56  (void) MPI_Initialized (&isInitialized);
57  }
58  catch (...) {
59  // Not sure if MPI_Initialized meets strong exception guarantee
60  isInitialized = 0;
61  }
62  return isInitialized != 0;
63 #else
64  return false;
65 #endif // defined(HAVE_TPETRACORE_MPI)
66  }
67 
68  bool mpiIsFinalized ()
69  {
70 #if defined(HAVE_TPETRACORE_MPI)
71  int isFinalized = 0;
72  try {
73  (void) MPI_Finalized (&isFinalized);
74  }
75  catch (...) {
76  // Not sure if MPI_Initialized meets strong exception guarantee
77  isFinalized = 0;
78  }
79  return isFinalized != 0;
80 #else
81  return false;
82 #endif // defined(HAVE_TPETRACORE_MPI)
83  }
84 
85 #if defined(HAVE_TPETRACORE_MPI)
86  bool isMpiComm (const Teuchos::Comm<int>& comm)
87  {
88  using mpi_comm_type = Teuchos::MpiComm<int>;
89  return dynamic_cast<const mpi_comm_type* > (&comm) != nullptr;
90  }
91 #else
92  bool isMpiComm (const Teuchos::Comm<int>& /* comm */ )
93  {
94  return false;
95  }
96 #endif // defined(HAVE_TPETRACORE_MPI)
97 
98  int getRankHarmlessly (const Teuchos::Comm<int>& comm)
99  {
100  if (mpiIsInitialized () && ! mpiIsFinalized () && isMpiComm (comm)) {
101  return comm.getRank ();
102  }
103  else {
104  return 0;
105  }
106  }
107 } // namespace (anonymous)
108 
109 namespace Tpetra {
110  namespace Details {
111  void
112  printOnce (std::ostream& out,
113  const std::string& s,
114  const Teuchos::Comm<int>* comm)
115  {
116  if (comm == nullptr || getRankHarmlessly (*comm) == 0) {
117  out << s;
118  }
119  }
120  } // namespace Details
121 } // namespace Tpetra
bool isInitialized()
Whether Tpetra is in an initialized state.
void printOnce(std::ostream &out, const std::string &s, const Teuchos::Comm< int > *comm)
Print on one process of the given communicator, or at least try to do so (if MPI is not initialized)...
Declaration of Tpetra::Details::printOnce.
bool mpiIsFinalized()
Has MPI_Finalize been called (on this process)?
bool mpiIsInitialized()
Has MPI_Init been called (on this process)?