Tempus_TimeEventRangeIndex_decl.hpp

Go to the documentation of this file.

// @HEADER
// ****************************************************************************
//                Tempus: Copyright (2017) Sandia Corporation
//
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
// ****************************************************************************
// @HEADER

#ifndef Tempus_TimeEventIndexRange_decl_hpp
#define Tempus_TimeEventIndexRange_decl_hpp

#include <tuple>

// Teuchos
#include "Teuchos_Time.hpp"

// Tempus
#include "Tempus_config.hpp"
#include "Tempus_TimeEventBase.hpp"


namespace Tempus {


template<class Scalar>
class TimeEventRangeIndex : virtual public TimeEventBase<Scalar>
{
public:

  TimeEventRangeIndex();

  TimeEventRangeIndex(std::string name, int start, int stop, int stride);

  virtual ~TimeEventRangeIndex() {}


    virtual bool isIndex(int index) const;

    virtual int indexToNextEvent(int index) const;

    virtual int indexOfNextEvent(int index) const;

    virtual bool eventInRangeIndex(int index1, int index2) const;

    virtual void describe() const;


    virtual void setIndexRange(int start, int stop, int stride)
    { setIndexStart(start); setIndexStop(stop); setIndexStride(stride); }

    virtual int getIndexStart() const { return start_; }
    virtual void setIndexStart(int start);

    virtual int getIndexStop() const { return stop_; }
    virtual void setIndexStop(int stop);

    virtual int getIndexStride() const { return stride_; }
    virtual void setIndexStride(int stride);

    virtual int getNumEvents() const { return numEvents_; }
    virtual void setNumEvents();


protected:

  int start_;
  int stop_;
  int stride_;
  unsigned numEvents_;

};


} // namespace Tempus

#endif // Tempus_TimeEventIndexRange_decl_hpp