Tempus_TimeEventBase.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_TimeEventBase_decl_hpp
#define Tempus_TimeEventBase_decl_hpp

// Teuchos
#include "Teuchos_Time.hpp"
#include "Teuchos_VerboseObject.hpp"

#include "Tempus_config.hpp"

namespace Tempus {

template <class Scalar>
class TimeEventBase {
 public:
  TimeEventBase()
    : timeEventType_("Base"),
      name_("TimeEventBase"),
      defaultTime_(std::numeric_limits<Scalar>::max()),
      defaultTol_(std::numeric_limits<Scalar>::epsilon() * Scalar(100.0)),
      defaultIndex_(std::numeric_limits<int>::max())
  {
  }

  virtual ~TimeEventBase() {}



  virtual bool isTime(Scalar time) const { return false; }

  virtual Scalar timeToNextEvent(Scalar time) const { return defaultTime_; }

  virtual Scalar timeOfNextEvent(Scalar time) const { return defaultTime_; }

  virtual bool eventInRange(Scalar time1, Scalar time2) const { return false; }

  virtual bool isIndex(int index) const { return false; }

  virtual int indexToNextEvent(int index) const { return defaultIndex_; }

  virtual int indexOfNextEvent(int index) const { return defaultIndex_; }

  virtual bool eventInRangeIndex(int index1, int index2) const { return false; }

  virtual void describe(Teuchos::FancyOStream &out,
                        const Teuchos::EVerbosityLevel verbLevel) const
  {
    auto l_out = Teuchos::fancyOStream(out.getOStream());
    Teuchos::OSTab ostab(*l_out, 2, "TimeEventBase");
    l_out->setOutputToRootOnly(0);

    *l_out << "TimeEventBase name = " << getName() << std::endl;
  }

  virtual Scalar getAbsTol() const { return defaultTol_; }

  virtual bool getLandOnExactly() const { return false; }




  virtual std::string getName() const { return name_; }
  virtual void setName(std::string name) { name_ = name; }
  virtual std::string getType() const { return timeEventType_; }
  virtual Scalar getDefaultTime() const { return defaultTime_; }
  virtual Scalar getDefaultTol() const { return defaultTol_; }
  virtual int getDefaultIndex() const { return defaultIndex_; }

  virtual Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const
  {
    Teuchos::RCP<Teuchos::ParameterList> pl =
        Teuchos::parameterList("Time Event Base");

    pl->setName(this->getName());
    pl->set("Name", this->getName());
    pl->set("Type", this->getType());

    return pl;
  }

 protected:
  virtual void setType(std::string s) { timeEventType_ = s; }

 private:
  std::string timeEventType_;  
  std::string name_;           
  const Scalar defaultTime_;   
  const Scalar defaultTol_;    
  const int defaultIndex_;     
};

}  // namespace Tempus

#endif  // Tempus_TimeEventBase_decl_hpp