Tempus_CombinedForwardSensitivityModelEvaluator_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_CombinedForwardSensitivityModelEvaluator_decl_hpp
#define Tempus_CombinedForwardSensitivityModelEvaluator_decl_hpp
 
#include "Tempus_config.hpp"
#include "Tempus_SensitivityModelEvaluatorBase.hpp"
#include "Thyra_StateFuncModelEvaluatorBase.hpp"
#include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
#include "Thyra_DefaultMultiVectorProductVector.hpp"
 
namespace Tempus {
 
template <typename Scalar>
class CombinedForwardSensitivityModelEvaluator
  : public Thyra::StateFuncModelEvaluatorBase<Scalar>,
    public SensitivityModelEvaluatorBase<Scalar> {
 public:
  typedef Thyra::VectorBase<Scalar> Vector;
  typedef Thyra::MultiVectorBase<Scalar> MultiVector;
 
 
  CombinedForwardSensitivityModelEvaluator(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >&
          sens_residual_model,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >&
          sens_solve_model,
      const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null,
      const Teuchos::RCP<MultiVector>& dxdp_init              = Teuchos::null,
      const Teuchos::RCP<MultiVector>& dx_dotdp_init          = Teuchos::null,
      const Teuchos::RCP<MultiVector>& dx_dotdot_dp_init      = Teuchos::null);
 
 
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getForwardModel() const
  {
    return model_;
  }
 
 
  int getSensitivityParamIndex() const { return p_index_; }
 
 
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int p) const;
 
  Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int p) const;
 
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
 
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
 
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int j) const;
 
  Teuchos::ArrayView<const std::string> get_g_names(int j) const;
 
  Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
 
  Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_DgDx_dot_op(int j) const;
 
  Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_DgDx_op(int j) const;
 
  Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_DgDp_op(int j, int l) const;
 
  Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
  get_W_factory() const;
 
  Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
 
  Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
 
 
  static Teuchos::RCP<const Teuchos::ParameterList> getValidParameters();
 
 private:
  typedef Thyra::DefaultMultiVectorProductVectorSpace<Scalar> DMVPVS;
 
  Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
 
  void evalModelImpl(
      const Thyra::ModelEvaluatorBase::InArgs<Scalar>& inArgs,
      const Thyra::ModelEvaluatorBase::OutArgs<Scalar>& outArgs) const;
 
  Thyra::ModelEvaluatorBase::InArgs<Scalar> prototypeInArgs_;
  Thyra::ModelEvaluatorBase::OutArgs<Scalar> prototypeOutArgs_;
 
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > model_;
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > sens_residual_model_;
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > sens_solve_model_;
  Teuchos::RCP<MultiVector> dxdp_init_;
  Teuchos::RCP<MultiVector> dx_dotdp_init_;
  Teuchos::RCP<MultiVector> dx_dotdotdp_init_;
  int p_index_;
  int g_index_;
  int x_tangent_index_;
  int xdot_tangent_index_;
  int xdotdot_tangent_index_;
  bool use_dfdp_as_tangent_;
  bool use_dgdp_as_tangent_;
 
  int num_param_;
  int num_response_;
  int g_offset_;
  Teuchos::RCP<const DMVPVS> dxdp_space_;
  Teuchos::RCP<const DMVPVS> x_dxdp_space_;
  Teuchos::RCP<const DMVPVS> dfdp_space_;
  Teuchos::RCP<const DMVPVS> f_dfdp_space_;
  Teuchos::RCP<const DMVPVS> dgdp_space_;
 
  mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdx_;
  mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdxdot_;
  mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdxdotdot_;
  mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dgdx_;
  mutable Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > my_dgdx_mv_;
};
 
}  // namespace Tempus
 
#endif