Tempus_Integrator.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_Integrator_hpp
#define Tempus_Integrator_hpp

#include "Tempus_config.hpp"
#include "Tempus_Types.hpp"
#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_Describable.hpp"

#include <string>

namespace Teuchos {
class Time;
}

namespace Tempus {
template <typename Scalar>
class Stepper;
template <typename Scalar>
class SolutionHistory;
template <typename Scalar>
class TimeStepControl;
}  // namespace Tempus

namespace Tempus {

template <class Scalar>
class Integrator
  : virtual public Teuchos::Describable,
    virtual public Teuchos::VerboseObject<Tempus::Integrator<Scalar> > {
 public:

  virtual bool advanceTime(const Scalar time_final) = 0;
  virtual Scalar getTime() const = 0;
  virtual int getIndex() const = 0;
  virtual Tempus::Status getStatus() const = 0;
  virtual void setStatus(const Tempus::Status st) = 0;
  virtual Teuchos::RCP<Stepper<Scalar> > getStepper() const = 0;
  virtual Teuchos::RCP<const SolutionHistory<Scalar> > getSolutionHistory()
      const = 0;
  virtual Teuchos::RCP<SolutionHistory<Scalar> >
  getNonConstSolutionHistory() = 0;
  virtual Teuchos::RCP<const TimeStepControl<Scalar> > getTimeStepControl()
      const = 0;
  virtual Teuchos::RCP<TimeStepControl<Scalar> >
  getNonConstTimeStepControl() = 0;
  virtual Teuchos::RCP<Teuchos::Time> getIntegratorTimer() const = 0;
  virtual Teuchos::RCP<Teuchos::Time> getStepperTimer() const    = 0;
};

}  // namespace Tempus
#endif  // Tempus_Integrator_hpp