Tempus_IntegratorPseudoTransientForwardSensitivity_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_IntegratorPseudoTransientForwardSensitivity_decl_hpp
#define Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp

// Tempus
#include "Tempus_config.hpp"
#include "Tempus_IntegratorBasic.hpp"
#include "Tempus_SensitivityModelEvaluatorBase.hpp"

#include "Tempus_StepperStaggeredForwardSensitivity.hpp"  // For SensitivityStepMode

namespace Tempus {

template <class Scalar>
class IntegratorPseudoTransientForwardSensitivity
  : virtual public Tempus::Integrator<Scalar> {
 public:
  IntegratorPseudoTransientForwardSensitivity(
      const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& model,
      const Teuchos::RCP<SensitivityModelEvaluatorBase<Scalar>>& sens_model,
      const Teuchos::RCP<IntegratorBasic<Scalar>>& fwd_integrator,
      const Teuchos::RCP<IntegratorBasic<Scalar>>& sens_integrator,
      const bool reuse_solver, const bool force_W_update);


  IntegratorPseudoTransientForwardSensitivity();

  virtual ~IntegratorPseudoTransientForwardSensitivity() {}



  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>> DxDp0 = Teuchos::null,
      Teuchos::RCP<const Thyra::MultiVectorBase<Scalar>> DxdotDp0 =
          Teuchos::null,
      Teuchos::RCP<const Thyra::MultiVectorBase<Scalar>> DxdotdotDp0 =
          Teuchos::null);

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

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


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

  SensitivityStepMode getStepMode() const;

 protected:
  void buildSolutionHistory();

  Teuchos::RCP<Thyra::ModelEvaluator<Scalar>> model_;
  Teuchos::RCP<SensitivityModelEvaluatorBase<Scalar>> sens_model_;
  Teuchos::RCP<IntegratorBasic<Scalar>> state_integrator_;
  Teuchos::RCP<IntegratorBasic<Scalar>> sens_integrator_;
  Teuchos::RCP<SolutionHistory<Scalar>> solutionHistory_;
  bool reuse_solver_;
  bool force_W_update_;
  SensitivityStepMode stepMode_;
};


template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar>>
createIntegratorPseudoTransientForwardSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& sens_residual_model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& sens_solve_model);


template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar>>
createIntegratorPseudoTransientForwardSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& model,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& sens_residual_model)
{
  return createIntegratorPseudoTransientForwardSensitivity(
      pList, model, sens_residual_model, sens_residual_model);
}


template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar>>
createIntegratorPseudoTransientForwardSensitivity(
    Teuchos::RCP<Teuchos::ParameterList> pList,
    const Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>& model)
{
  return createIntegratorPseudoTransientForwardSensitivity(pList, model, model,
                                                           model);
}


template <class Scalar>
Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar>>
createIntegratorPseudoTransientForwardSensitivity();

}  // namespace Tempus

#endif  // Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp