Tempus_TimeEventRange_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_TimeEventRange_decl_hpp
#define Tempus_TimeEventRange_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 TimeEventRange : virtual public TimeEventBase<Scalar>
{
public:

  TimeEventRange();

  TimeEventRange(
    Scalar start, Scalar stop, Scalar stride,
    std::string name = "", bool landOnExactly = true,
    Scalar relTol = std::numeric_limits<Scalar>::epsilon()*Scalar(100.0));

  TimeEventRange(
    Scalar start, Scalar stop, int numEvents,
    std::string name = "", bool landOnExactly = true,
    Scalar relTol = std::numeric_limits<Scalar>::epsilon()*Scalar(100.0));

  virtual ~TimeEventRange() {}



    virtual bool isTime(Scalar time) const;

    virtual Scalar timeToNextEvent(Scalar time) const;

    virtual Scalar timeOfNextEvent(Scalar time) const;

    virtual bool eventInRange(Scalar time1, Scalar time2) const;



    virtual void setTimeRange(Scalar start, Scalar stop, Scalar stride);

    virtual void setTimeRange(Scalar start, Scalar stop, int numEvents);

    virtual Scalar getTimeStart() const { return start_; }
    virtual void setTimeStart(Scalar start);

    virtual Scalar getTimeStop() const { return stop_; }
    virtual void setTimeStop(Scalar stop);

    virtual Scalar getTimeStride() const { return stride_; }

    virtual void setTimeStride(Scalar stride);

    virtual int getNumEvents() const { return numEvents_; }

    virtual void setNumEvents(int numEvents);

    virtual Scalar getRelTol() const { return relTol_; }

    virtual void setRelTol(Scalar relTol);

    virtual Scalar getAbsTol() const { return absTol_; }

    virtual bool getLandOnExactly() const { return landOnExactly_; }

    virtual void setLandOnExactly(bool LOE) { landOnExactly_ = LOE; }


  virtual void describe(Teuchos::FancyOStream          &out,
                        const Teuchos::EVerbosityLevel verbLevel) const;

  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;


protected:

  virtual void setTimeScale();

  Scalar start_;         
  Scalar stop_;          
  Scalar stride_;        
  unsigned numEvents_;   

  Scalar timeScale_;     
  Scalar relTol_;        
  Scalar absTol_;        
  bool   landOnExactly_; 

};


// Nonmember Contructors
// ------------------------------------------------------------------------

template<class Scalar>
Teuchos::RCP<TimeEventRange<Scalar> >
createTimeEventRange(Teuchos::RCP<Teuchos::ParameterList> pList);


} // namespace Tempus

#endif // Tempus_TimeEventRange_decl_hpp