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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#include <iostream>
#include <cstdlib>

#ifdef _MSC_VER
#include <Windows.h>
#include <stdio.h>
#include <io.h>
#define isatty _isatty
#define fileno _fileno
#else
#include <cstdio>
#include <sys/ioctl.h>
#include <unistd.h>
#endif

#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() {

#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:

        int width = 0;
#ifdef _MSC_VER
        CONSOLE_SCREEN_BUFFER_INFO csbi;
        HANDLE hConsole = GetStdHandle( STD_OUTPUT_HANDLE );
        int ret = GetConsoleScreenBufferInfo(hConsole, &csbi);
        if(ret) {
          width = csbi.dwSize.X - 1;
        } 
#else
        struct winsize w;
        ioctl(fileno(stdout), TIOCGWINSZ, &w);
        width = w.ws_col;
#endif

        // 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);

#ifdef _MSC_VER
          csbi.dwCursorPosition.X = 0;
          SetConsoleCursorPosition(hConsole, csbi.dwCursorPosition);
#else          
          cout << '\r';
#endif
          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:	1879
Committed:	Sun Jun 16 15:15:42 2013 UTC (11 years, 10 months ago) by gezelter
File size:	5483 byte(s)
Log Message:	MERGE OpenMD development 1783:1878 into trunk
#	Content
1	/*
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, 234107 (2008).
39	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	#include <iostream>
44	#include <cstdlib>
45
46	#ifdef _MSC_VER
47	#include <Windows.h>
48	#include <stdio.h>
49	#include <io.h>
50	#define isatty _isatty
51	#define fileno _fileno
52	#else
53	#include <cstdio>
54	#include <sys/ioctl.h>
55	#include <unistd.h>
56	#endif
57
58	#ifdef IS_MPI
59	#include <mpi.h>
60	#endif
61
62	#include "utils/ProgressBar.hpp"
63
64	using namespace std;
65
66	namespace OpenMD {
67
68	const char * progressSpinner_ = "\|/-\\";
69
70	ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
71	}
72
73	void ProgressBar::clear() {
74	#ifdef IS_MPI
75	if (MPI::COMM_WORLD.Get_rank() == 0) {
76	#endif
77	cout << endl;
78	cout.flush();
79	#ifdef IS_MPI
80	}
81	#endif
82	iteration_ = 0;
83	value_ = 0;
84	maximum_ = -1;
85	start_ = time(NULL);
86	}
87
88	void ProgressBar::update() {
89
90	#ifdef IS_MPI
91	if (MPI::COMM_WORLD.Get_rank() == 0) {
92	#endif
93
94	// only do the progress bar if we are actually running in a tty:
95	if (isatty(fileno(stdout)) && (getenv("SGE_TASK_ID")==NULL)) {
96	// get the window width:
97
98	int width = 0;
99	#ifdef _MSC_VER
100	CONSOLE_SCREEN_BUFFER_INFO csbi;
101	HANDLE hConsole = GetStdHandle( STD_OUTPUT_HANDLE );
102	int ret = GetConsoleScreenBufferInfo(hConsole, &csbi);
103	if(ret) {
104	width = csbi.dwSize.X - 1;
105	}
106	#else
107	struct winsize w;
108	ioctl(fileno(stdout), TIOCGWINSZ, &w);
109	width = w.ws_col;
110	#endif
111
112	// handle the case when the width is returned as a nonsensical value.
113	if (width <= 0) width = 80;
114
115	// We'll use:
116	// 31 characters for the completion estimate,
117	// 6 for the % complete,
118	// 2 characters for the open and closing brackets.
119
120	int avail = width - 31 - 6 - 2;
121
122	++iteration_;
123
124	if (maximum_ > 0.0) {
125
126	// we know the maximum, so draw a progress bar
127
128	RealType percent = value_ * 100.0 / maximum_;
129	int hashes = int(percent * avail / 100.0);
130
131	// compute the best estimate of the ending time:
132	time_t current_ = time(NULL);
133	time_t end_ = start_ + (current_ - start_) * (100.0/percent);
134	struct tm * ender = localtime(&end_);
135	char buffer[22];
136	strftime(buffer, 22, "%a %b %d @ %I:%M %p", ender);
137
138	#ifdef _MSC_VER
139	csbi.dwCursorPosition.X = 0;
140	SetConsoleCursorPosition(hConsole, csbi.dwCursorPosition);
141	#else
142	cout << '\r';
143	#endif
144	cout.width(3);
145	cout << right << int(percent);
146	cout.width(3);
147	cout << "% [";
148	cout.fill('#');
149	if (hashes+1 < avail) {
150	cout.width(hashes+1);
151	cout << progressSpinner_[iteration_ & 3];
152	} else {
153	cout.width(avail);
154	cout << '#';
155	}
156	cout.fill(' ');
157	if (avail - hashes - 1 > 0) {
158	cout.width(avail - hashes - 1);
159	cout << ' ';
160	}
161	cout.width(11);
162	cout << "] Estimate:";
163	cout.width(22);
164	cout << buffer;
165
166	}
167	cout.flush();
168	}
169	#ifdef IS_MPI
170	}
171	#endif
172	}
173
174	void ProgressBar::setStatus(RealType val, RealType max) {
175	value_ = val;
176	maximum_ = max;
177	}
178	}