/usr/include/trilinos/Zoltan2_Environment.hpp is in libtrilinos-zoltan2-dev 12.12.1-5.
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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 | // @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_Environment.hpp
\brief Defines the Environment class.
*/
#ifndef _ZOLTAN2_ENVIRONMENT_HPP_
#define _ZOLTAN2_ENVIRONMENT_HPP_
#include <Zoltan2_config.h>
#include <Zoltan2_Util.hpp>
#include <Zoltan2_IO.hpp>
#include <Zoltan2_Parameters.hpp>
#include <Zoltan2_DebugManager.hpp>
#include <Zoltan2_TimerManager.hpp>
#include <Zoltan2_MetricOutputManager.hpp>
#include <Teuchos_RCP.hpp>
#include <Teuchos_ParameterList.hpp>
#include <Teuchos_Comm.hpp>
#include <Teuchos_DefaultComm.hpp>
#include <Teuchos_CommHelpers.hpp>
#include <Teuchos_StandardParameterEntryValidators.hpp>
namespace Zoltan2 {
/*! \brief The user parameters, debug, timing and memory profiling output objects,
and error checking methods.
This is object is passed to almost every method in the library. It
has the problem parameters and the configuration information that governs
how the library should behave when reporting status information,
testing for errors, and so on.
The environment holds the application's default communicator. Note that
this communicator may differ from the problem communicator for any
given problem.
*/
class Environment{
public:
typedef long memory_t; /*!< \brief data type for Kilobytes */
typedef Teuchos::RCP<const Teuchos::Comm<int> > Comm_t;
typedef Teuchos::RCP<DebugManager> DebugManager_t;
typedef Teuchos::RCP<MetricOutputManager<memory_t> > MemoryProfilerManager_t;
typedef Teuchos::RCP<TimerManager> Timer_t;
int myRank_; /*!< \brief mpi rank (relative to comm_) */
int numProcs_; /*!< \brief number of processes (relative to comm_) */
Comm_t comm_; /*!< \brief communicator for environment*/
AssertionLevel errorCheckLevel_; /*!< \brief level of error checking to do */
/*! \brief Constructor
*
* \param problemParams the parameters supplied by the user, and
* not yet validated by the Environment
* \param comm the default communicator for the application
*/
Environment(Teuchos::ParameterList &problemParams,
const Teuchos::RCP<const Teuchos::Comm<int> > &comm );
/*! \brief Constructor
*
* This constructor does not take a Parameter list,
* BASIC_STATUS for debug_level, and does not timing or memory profiling.
* It has error_check_level BASIC_ASSERTION. It has no other parameters.
* \param comm the default communicator for the application
*/
Environment(const Teuchos::RCP<const Teuchos::Comm<int> > &comm);
/*! \brief Destructor
*/
~Environment();
/*! \brief resetParameters and validate them - preserve the comm
*/
void resetParameters(Teuchos::ParameterList &problemParams);
/*! \brief Collect the paramaters specific to Environment
*/
static void getValidParameters(ParameterList & pl);
/*! \brief Exists to make setting up validators less cluttered
*/
static RCP<Teuchos::BoolParameterEntryValidator> getBoolValidator();
/*! \brief Exists to make setting up validators less cluttered
*/
static RCP<Teuchos::AnyNumberParameterEntryValidator>
getAnyDoubleValidator();
/*! \brief Exists to make setting up validators less cluttered
*/
static RCP<Teuchos::AnyNumberParameterEntryValidator>
getAnyIntValidator();
/*! \brief Provide the Timer object to the Environment.
*
* Having a Timer implies that the user asked for for timing.
* The Problem creates and holds the Timer.
*/
void setTimer(RCP<TimerManager> &timer) { timerOut_=timer; timingOn_=true;}
#ifdef Z2_OMIT_ALL_ERROR_CHECKING
inline void localInputAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level) const {}
inline void globalInputAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level,
const Comm_t &comm=comm_) const {}
inline void localBugAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level) const {}
inline void globalBugAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level,
const Comm_t &comm=comm_) const {}
inline void localMemoryAssertion(const char *file, int lineNum,
size_t nobj, bool ok) const {}
inline void globalMemoryAssertion(const char *file, int lineNum,
size_t nobj, bool ok, const Comm_t &comm=comm_) const {}
#else
/*! \brief %Test for valid user input on local process only.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param msg an optional descriptive message
* \param ok a boolean which if false indicates an error
* \param level a AssertionLevel value
*
* If the \c level does not exceed the \c error_check_level parameter
* set by the user, then the assertion is tested and a std::runtime error
* is thrown if it is false.
*/
inline void localInputAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level) const {
if (level <= errorCheckLevel_ && !ok){
std::ostringstream emsg;
emsg << myRank_<< ": " << file << "," << lineNum<< std::endl;
if (msg)
emsg << myRank_ << ": error: " << msg << std::endl;
throw std::runtime_error(emsg.str());
}
}
/*! \brief %Test globally for valid user input.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param msg an optional descriptive message
* \param ok a boolean which if false indicates an error
* \param level a AssertionLevel value
* \param comm a RCP<const Comm<int> > for the global check,
* if not specified we use the Environment's communicator.
*
* If the \c level does not exceed the \c error_check_level parameter
* set by the user, then the assertion is tested on all processes in
* the \c comm. If it fails on any process a std::runtime error
* is thrown.
*/
inline void globalInputAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level,
const Comm_t &comm) const {
if (level <= errorCheckLevel_){
int anyFail=0, fail = (!ok ? 1 : 0);
Teuchos::reduceAll<int,int>(*comm, Teuchos::REDUCE_MAX, 1, &fail,
&anyFail);
if (anyFail > 0){
std::ostringstream emsg;
emsg << myRank_<< ": " << file << "," << lineNum<< std::endl;
if (msg && !ok)
emsg << myRank_ << ": error: " << msg << std::endl;
else
emsg << myRank_ << ": exiting" << std::endl;
throw std::runtime_error(emsg.str());
}
}
}
/*! \brief %Test for valid library behavior on local process only.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param msg an optional descriptive message
* \param ok a boolean which if false indicates an error
* \param level a AssertionLevel value
*
* If the \c level does not exceed the \c error_check_level parameter
* set by the user, then the assertion is tested and a std::logic_error
* error is thrown if it is false.
*
* A failure of this test indicates a bug in Zoltan2. Because of this
* consider doing these tests at the level of COMPLEX_ASSERTION,
* so they they only get checked when we specifically ask for this higher
* level of checking. An exception would be a test that is unlikely
* to be executed (the default in a switch for example).
*/
inline void localBugAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level) const {
if (level <= errorCheckLevel_ && !ok){
std::ostringstream emsg;
emsg << myRank_<< ": " << file << "," << lineNum<< std::endl;
if (msg)
emsg << myRank_ << ": bug: " << msg << std::endl;
throw std::logic_error(emsg.str());
}
}
/*! \brief %Test for valid library behavior on every process.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param msg an optional descriptive message
* \param ok a boolean which if false indicates an error
* \param level a AssertionLevel value
* \param comm a RCP<const Comm<int> > for the global check,
* if not specified we use the Environment's communicator.
*
* If the \c level does not exceed the \c error_check_level parameter
* set by the user, then the assertion is tested and a std::logic_error
* error is thrown if it is false on any process.
*
* A failure of this test indicates a bug in Zoltan2. Because of this
* consider doing these tests at the level of COMPLEX_ASSERTION,
* so they they only get checked when we specifically ask for this higher
* level of checking. An exception would be a test that is unlikely
* to be executed (the default in a switch for example).
*/
inline void globalBugAssertion(const char *file, int lineNum,
const char *msg, bool ok, AssertionLevel level,
const Comm_t &comm) const {
if (level <= errorCheckLevel_){
int anyFail=0, fail = (!ok ? 1 : 0);
Teuchos::reduceAll<int,int>(*comm, Teuchos::REDUCE_MAX, 1, &fail,
&anyFail);
if (anyFail > 0){
std::ostringstream emsg;
emsg << myRank_<< ": " << file << "," << lineNum<< std::endl;
if (msg && !ok)
emsg << myRank_ << ": bug: " << msg << std::endl;
else
emsg << myRank_ << ": exiting" << std::endl;
throw std::logic_error(emsg.str());
}
}
}
/*! \brief %Test for successful memory allocation on local process only.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param nobj a value indicating the amount of memory wanted
* \param ok a boolean which if false indicates failure
*
* If the assertion fails, we throw std::bad_alloc. There is no
* level to this macro because memory assertions are BASIC_ASSERTIONs.
* We always check for successful memory allocation unless compiled
* with -DZ2_OMIT_ALL_ERROR_CHECKING.
*/
inline void localMemoryAssertion(const char *file, int lineNum, size_t nobj,
bool ok) const {
if (!ok){
std::cerr << myRank_ << ": " << file << ", " << lineNum<< std::endl;
std::cerr << myRank_ << ": " << nobj << " objects" << std::endl;
throw std::bad_alloc();
}
}
/*! \brief %Test for successful memory allocation on every process.
*
* \param file the __FILE__ value of the caller.
* \param lineNum the __LINE__ value of the caller.
* \param nobj a value indicating the amount of memory wanted
* \param ok a boolean which if false indicates failure
* \param comm a RCP<const Comm<int> > for the global check,
* if not specified we use the Environment's communicator.
*
* If the assertion fails anywhere, we throw std::bad_alloc. There is no
* level to this macro because memory assertions are BASIC_ASSERTIONs.
* We always check for successful memory allocation unless compiled
* with -DZ2_OMIT_ALL_ERROR_CHECKING.
*/
inline void globalMemoryAssertion(const char *file, int lineNum,
size_t nobj, bool ok, const Comm_t &comm) const {
int anyFail=0, fail = (!ok ? 1 : 0);
Teuchos::reduceAll<int,int>(*comm, Teuchos::REDUCE_MAX, 1, &fail, &anyFail);
if (anyFail > 0){
std::cerr << myRank_ << ": " << file << ", " << lineNum<< std::endl;
if (!ok)
std::cerr << myRank_ << ": " << nobj << " objects" << std::endl;
else
std::cerr << myRank_ << ": exiting" << std::endl;
throw std::bad_alloc();
}
}
#endif
// For debugging and profiling output, we define "char *" versions
// as well as "string" versions to avoid runtime conversion of "char *"
// to "string".
/*! \brief Send a message to the debug output manager.
*
* \param level If \c level does not exceed the \c debug_level
* parameter set by the user, then if this process is one that
* prints debug messages (as indicated by the parameter
* \c debug_profiling_procs) then the \c msg
* will be output to either \c debug_output_stream
* or \c debug_output_file.
* \param msg The message to be output.
*/
#ifdef Z2_OMIT_ALL_STATUS_MESSAGES
inline void debug(MessageOutputLevel level, const char *msg) const{ return;}
inline void debug(MessageOutputLevel level, const std::string& msg) const{
return;
}
inline void debug(int level, const char *msg) const{ return;}
inline void debug(int level, const std::string& msg) const{ return;}
#else
inline void debug(MessageOutputLevel level, const char *msg) const{
debugOut_->print(level, msg);
}
inline void debug(MessageOutputLevel level, const std::string& msg) const{
debugOut_->print(level, msg);
}
inline void debug(int level, const char *msg) const{
MessageOutputLevel msg_enum = static_cast<MessageOutputLevel>(level);
debugOut_->print(msg_enum, msg);
}
inline void debug(int level, const std::string& msg) const{
MessageOutputLevel msg_enum = static_cast<MessageOutputLevel>(level);
debugOut_->print(msg_enum, msg);
}
#endif
#ifdef Z2_OMIT_ALL_PROFILING
inline void timerStart(TimerType tt, const char * timerName) const {return;}
inline void timerStart(TimerType tt, const std::string &timerName) const {return;}
inline void timerStart(TimerType tt, const char * timerName, int,
int fieldWidth=0) const {return;}
inline void timerStart(TimerType tt, const std::string &timerName, int,
int fieldWidth=0) const {return;}
inline void timerStop(TimerType tt, const char * timerName) const {return;}
inline void timerStop(TimerType tt, const std::string &timerName) const {return;}
inline void timerStop(TimerType tt, const char * timerName, int,
int fieldWidth=0) const {return;}
inline void timerStop(TimerType tt, const std::string &timerName, int,
int fieldWidth=0) const {return;}
#else
/*! \brief Start a named timer.
*/
inline void timerStart(TimerType tt, const char *timerName) const {
if (timingOn_) timerOut_->start(tt, timerName); }
inline void timerStart(TimerType tt, const std::string &timerName) const {
if (timingOn_) timerOut_->start(tt, timerName); }
/*! \brief Start a named timer, with a number as part of the name.
*/
inline void timerStart(TimerType tt, const char *timerName, int num,
int fieldWidth=0) const {
if (timingOn_){
std::ostringstream oss;
oss << timerName << " ";
if (fieldWidth > 0){
oss.width(fieldWidth);
oss.fill('0');
}
oss << num;
timerOut_->start(tt, oss.str());
}
}
inline void timerStart(TimerType tt, const std::string &timerName, int num,
int fieldWidth=0) const {
if (timingOn_){
std::ostringstream oss;
oss << timerName << " ";
if (fieldWidth > 0){
oss.width(fieldWidth);
oss.fill('0');
}
oss << num;
timerOut_->start(tt, oss.str());
}
}
/*! \brief Stop a named timer.
*/
inline void timerStop(TimerType tt, const char *timerName) const {
if (timingOn_) timerOut_->stop(tt, timerName); }
inline void timerStop(TimerType tt, const std::string &timerName) const {
if (timingOn_) timerOut_->stop(tt, timerName); }
/*! \brief Stop a named timer, with a number as part of the name.
*/
inline void timerStop(TimerType tt, const char *timerName, int num,
int fieldWidth=0) const {
if (timingOn_){
std::ostringstream oss;
oss << timerName << " ";
if (fieldWidth > 0){
oss.width(fieldWidth);
oss.fill('0');
}
oss << num;
timerOut_->stop(tt, oss.str());
}
}
inline void timerStop(TimerType tt, const std::string &timerName, int num,
int fieldWidth=0) const {
if (timingOn_){
std::ostringstream oss;
oss << timerName << " ";
if (fieldWidth > 0){
oss.width(fieldWidth);
oss.fill('0');
}
oss << num;
timerOut_->stop(tt, oss.str());
}
}
#endif
/*! \brief Print a message and the kilobytes in use by this process.
*
* \param msg The message to be output. If this process
* is one that prints memory profiling messages
* (as indicated by the parameter \c memory_procs),
* the \c msg (along with kilobytes currently allocated to
* this process) will issued. The output target is either the
* \c memory_output_stream or \c memory_output_file.
* If neither was set, it goes to std::cout.
*
* Memory profiling is only supported on Linux nodes that
* have /proc/pid/statm. If this is an unsupported node, the call
* does nothing.
*/
#ifdef Z2_OMIT_ALL_PROFILING
inline void memory(const char *msg) const {return;}
inline void memory(const std::string &msg) const {return; }
#else
inline void memory(const char *msg) const
{if (memoryOn_)
memoryOut_->print(msg, getProcessKilobytes());}
inline void memory(const std::string &msg) const
{if (memoryOn_)
memoryOut_->print(msg, getProcessKilobytes());}
#endif
/*! \brief Returns a reference to the user's parameter list.
*
* This is the parameter list after validation and modification.
*/
const Teuchos::ParameterList &getParameters() const { return params_; }
/*! \brief Returns a reference to a non-const copy of the parameters.
*
* This is the parameter list after validation and modification.
*/
Teuchos::ParameterList &getParametersNonConst() { return params_; }
/*! \brief Return true if timing was requested, even if this
* process is not printing out timing messages.
*/
bool doTiming() const { return timingOn_; }
/*! \brief Return true if debug output was requested, even if
* this process is not printing out debug messages.
*/
#ifdef Z2_OMIT_ALL_STATUS_MESSAGES
inline bool doStatus() const { return false;}
inline MessageOutputLevel getDebugLevel() const {return NO_STATUS;}
inline std::ostream *getDebugOStream() const {return std::cout;}
#else
inline bool doStatus() const {
return (debugOut_->getDebugLevel() > NO_STATUS);
}
inline MessageOutputLevel getDebugLevel() const {
return debugOut_->getDebugLevel();
}
inline std::ostream *getDebugOStream() const {
return debugOut_->getOStream();
}
#endif
/*! \brief Return true if memory usage output was requested, even if
* this process is not printing out memory used messages.
*/
bool doMemoryProfiling() const { return memoryOn_;}
/*! \brief Returns a const reference to the user's original list.
*
* This is the parameter list before it was validated. It is
* not the version supplied to algorithms.
*
* It is made available in case a Problem wants to create a new
* Environment by augmenting the user's original parameters.
* See PartitioningProblem::createPartitioningProblem() for an
* example of doing this.
*/
const Teuchos::ParameterList &getUnvalidatedParameters() const {
return unvalidatedParams_; }
/*! \brief Convert parameters of type
* Teuchos::StringToIntegralParameterEntryValidator<int> to integer.
*
* Teuchos::StringToIntegralParameterEntryValidator<bool> to bool.
*
* \param params on input, a list of parameter, on return, all of the
* StringToIntegral parameters have been converted
* to integer values or bool values.
*
* Given a parameter list, this function converts all of the entries that
* have valiator of type StringToIntegralParameterEntryValidator<int>
* from their string value to their int value.
* Also StringToIntegralParameterEntryValidator<bool> to bool
*
*/
static void convertStringToInt(Teuchos::ParameterList ¶ms);
private:
/*! \brief Set up the Environment for the constructor.
*/
void commitParameters();
/*! \brief The Zoltan2 parameters supplied by the user.
*
* Parameters lists are relatively small, so we keep a copy.
*/
Teuchos::ParameterList unvalidatedParams_;
/*! \brief The validated user parameters.
*
* When the constructor calls commitParameters(), some of the
* input parameters are changed. For example, "true"/"false" types
* of parameters are changed to the integers 1 or 0. So
* this list of parameters provided to Problems and algorithms
* is this validated/converted list.
*/
Teuchos::ParameterList params_;
DebugManager_t debugOut_; /*!< \brief output for status messages */
Timer_t timerOut_; /*!< \brief timer output */
bool timingOn_;
MemoryProfilerManager_t memoryOut_; /*!< \brief memory profiling output */
bool memoryOn_;
RCP<std::ofstream> memoryOutputFile_;
};
/*! \brief A value to indicate a string parameter that was
not set by the user.
*/
#define Z2_UNSET_STRING std::string("notSet")
//////////////////////////////////////////////////////////////////////
// Templated namespace definitions used by the class
/*! \brief Create an output manager for a metric value.
*
* \param rank the MPI rank of the calling process in the application
* \param iPrint true if this process should print metric information
* \param fname name of file to which output is to be appended, or
* or Z2_UNSET_STRING
* \param ost output stream type
* \param mgr on return, a pointer to the created output manager
* \param fptr on return, an RCP to an ofstream if one was created.
*
* The template parameter is the data type of the entity being measured.
*/
template<typename metric_t>
void makeMetricOutputManager(int rank, bool iPrint,
std::string fname, int ost,
Teuchos::RCP<MetricOutputManager<metric_t> > &mgr,
std::string units, int fieldWidth,
RCP<std::ofstream> &fptr)
{
typedef MetricOutputManager<metric_t> manager_t;
OSType os = static_cast<OSType>(ost);
bool haveFname = (fname != Z2_UNSET_STRING);
bool haveStreamName = (os != NUM_OUTPUT_STREAMS);
if (!haveFname && !haveStreamName){
mgr = Teuchos::rcp(new manager_t(rank, iPrint, std::cout, true,
units, fieldWidth));
return;
}
if (haveFname){
std::ofstream *oFile = NULL;
if (iPrint){
oFile = new std::ofstream;
std::string newFname;
addNumberToFileName(rank, fname, newFname);
try{
oFile->open(newFname.c_str(), std::ios::out|std::ios::trunc);
}
catch(std::exception &e){
throw std::runtime_error(e.what());
}
fptr = rcp(oFile);
}
mgr = Teuchos::rcp(new manager_t(rank, iPrint, *oFile, true,
units, fieldWidth));
return;
}
if (os == COUT_STREAM)
mgr = Teuchos::rcp(new manager_t(rank, iPrint, std::cout, true,
units, fieldWidth));
else if (os == CERR_STREAM)
mgr = Teuchos::rcp(new manager_t(rank, iPrint, std::cerr, true,
units, fieldWidth));
else if (os == NULL_STREAM)
mgr = Teuchos::rcp(new manager_t(rank, false, std::cout, true,
units, fieldWidth));
else
throw std::logic_error("invalid metric output stream was not caught");
}
} // namespace Zoltan2
#endif
|