Tempus_IntegratorPseudoTransientAdjointSensitivity_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_IntegratorPseudoTransientAdjointSensitivity_decl_hpp
#define Tempus_IntegratorPseudoTransientAdjointSensitivity_decl_hpp

#include "Tempus_config.hpp"
#include "Tempus_IntegratorBasic.hpp"
#include "Tempus_AdjointSensitivityModelEvaluator.hpp"

#include "Tempus_StepperStaggeredForwardSensitivity.hpp"  // For SensitivityStepMode

namespace Tempus {

template <class Scalar>
class IntegratorPseudoTransientAdjointSensitivity
  : virtual public Tempus::Integrator<Scalar>,
    virtual public Teuchos::ParameterListAcceptor {
 public:
  IntegratorPseudoTransientAdjointSensitivity(
      Teuchos::RCP<Teuchos::ParameterList> pList,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >&
          adjoint_residual_model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model);

  IntegratorPseudoTransientAdjointSensitivity(
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >&
          adjoint_residual_model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
      std::string stepperType);

  IntegratorPseudoTransientAdjointSensitivity(
      Teuchos::RCP<Teuchos::ParameterList> pList,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model);

  IntegratorPseudoTransientAdjointSensitivity(
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model,
      std::string stepperType);

  IntegratorPseudoTransientAdjointSensitivity(
      Teuchos::RCP<Teuchos::ParameterList> pList,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model);

  IntegratorPseudoTransientAdjointSensitivity(
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      std::string stepperType);


  IntegratorPseudoTransientAdjointSensitivity();

  virtual ~IntegratorPseudoTransientAdjointSensitivity() {}



  virtual bool advanceTime();
  virtual bool advanceTime(const Scalar timeFinal) override;
  virtual Scalar getTime() const override;
  virtual int getIndex() const override;
  virtual Status getStatus() const override;
  virtual void setStatus(const Status st) override;
  virtual Teuchos::RCP<Stepper<Scalar> > getStepper() const override;
  Teuchos::RCP<Stepper<Scalar> > getStateStepper() const;
  Teuchos::RCP<Stepper<Scalar> > getSensStepper() const;
  virtual Teuchos::RCP<const SolutionHistory<Scalar> > getSolutionHistory()
      const override;
  Teuchos::RCP<const SolutionHistory<Scalar> > getStateSolutionHistory() const;
  Teuchos::RCP<const SolutionHistory<Scalar> > getSensSolutionHistory() const;
  virtual Teuchos::RCP<SolutionHistory<Scalar> > getNonConstSolutionHistory()
      override;
  virtual Teuchos::RCP<const TimeStepControl<Scalar> > getTimeStepControl()
      const override;
  virtual Teuchos::RCP<TimeStepControl<Scalar> > getNonConstTimeStepControl()
      override;
  Teuchos::RCP<TimeStepControl<Scalar> > getStateNonConstTimeStepControl();
  Teuchos::RCP<TimeStepControl<Scalar> > getSensNonConstTimeStepControl();
  virtual Teuchos::RCP<IntegratorObserver<Scalar> > getObserver();
  virtual void setObserver(
      Teuchos::RCP<IntegratorObserver<Scalar> > obs = Teuchos::null);
  virtual Teuchos::RCP<Teuchos::Time> getIntegratorTimer() const override
  {
    return state_integrator_->getIntegratorTimer();
  }
  virtual Teuchos::RCP<Teuchos::Time> getStepperTimer() const override
  {
    return state_integrator_->getStepperTimer();
  }


  virtual void initializeSolutionHistory(
      Scalar t0, Teuchos::RCP<const Thyra::VectorBase<Scalar> > x0,
      Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdot0      = Teuchos::null,
      Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdotdot0   = Teuchos::null,
      Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > y0    = Teuchos::null,
      Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > ydot0 = Teuchos::null,
      Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > ydotdot0 =
          Teuchos::null);

  virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getX() const;
  virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getXDot() const;
  virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getXDotDot() const;

  virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getY() const;
  virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getYDot() const;
  virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getYDotDot()
      const;

  virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getG() const;
  virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getDgDp() const;


  void setParameterList(
      const Teuchos::RCP<Teuchos::ParameterList>& pl) override;
  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList() override;
  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList() override;

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


  std::string description() const override;
  void describe(Teuchos::FancyOStream& out,
                const Teuchos::EVerbosityLevel verbLevel) const override;

  SensitivityStepMode getStepMode() const;

  void setDoForwardIntegration(const bool f) { do_forward_integration_ = f; }
  bool getDoForwardIntegration() const { return do_forward_integration_; }

  void setDoAdjointIntegration(const bool f) { do_adjoint_integration_ = f; }
  bool getDoAdjointIntegration() const { return do_adjoint_integration_; }

 protected:
  typedef Thyra::DefaultMultiVectorProductVector<Scalar> DMVPV;

  // Create sensitivity model evaluator from application model
  Teuchos::RCP<AdjointSensitivityModelEvaluator<Scalar> >
  createSensitivityModel(
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >&
          adjoint_residual_model,
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
      const Teuchos::RCP<Teuchos::ParameterList>& inputPL);

  void buildSolutionHistory();

  Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > model_;
  Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > adjoint_residual_model_;
  Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > adjoint_solve_model_;
  Teuchos::RCP<AdjointSensitivityModelEvaluator<Scalar> > sens_model_;
  Teuchos::RCP<IntegratorBasic<Scalar> > state_integrator_;
  Teuchos::RCP<IntegratorBasic<Scalar> > sens_integrator_;
  Teuchos::RCP<SolutionHistory<Scalar> > solutionHistory_;
  Teuchos::RCP<Thyra::VectorBase<Scalar> > g_;
  Teuchos::RCP<DMVPV> dgdp_;
  SensitivityStepMode stepMode_;
  bool do_forward_integration_;
  bool do_adjoint_integration_;
};

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
    std::string stepperType);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model,
    std::string stepperType);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity(
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
    std::string stepperType);

template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientAdjointSensitivity<Scalar> >
integratorPseudoTransientAdjointSensitivity();

}  // namespace Tempus

#endif  // Tempus_IntegratorPseudoTransientAdjointSensitivity_decl_hpp