Tempus_TimeEventListIndex_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_TimeEventListIndex_decl_hpp
#define Tempus_TimeEventListIndex_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 TimeEventListIndex : virtual public TimeEventBase<Scalar> {
 public:
  TimeEventListIndex();

  TimeEventListIndex(std::vector<int> indexList,
                     std::string name = "TimeEventListIndex");

  virtual ~TimeEventListIndex() {}



  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 std::vector<int> getIndexList() const { return indexList_; }

  virtual void setIndexList(std::vector<int> indexList, bool sort = true);

  virtual void addIndex(int index);

  virtual void clearIndexList() { indexList_.clear(); }

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

 protected:
  std::vector<int> indexList_;  // Sorted and unique list of index events.
};

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

template <class Scalar>
Teuchos::RCP<TimeEventListIndex<Scalar> > createTimeEventListIndex(
    Teuchos::RCP<Teuchos::ParameterList> pList);

}  // namespace Tempus

#endif  // Tempus_TimeEventListIndex_decl_hpp