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 <iostream>
#include <sys/ioctl.h>
#ifdef IS_MPI
#include <mpi.h>
#endif
#include "utils/ProgressBar.hpp"

using namespace std;

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
      cout << endl;
      cout.flush();
#ifdef IS_MPI
    }
#endif
    iteration_ = 0;
    value_ = 0;
    maximum_ = -1;
    start_ = time(NULL);
  }
  
  void ProgressBar::update() {

    int width;

#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
      
      // only do the progress bar if we are actually running in a tty:
      if (isatty(fileno(stdout))  && (getenv("SGE_TASK_ID")==NULL)) {     
        // get the window width:
        struct winsize w;
        ioctl(fileno(stdout), TIOCGWINSZ, &w);
        width = w.ws_col;

        // handle the case when the width is returned as a nonsensical value.
        if (width <= 0) width = 80;

        // 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);
          
          // 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[22];
          strftime(buffer, 22, "%a %b %d @ %I:%M %p", ender);
          
          cout << '\r';
          cout.width(3); 
          cout << right << int(percent);
          cout.width(3); 
          cout << "% [";
          cout.fill('#');
          if (hashes+1 < avail) {
            cout.width(hashes+1); 
            cout << progressSpinner_[iteration_ & 3];
          } else {
            cout.width(avail);
            cout << '#';            
          }
          cout.fill(' ');
          if (avail - hashes - 1  > 0) {
            cout.width(avail - hashes - 1);
            cout << ' ';
          }
          cout.width(11);
          cout << "] Estimate:";
          cout.width(22);
          cout << buffer;
                   
        }
        cout.flush();
      }
#ifdef IS_MPI
    }
#endif
  }
  
  void ProgressBar::setStatus(RealType val, RealType max) {
    value_ = val;
    maximum_ = max;
  }  
}
Revision:	1432
Committed:	Thu Apr 8 19:49:38 2010 UTC (15 years ago) by chuckv
File size:	4829 byte(s)
Log Message:	Added check for SGE to progress bar. If we are running under SGE, we should write to file SGE .o file. Under afs it is doubtful that the file will be flushed anyway making the information pointless.
#	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	gezelter	1431	#include <iostream>
43	gezelter	1413	#include <sys/ioctl.h>
44			#ifdef IS_MPI
45			#include <mpi.h>
46	gezelter	1431	#endif
47	gezelter	1413	#include "utils/ProgressBar.hpp"
48
49	gezelter	1431	using namespace std;
50
51	gezelter	1413	namespace OpenMD {
52
53			const char * progressSpinner_ = "\|/-\\";
54
55			ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
56			}
57
58			void ProgressBar::clear() {
59			#ifdef IS_MPI
60			if (MPI::COMM_WORLD.Get_rank() == 0) {
61			#endif
62	gezelter	1431	cout << endl;
63			cout.flush();
64	gezelter	1413	#ifdef IS_MPI
65			}
66			#endif
67			iteration_ = 0;
68			value_ = 0;
69			maximum_ = -1;
70			start_ = time(NULL);
71			}
72
73			void ProgressBar::update() {
74	gezelter	1431
75			int width;
76
77	gezelter	1413	#ifdef IS_MPI
78			if (MPI::COMM_WORLD.Get_rank() == 0) {
79			#endif
80	gezelter	1431
81	gezelter	1421	// only do the progress bar if we are actually running in a tty:
82	chuckv	1432	if (isatty(fileno(stdout)) && (getenv("SGE_TASK_ID")==NULL)) {
83	gezelter	1421	// get the window width:
84			struct winsize w;
85			ioctl(fileno(stdout), TIOCGWINSZ, &w);
86			width = w.ws_col;
87	gezelter	1413
88	gezelter	1431	// handle the case when the width is returned as a nonsensical value.
89			if (width <= 0) width = 80;
90
91	gezelter	1421	// We'll use:
92			// 31 characters for the completion estimate,
93			// 6 for the % complete,
94			// 2 characters for the open and closing brackets.
95
96	gezelter	1431	int avail = width - 31 - 6 - 2;
97
98	gezelter	1421	++iteration_;
99	gezelter	1431
100	gezelter	1421	if (maximum_ > 0.0) {
101	gezelter	1413
102	gezelter	1421	// we know the maximum, so draw a progress bar
103
104			RealType percent = value_ * 100.0 / maximum_;
105			int hashes = int(percent * avail / 100.0);
106
107			// compute the best estimate of the ending time:
108			time_t current_ = time(NULL);
109			time_t end_ = start_ + (current_ - start_) * (100.0/percent);
110			struct tm * ender = localtime(&end_);
111	gezelter	1431	char buffer[22];
112			strftime(buffer, 22, "%a %b %d @ %I:%M %p", ender);
113	gezelter	1421
114	gezelter	1431	cout << '\r';
115			cout.width(3);
116			cout << right << int(percent);
117			cout.width(3);
118			cout << "% [";
119			cout.fill('#');
120			if (hashes+1 < avail) {
121			cout.width(hashes+1);
122			cout << progressSpinner_[iteration_ & 3];
123			} else {
124			cout.width(avail);
125			cout << '#';
126			}
127			cout.fill(' ');
128			if (avail - hashes - 1 > 0) {
129			cout.width(avail - hashes - 1);
130			cout << ' ';
131			}
132			cout.width(11);
133			cout << "] Estimate:";
134			cout.width(22);
135			cout << buffer;
136
137	gezelter	1421	}
138	gezelter	1431	cout.flush();
139	gezelter	1421	}
140	gezelter	1413	#ifdef IS_MPI
141			}
142			#endif
143			}
144
145			void ProgressBar::setStatus(RealType val, RealType max) {
146			value_ = val;
147			maximum_ = max;
148			}
149			}