Tempus_SensitivityModelEvaluatorBase.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_SensitivityModelEvaluatorBase_hpp
#define Tempus_SensitivityModelEvaluatorBase_hpp

#include "Thyra_ModelEvaluatorDefaultBase.hpp"
#include "Thyra_NonlinearSolverBase.hpp"
#include "Tempus_config.hpp"
#include "Tempus_SolutionHistory.hpp"

namespace Tempus {

template <typename Scalar>
class SensitivityModelEvaluatorBase
  : public virtual Thyra::ModelEvaluatorDefaultBase<Scalar> {
 public:
  SensitivityModelEvaluatorBase() {}

  virtual ~SensitivityModelEvaluatorBase() {}

  virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getForwardModel()
      const
  {
    return Teuchos::null;
  }

  virtual void setForwardSolutionHistory(
      const Teuchos::RCP<const Tempus::SolutionHistory<Scalar> >& /* sh */)
  {
  }

  virtual void setForwardSolutionState(
      const Teuchos::RCP<const Tempus::SolutionState<Scalar> >& /* s */)
  {
  }

  virtual void setSolver(
      const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& /* solver */,
      const bool /* force_W_update */)
  {
  }
};

}  // namespace Tempus

#endif