Tempus_TimeDerivative.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_TimeDerivative_hpp
#define Tempus_TimeDerivative_hpp

// Thrya
#include "Thyra_VectorBase.hpp"
#include "Thyra_VectorStdOps.hpp"

#include "Tempus_config.hpp"

namespace Tempus {

template <typename Scalar>
class TimeDerivative {
 public:
  virtual void compute(
      Teuchos::RCP<const Thyra::VectorBase<Scalar> > x,
      Teuchos::RCP<Thyra::VectorBase<Scalar> > xDot,
      Teuchos::RCP<Thyra::VectorBase<Scalar> > xDotDot = Teuchos::null) = 0;

  // Derived classes may need an initialize, but the argument lists will vary.
  // virtual void initialize(Scalar dt, ... ) = 0;
};

}  // namespace Tempus
#endif  // Tempus_TimeDerivative_hpp