Tempus_TimeEventBase.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_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()
    : name_("TimeEventBase"),
      defaultTime_ (-std::numeric_limits<Scalar>::max()*1.0e-16),
      defaultTol_  ( std::numeric_limits<Scalar>::min()),
      defaultIndex_( std::numeric_limits<int>::min())
  {}

  virtual ~TimeEventBase() {}


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

    virtual Scalar getAbsTol() const
    { return defaultTol_; }

    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() const
    {
      Teuchos::RCP<Teuchos::FancyOStream> out =
        Teuchos::VerboseObjectBase::getDefaultOStream();
      out->setOutputToRootOnly(0);
      *out << "TimeEventBase name = " << getName() << std::endl;
    }


    virtual std::string getName() const { return name_; }
    virtual void setName(std::string name) { name_ = name; }

    virtual Scalar getDefaultTime () const { return defaultTime_; }
    virtual Scalar getDefaultTol  () const { return defaultTol_; }
    virtual int    getDefaultIndex() const { return defaultIndex_; }


private:

  std::string  name_;
  const Scalar defaultTime_;
  const Scalar defaultTol_;
  const int    defaultIndex_;

};


} // namespace Tempus

#endif // Tempus_TimeEventBase_decl_hpp