Tempus_StepperOptimizationInterface.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_Stepper_Optimization_Interface_hpp
#define Tempus_Stepper_Optimization_Interface_hpp

// Teuchos
#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"

// Thyra
#include "Thyra_VectorBase.hpp"
#include "Thyra_LinearOpBase.hpp"
#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Tempus_config.hpp"

namespace Tempus {

template <class Scalar>
class StepperOptimizationInterface {
 public:
  StepperOptimizationInterface() {}

  virtual ~StepperOptimizationInterface() {}

  virtual int stencilLength() const = 0;

  virtual void computeStepResidual(
      Thyra::VectorBase<Scalar>& residual,
      const Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > >& x,
      const Teuchos::Array<Scalar>& t, const Thyra::VectorBase<Scalar>& p,
      const int param_index) const = 0;


  virtual void computeStepJacobian(
      Thyra::LinearOpBase<Scalar>& jacobian,
      const Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > >& x,
      const Teuchos::Array<Scalar>& t, const Thyra::VectorBase<Scalar>& p,
      const int param_index, const int deriv_index) const = 0;

  virtual void computeStepParamDeriv(
      Thyra::LinearOpBase<Scalar>& deriv,
      const Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > >& x,
      const Teuchos::Array<Scalar>& t, const Thyra::VectorBase<Scalar>& p,
      const int param_index) const = 0;


  virtual void computeStepSolver(
      Thyra::LinearOpWithSolveBase<Scalar>& jacobian_solver,
      const Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > >& x,
      const Teuchos::Array<Scalar>& t, const Thyra::VectorBase<Scalar>& p,
      const int param_index) const = 0;
};

}  // namespace Tempus

#endif  // Tempus_Stepper_hpp