Tempus_TimeEventList_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_TimeEventList_decl_hpp
#define Tempus_TimeEventList_decl_hpp

#include <vector>

#include "Teuchos_Time.hpp"
#include "Teuchos_ParameterList.hpp"

#include "Tempus_config.hpp"
#include "Tempus_TimeEventBase.hpp"

namespace Tempus {

template <class Scalar>
class TimeEventList : virtual public TimeEventBase<Scalar> {
 public:
  TimeEventList();

  TimeEventList(std::vector<Scalar> timeList,
                std::string name = "TimeEventList", bool landOnExactly = true,
                Scalar relTol = std::numeric_limits<Scalar>::epsilon() *
                                Scalar(100.0));

  virtual ~TimeEventList() {}



  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 describe(Teuchos::FancyOStream &out,
                        const Teuchos::EVerbosityLevel verbLevel) const;


  virtual std::vector<Scalar> getTimeList() const { return timeList_; }

  virtual void setTimeList(std::vector<Scalar> timeList, bool sort = true);

  virtual void addTime(Scalar time);

  virtual void clearTimeList() { timeList_.clear(); }

  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; }

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

 protected:
  virtual void setTimeScale();

  std::vector<Scalar> timeList_;  

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

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

template <class Scalar>
Teuchos::RCP<TimeEventList<Scalar> > createTimeEventList(
    Teuchos::RCP<Teuchos::ParameterList> pList);

}  // namespace Tempus

#endif  // Tempus_TimeEventList_decl_hpp