Amesos_Time.h

Go to the documentation of this file.

#ifndef AMESOS_TIME_H
#define AMESOS_TIME_H

#if defined(Amesos_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Amesos package is deprecated"
#endif
#endif

#include "Epetra_Comm.h"
#include "Epetra_Time.h"
#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_Assert.hpp"

using Teuchos::RCP;
using Teuchos::rcp;
using Teuchos::Array;

struct Amesos_Time_Data {
  std::string timeName_;
  double timeVal_;
  
  Amesos_Time_Data( std::string timeName, double timeVal ) : 
    timeName_(timeName), 
    timeVal_(timeVal)
  {}
  
  virtual ~Amesos_Time_Data() 
  {}
  
};

class Amesos_Time
{
 public:
  
  Amesos_Time() :
    size_(1)
  {}
    
  virtual ~Amesos_Time()
  {}
    
  inline void CreateTimer(const Epetra_Comm& Comm, int size = 1)
  {
    size_ = size;
    time_.resize(size_);

    for (int i = 0 ; i < size_ ; ++i)
      time_[i] = rcp(new Epetra_Time(Comm));
  }

  inline void ResetTimer(const int timerID = 0)
  {
    time_[timerID]->ResetStartTime();
  }

  inline int AddTime(const std::string what, int dataID, const int timerID = 0)
  {
    // A valid data id is assumed to be > 0, if the id < 0, 
    // then a new entry in the array is created.
    if (dataID < 0) {
      data_.push_back( Amesos_Time_Data( what, time_[timerID]->ElapsedTime() ) );
      return data_.size()-1;
    }
    
    // Check to make sure the data id is valid
    TEUCHOS_TEST_FOR_EXCEPTION(
      timerID >=  (int)(data_.size()), std::logic_error,
      "Amesos_Time::AddTime(...): Error, dataID="<<dataID
      <<" is >= data_.size()="<<data_.size() <<" for dataName=\""<<what<<"\"!"
    );
   
    // The id is valid and the current elapsed time from the indicated timer will be added in. 
    data_[dataID].timeVal_ += time_[timerID]->ElapsedTime();
    return dataID;
  }

  inline double GetTime(const std::string what) const
  {
    int dataSize = (int)(data_.size());
    for (int i=0; i<dataSize; ++i) {
      if ( data_[i].timeName_ == what ) {
        return data_[i].timeVal_;
      }
    }
    return 0.0;
  }

  inline double GetTime(const int dataID) const
  {
    // Return zero if the dataID is not valid
    if ( dataID < 0 || dataID >= (int)(data_.size()) ) {
      return 0.0;
    }
    return data_[dataID].timeVal_;
  }
  
  inline void GetTiming( Teuchos::ParameterList& list ) const
  {
    int dataSize = (int)(data_.size());
    for (int i=0; i<dataSize; ++i) {
      list.set( data_[i].timeName_, data_[i].timeVal_ );
    }
  }

private:
 
  int size_;

  Array<RCP<Epetra_Time> > time_;
  
  Array< Amesos_Time_Data > data_;
};

#endif