Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_CombinedForwardSensitivityModelEvaluator_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_CombinedForwardSensitivityModelEvaluator_decl_hpp
10 #define Tempus_CombinedForwardSensitivityModelEvaluator_decl_hpp
11 
12 #include "Tempus_config.hpp"
14 #include "Thyra_StateFuncModelEvaluatorBase.hpp"
15 #include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
16 #include "Thyra_DefaultMultiVectorProductVector.hpp"
17 
18 namespace Tempus {
19 
38 template <typename Scalar>
41  public SensitivityModelEvaluatorBase<Scalar> {
42 public:
45 
47 
74  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model,
75  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & sens_residual_model,
76  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & sens_solve_model,
77  const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null,
78  const Teuchos::RCP<MultiVector>& dxdp_init = Teuchos::null,
79  const Teuchos::RCP<MultiVector>& dx_dotdp_init = Teuchos::null,
80  const Teuchos::RCP<MultiVector>& dx_dotdot_dp_init = Teuchos::null);
81 
84 
87  { return model_; }
88 
90 
92  int getSensitivityParamIndex() const { return p_index_; }
93 
96 
98 
100 
102 
104 
106 
108 
110 
112 
114 
116 
118  get_W_factory() const;
119 
121 
123 
125 
127 
128 private:
129 
131 
133 
134  void evalModelImpl(
136  const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;
137 
138 
141 
148  int p_index_;
149  int g_index_;
155 
164 
170 };
171 
172 } // namespace Tempus
173 
174 #endif
Transform a ModelEvaluator&#39;s sensitivity equations to its residual.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int p) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int j) const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_DgDx_dot_op(int j) const
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int p) const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_DgDp_op(int j, int l) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_DgDx_op(int j) const
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)
Constructor.
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getForwardModel() const
Get the underlying model &#39;f&#39;.
A ModelEvaluator decorator for sensitivity analysis.