/usr/include/trilinos/Zoltan2_DebugManager.hpp is in libtrilinos-zoltan2-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | // @HEADER
//
// ***********************************************************************
//
// Zoltan2: A package of combinatorial algorithms for scientific computing
// Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Karen Devine (kddevin@sandia.gov)
// Erik Boman (egboman@sandia.gov)
// Siva Rajamanickam (srajama@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
/*! \file Zoltan2_DebugManager.hpp
\brief Debug output manager for Zoltan2
\author Siva Rajamanickam
*/
#ifndef ZOLTAN2_DEBUGMANAGER_HPP
#define ZOLTAN2_DEBUGMANAGER_HPP
#include <Zoltan2_Parameters.hpp>
#include <string>
#include <iostream>
#include <fstream>
namespace Zoltan2
{
/*! \brief DebugManager contains the methods that perform output of
debug and status messages.
An Environment has a DebugManager.
Parameters governing debug/status output:
\li \c debug_level
\li \c debug_procs
\li \c debug_output_stream
\li \c debug_output_file
For more information see at their definitions in
createAllParameters() in Zoltan2_Parameters.cpp.
If Zoltan2 is compiled with \b Z2_OMIT_ALL_STATUS_MESSAGES, no status
messages will be displayed and status message code is ifdef'd out.
\todo For nightly testing, add a build for -DZ2_OMIT_ALL_STATUS_MESSAGES.
*/
class DebugManager
{
public:
/*! \brief Constructor for output to an ofstream.
* \param rank the MPI rank of this process.
* \param doPrinting true if this process is one that outputs messages.
* \param debugOs the output stream for debug messages.
* \param debugLevel the highest level of message to print, messages
* that are below this level will be ignored.
*
* Different constructor for file output so we can close the file
* in the destructor.
*/
DebugManager ( int rank, bool doPrinting, std::ofstream &debugOs,
MessageOutputLevel debugLevel) : myPID_(rank), debugLevel_(debugLevel),
myOS_(static_cast<std::ostream *>(&debugOs)), fileOS_(&debugOs),
iPrint_(doPrinting) {}
/*! \brief Constructor for output to an iostream.
* \param rank the MPI rank of this process.
* \param doPrinting true if this process is one that outputs messages.
* \param debugOs the output stream for debug messages.
* \param debugLevel the highest level of message to print, messages
* that are below this level will be ignored.
*/
DebugManager ( int rank, bool doPrinting, std::ostream &debugOs,
MessageOutputLevel debugLevel) : myPID_(rank), debugLevel_(debugLevel),
myOS_(&debugOs), fileOS_(NULL), iPrint_(doPrinting) {}
/*! \brief Destructor
*/
virtual ~DebugManager()
{
myOS_->flush();
if (fileOS_)
fileOS_->close();
}
/*! \brief Return the output stream for debug/status messages.
*/
inline std::ostream *getOStream() const { return myOS_; };
/*! \brief Return the highest level of message that will be printed.
*/
inline MessageOutputLevel getDebugLevel() const { return debugLevel_; };
/*! \brief Print a debug or status message, if this process
* is one of those that is supposed to be doing output.
*
* \param debugLevel The level of this message. If it is higher than
* the debugLevel stated in the constructor, it will be
* ignored.
* \param output The message.
*/
inline void print(MessageOutputLevel debugLevel, const std::string &output){
#ifndef Z2_OMIT_ALL_STATUS_MESSAGES
if (debugLevel <= debugLevel_ && iPrint_)
*myOS_ << myPID_ << ": " << output << std::endl;
#endif
}
/*! \brief Print a debug or status message regardless of
* whether this process is one of those that is supposed to be
* doing output.
*
* \param debugLevel The level of this message. If it is higher than
* the debugLevel stated in the constructor, it will be
* ignored.
* \param output The message.
*/
inline void printInAllTasks(MessageOutputLevel debugLevel, const std::string &output){
#ifndef Z2_OMIT_ALL_STATUS_MESSAGES
if (debugLevel <= debugLevel_)
*myOS_ << myPID_ << ": " << output << std::endl;
#endif
}
/*! \brief The const char * versions of print functions are needed to
* avoid the expensive conversion to string.
*
* \param debugLevel The level of this message. If it is higher than
* the debugLevel stated in the constructor, it will be
* ignored.
* \param output The message.
*/
inline void print(MessageOutputLevel debugLevel, const char *output){
#ifndef Z2_OMIT_ALL_STATUS_MESSAGES
if (debugLevel <= debugLevel_ && iPrint_)
*myOS_ << myPID_ << ": " << output << std::endl;
#endif
}
/*! \brief The const char * versions of print functions are needed to
* avoid the expensive conversion to string.
*
* \param debugLevel The level of this message. If it is higher than
* the debugLevel stated in the constructor, it will be
* ignored.
* \param output The message.
*/
inline void printInAllTasks(MessageOutputLevel debugLevel, const char *output) {
#ifndef Z2_OMIT_ALL_STATUS_MESSAGES
if (debugLevel <= debugLevel_)
*myOS_ << "PID =" << myPID_ << " " << output << std::endl;
#endif
}
private:
int myPID_;
MessageOutputLevel debugLevel_;
std::ostream *myOS_;
std::ofstream *fileOS_;
bool iPrint_;
};
} //namespace Zoltan2
#endif
|