← Back to branch summary

~njansson/dolfin/hpc

« back to all changes in this revision

Viewing changes to dolfin/log/Progress.h

  • Committer: Niclas Jansson
  • Date: 2011-06-10 14:33:43 UTC
  • Revision ID: njansson@csc.kth.se-20110610143343-d21p4am8rghiojfm
Added rudimentary header to binary files

Show diffs side-by-side

added added

removed removed

Lines of Context:
dolfin/log/Progress.h
1
 
// Copyright (C) 2003-2008 Anders Logg and Jim Tilander.
2
 
// Licensed under the GNU LGPL Version 2.1.
3
 
//
4
 
// First added:  2003-03-14
5
 
// Last changed: 2008-03-06
6
 
 
7
 
#ifndef __PROGRESS_H
8
 
#define __PROGRESS_H
9
 
 
10
 
#include <string>
11
 
#include <stdarg.h>
12
 
 
13
 
#include <dolfin/common/types.h>
14
 
 
15
 
namespace dolfin
16
 
{
17
 
  
18
 
  /// This class provides a simple way to create and update progress
19
 
  /// bars during a computation. A progress bar may be used either
20
 
  /// in an iteration with a known number of steps:
21
 
  ///
22
 
  ///     Progress p("Iterating...", n);
23
 
  ///     for (int i = 0; i < n; i++)
24
 
  ///     {
25
 
  ///       ...
26
 
  ///       p++;
27
 
  ///     }
28
 
  ///
29
 
  /// or in an iteration with an unknown number of steps:
30
 
  ///
31
 
  ///     Progress p("Iterating...");
32
 
  ///     while (t < T)
33
 
  ///     {
34
 
  ///       ...
35
 
  ///       p = t / T;
36
 
  ///     }
37
 
 
38
 
  class Progress
39
 
  {
40
 
  public:
41
 
 
42
 
    /// Create progress bar with a known number of steps
43
 
    Progress(std::string title, unsigned int n);
44
 
 
45
 
    /// Create progress bar with an unknown number of steps
46
 
    Progress(std::string title);
47
 
 
48
 
    /// Destructor
49
 
    ~Progress();
50
 
    
51
 
    /// Set current position
52
 
    void operator=(real p);
53
 
 
54
 
    /// Increment progress
55
 
    void operator++(int);
56
 
    
57
 
  private:
58
 
    
59
 
    // Update progress
60
 
    void update(real p);
61
 
    
62
 
    // Title of progress bar
63
 
    std::string title;
64
 
    
65
 
    // Number of steps
66
 
    uint n;
67
 
 
68
 
    // Current position
69
 
    uint i;
70
 
 
71
 
    // Minimum progress increment
72
 
    real p_step;
73
 
 
74
 
    // Minimum time increment
75
 
    real t_step;
76
 
 
77
 
    // Current progress
78
 
    real p;
79
 
    
80
 
    // Current time
81
 
    real t;
82
 
    
83
 
  };
84
 
  
85
 
}
86
 
 
87
 
#endif