Tempus_TimeEventRangeIndex_decl.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER
 
#ifndef Tempus_TimeEventIndexRange_decl_hpp
#define Tempus_TimeEventIndexRange_decl_hpp
 
#include <tuple>
 
#include "Teuchos_Time.hpp"
#include "Teuchos_ParameterList.hpp"
 
#include "Tempus_config.hpp"
#include "Tempus_TimeEventBase.hpp"
 
namespace Tempus {
 
template <class Scalar>
class TimeEventRangeIndex : virtual public TimeEventBase<Scalar> {
 public:
  TimeEventRangeIndex();
 
  TimeEventRangeIndex(int start, int stop, int stride, std::string name = "");
 
  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(Teuchos::FancyOStream &out,
                        const Teuchos::EVerbosityLevel verbLevel) 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();
 
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
 
 protected:
  int start_;           
  int stop_;            
  int stride_;          
  unsigned numEvents_;  
};
 
// Nonmember Contructors
// ------------------------------------------------------------------------
 
template <class Scalar>
Teuchos::RCP<TimeEventRangeIndex<Scalar> > createTimeEventRangeIndex(
    Teuchos::RCP<Teuchos::ParameterList> pList);
 
}  // namespace Tempus
 
#endif  // Tempus_TimeEventIndexRange_decl_hpp