Zoltan2 Version of the Day
Zoltan2_MetricOutputManager.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //   Zoltan2: A package of combinatorial algorithms for scientific computing
00006 //                  Copyright 2012 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Karen Devine      (kddevin@sandia.gov)
00039 //                    Erik Boman        (egboman@sandia.gov)
00040 //                    Siva Rajamanickam (srajama@sandia.gov)
00041 //
00042 // ***********************************************************************
00043 //
00044 // @HEADER
00045 
00049 #ifndef _ZOLTAN2_METRICOUTPUT_MANAGER_CPP_
00050 #define _ZOLTAN2_METRICOUTPUT_MANAGER_CPP_
00051 
00052 #include <string>
00053 #include <iostream>
00054 #include <fstream>
00055 
00056 namespace Zoltan2
00057 {
00073 template <typename T>
00074   class MetricOutputManager
00075 {
00076     public:
00077 
00090     MetricOutputManager (int rank, bool doPrinting, std::ofstream &Os, 
00091       bool metricsOn, std::string units=std::string(""), int width=10): 
00092         me_(rank), 
00093         os_(static_cast<std::ostream *>(&Os)), osFile_(&Os),
00094         iPrint_(doPrinting), wePrint_(metricsOn), 
00095         units_(units), width_(width){}
00096 
00097 
00107     MetricOutputManager (int rank, bool doPrinting, std::ostream &Os, 
00108       bool metricsOn, std::string units=std::string(""), int width=10): 
00109         me_(rank), os_(&Os), osFile_(NULL), 
00110         iPrint_(doPrinting), wePrint_(metricsOn),
00111         units_(units), width_(width){}
00112 
00115     ~MetricOutputManager() {}
00116 
00119     inline std::ostream *getOStream() const { return os_; }
00120 
00123     inline bool getMetricsOn() const { return wePrint_; }
00124 
00129     inline void print(const std::string &msg, const T val){
00130       if (iPrint_){
00131         if (os_){
00132           os_->width(10); os_->fill('*');
00133           *os_ << me_ << ": " << val << " " << units_ << ", " << msg << std::endl;
00134           os_->width(0); os_->fill(' ');
00135         }
00136         else{
00137           osFile_->width(10); osFile_->fill('*');
00138           *osFile_ << me_ << ": " << val << " " << units_ << ", " << msg << std::endl;
00139           osFile_->width(0); osFile_->fill(' ');
00140         }
00141       }
00142     }
00143 
00150     inline void print(const char *msg, T val){
00151       if (iPrint_){
00152         if (os_){
00153           os_->width(10); os_->fill('*');
00154           *os_ << me_ << ": " << val << " " << units_ << ", " << msg << std::endl;
00155           os_->width(0); os_->fill(' ');
00156         }
00157         else{
00158           osFile_->width(10); osFile_->fill('*');
00159           *osFile_ << me_ << ": " << val << " " << units_ << ", " << msg << std::endl;
00160           osFile_->width(0); osFile_->fill(' ');
00161         }
00162       }
00163     }
00164 
00165 private:
00166 
00167     int me_;
00168     std::ostream *os_;
00169     std::ofstream *osFile_;
00170     bool iPrint_;    // I am printing metrics
00171     bool wePrint_;   // at least one process is printing metrics
00172     std::string units_;
00173     int width_;  
00174 };
00175 
00176 } //namespace Zoltan2
00177 
00178 #endif