src/utils/ProgressBar.cpp

/*
 * Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, 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.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman, Stocker & Gezelter, in progress (2010).                        
 */

#include <string>
#include <sstream>
#include <sys/ioctl.h>
#ifdef IS_MPI
#include <mpi.h>
#endif //is_mpi
#include "utils/ProgressBar.hpp"

namespace OpenMD {

  const char * progressSpinner_ = "|/-\\";

  ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
  }
  
  void ProgressBar::clear() {
#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
      printf("\n");
      fflush(stdout);
#ifdef IS_MPI
    }
#endif
    iteration_ = 0;
    value_ = 0;
    maximum_ = -1;
    start_ = time(NULL);
  }
  
  void ProgressBar::update() {
    int width = 80;
#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
#ifndef IS_MPI
    // get the window width:
    struct ttysize ts; 
    ioctl(0, TIOCGWINSZ, &ts);
    width = ts.ts_cols;
#endif   

    // We'll use:
    // 31 characters for the completion estimate, 
    //  6 for the % complete, 
    //  2 characters for the open and closing brackets.

    int avail = width - 31 - 6 - 2;

    ++iteration_;
    
    if (maximum_ > 0.0) {
      // we know the maximum, so
      // draw a progress bar
      
      RealType percent = value_ * 100.0 / maximum_;
      int hashes = int(percent * avail / 100.0);
      std::string progressbar;
      progressbar.assign(hashes, '#');

      // add the spinner to the end of the progress bar:
      progressbar += progressSpinner_[iteration_ & 3];

      // compute the best estimate of the ending time:
      time_t current_ = time(NULL);
      time_t end_ = start_ + (current_ - start_) * (100.0/percent);
      struct tm * ender = localtime(&end_);
      char buffer[24];
      strftime(buffer, 24, "%a %b %d @ %I:%M %p", ender);

      std::stringstream fmt;
      fmt << "\r%3d%% [%-" << avail << "s] Estimate: %s";
      std::string st = fmt.str();

      printf(st.c_str(), int(percent),
             progressbar.c_str(),
             buffer);

    } else {
      // we don't know the maximum, so we can't draw a progress bar
      int center = (iteration_ % 48) + 1; // 50 spaces, minus 2
      std::string before;
      std::string after;
      before.assign(std::max(center - 2, 0), ' ');
      after.assign(std::min(center + 2, 50), ' ');
      
      printf("\r[%s###%s]            ",
             before.c_str(), after.c_str());
    }
    fflush(stdout);
#ifdef IS_MPI
    }
#endif
  }
  
  void ProgressBar::setStatus(RealType val, RealType max) {
    value_ = val;
    maximum_ = max;
  }  
}
Revision:	1413
Committed:	Mon Mar 22 19:21:22 2010 UTC (15 years, 1 month ago) by gezelter
File size:	4588 byte(s)
Log Message:	Adding a progress bar, and pAngle staticProps
#	User	Rev	Content
1	gezelter	1413	/*
2			* Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31			*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39			* [4] Vardeman, Stocker & Gezelter, in progress (2010).
40			*/
41
42			#include <string>
43			#include <sstream>
44			#include <sys/ioctl.h>
45			#ifdef IS_MPI
46			#include <mpi.h>
47			#endif //is_mpi
48			#include "utils/ProgressBar.hpp"
49
50			namespace OpenMD {
51
52			const char * progressSpinner_ = "\|/-\\";
53
54			ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
55			}
56
57			void ProgressBar::clear() {
58			#ifdef IS_MPI
59			if (MPI::COMM_WORLD.Get_rank() == 0) {
60			#endif
61			printf("\n");
62			fflush(stdout);
63			#ifdef IS_MPI
64			}
65			#endif
66			iteration_ = 0;
67			value_ = 0;
68			maximum_ = -1;
69			start_ = time(NULL);
70			}
71
72			void ProgressBar::update() {
73			int width = 80;
74			#ifdef IS_MPI
75			if (MPI::COMM_WORLD.Get_rank() == 0) {
76			#endif
77			#ifndef IS_MPI
78			// get the window width:
79			struct ttysize ts;
80			ioctl(0, TIOCGWINSZ, &ts);
81			width = ts.ts_cols;
82			#endif
83
84			// We'll use:
85			// 31 characters for the completion estimate,
86			// 6 for the % complete,
87			// 2 characters for the open and closing brackets.
88
89			int avail = width - 31 - 6 - 2;
90
91			++iteration_;
92
93			if (maximum_ > 0.0) {
94			// we know the maximum, so
95			// draw a progress bar
96
97			RealType percent = value_ * 100.0 / maximum_;
98			int hashes = int(percent * avail / 100.0);
99			std::string progressbar;
100			progressbar.assign(hashes, '#');
101
102			// add the spinner to the end of the progress bar:
103			progressbar += progressSpinner_[iteration_ & 3];
104
105			// compute the best estimate of the ending time:
106			time_t current_ = time(NULL);
107			time_t end_ = start_ + (current_ - start_) * (100.0/percent);
108			struct tm * ender = localtime(&end_);
109			char buffer[24];
110			strftime(buffer, 24, "%a %b %d @ %I:%M %p", ender);
111
112			std::stringstream fmt;
113			fmt << "\r%3d%% [%-" << avail << "s] Estimate: %s";
114			std::string st = fmt.str();
115
116			printf(st.c_str(), int(percent),
117			progressbar.c_str(),
118			buffer);
119
120			} else {
121			// we don't know the maximum, so we can't draw a progress bar
122			int center = (iteration_ % 48) + 1; // 50 spaces, minus 2
123			std::string before;
124			std::string after;
125			before.assign(std::max(center - 2, 0), ' ');
126			after.assign(std::min(center + 2, 50), ' ');
127
128			printf("\r[%s###%s] ",
129			before.c_str(), after.c_str());
130			}
131			fflush(stdout);
132			#ifdef IS_MPI
133			}
134			#endif
135			}
136
137			void ProgressBar::setStatus(RealType val, RealType max) {
138			value_ = val;
139			maximum_ = max;
140			}
141			}