ProgressReporter Class Reference

#include <ProgressReporter.hpp>

Collaboration diagram for ProgressReporter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ProgressReporter (std::string outputDirectory, double startTime, double endTime)
 ~ProgressReporter ()
void Update (double currentTime)
void PrintFinalising ()
void PrintInitialising ()

Private Attributes

double mStartTime
double mEndTime
out_stream mpFile
unsigned mLastPercentage

Detailed Description

This class creates the file 'progress_status.txt' in the specified directory and writes "n% completed" etc in the file when n% of a simulation has been done, for integer n.

You can watch the progress of your simulation by doing one of a) watch tail <outputDirectory>/progress_status.txt b) tail -f <outputDirectory>/progress_status.txt

Definition at line 43 of file ProgressReporter.hpp.


Constructor & Destructor Documentation

ProgressReporter::ProgressReporter ( std::string  outputDirectory,
double  startTime,
double  endTime 
)

Constuctor saves times and opens output file ('progress_status.txt').

Parameters:
outputDirectory where to open the output file
startTime the start time
endTime the end time

Definition at line 35 of file ProgressReporter.cpp.

References PetscTools::AmMaster(), mpFile, and OutputFileHandler::OpenOutputFile().

ProgressReporter::~ProgressReporter (  ) 

Destructor.

Definition at line 52 of file ProgressReporter.cpp.

References PetscTools::AmMaster(), mLastPercentage, and mpFile.


Member Function Documentation

void ProgressReporter::PrintFinalising (  ) 

Print finalising message to file.

Definition at line 78 of file ProgressReporter.cpp.

References PetscTools::AmMaster(), and mpFile.

Referenced by AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve().

void ProgressReporter::PrintInitialising (  ) 

Print initialising message to file.

Definition at line 86 of file ProgressReporter.cpp.

References PetscTools::AmMaster(), and mpFile.

void ProgressReporter::Update ( double  currentTime  ) 

Calculates the percentage completed using the time given and the start and end time and prints to file if another percent has been done.

Parameters:
currentTime the given time

Definition at line 65 of file ProgressReporter.cpp.

References PetscTools::AmMaster(), mEndTime, mLastPercentage, mpFile, and mStartTime.

Referenced by AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve().


Member Data Documentation

End time of the simulation

Definition at line 48 of file ProgressReporter.hpp.

Referenced by Update().

Last percentage that was written

Definition at line 50 of file ProgressReporter.hpp.

Referenced by Update(), and ~ProgressReporter().

out_stream ProgressReporter::mpFile [private]

Progress status file

Definition at line 49 of file ProgressReporter.hpp.

Referenced by PrintFinalising(), PrintInitialising(), ProgressReporter(), Update(), and ~ProgressReporter().

Start time of the simulation

Definition at line 47 of file ProgressReporter.hpp.

Referenced by Update().


The documentation for this class was generated from the following files:

Generated by  doxygen 1.6.2