Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_AdjointSensitivityModelEvaluator_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_AdjointSensitivityModelEvaluator_decl_hpp
10#define Tempus_AdjointSensitivityModelEvaluator_decl_hpp
11
12#include "Thyra_StateFuncModelEvaluatorBase.hpp"
13#include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
14#include "Thyra_DefaultMultiVectorProductVector.hpp"
15
16#include "Tempus_config.hpp"
17#include "Tempus_SolutionHistory.hpp"
18
19namespace Tempus {
20
53template <typename Scalar>
55 public Thyra::StateFuncModelEvaluatorBase<Scalar> {
56public:
59
61
80 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model,
81 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & adjoint_residual_model,
82 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & adjoint_solve_model,
83 const Scalar& t_init,
84 const Scalar& t_final,
85 const bool is_pseudotransient,
86 const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null);
87
89 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getModel() const
90 { return model_; }
91
93 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getAdjointResidualModel() const
94 { return adjoint_residual_model_; }
95
97 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getAdjointSolveModel() const
98 { return adjoint_solve_model_; }
99
101 void setFinalTime(const Scalar t_final);
102
105 const Teuchos::RCP<const Tempus::SolutionHistory<Scalar> >& sh);
106
109
110 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int p) const;
111
112 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int p) const;
113
114 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
115
116 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
117
118 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int j) const;
119
120 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
121
122 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
123 get_W_factory() const;
124
125 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
126
127 Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
128
130
131 static Teuchos::RCP<const Teuchos::ParameterList> getValidParameters();
132
133private:
134
135 typedef Thyra::DefaultMultiVectorProductVectorSpace<Scalar> DMVPVS;
136 typedef Thyra::DefaultMultiVectorProductVector<Scalar> DMVPV;
137
138 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
139
140 void evalModelImpl(
141 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs,
142 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;
143
144
145 Thyra::ModelEvaluatorBase::InArgs<Scalar> prototypeInArgs_;
146 Thyra::ModelEvaluatorBase::OutArgs<Scalar> prototypeOutArgs_;
147
148 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > model_;
149 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > adjoint_residual_model_;
150 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > adjoint_solve_model_;
151
152 Teuchos::RCP<const DMVPVS> adjoint_space_;
153 Teuchos::RCP<const DMVPVS> residual_space_;
154 Teuchos::RCP<const DMVPVS> response_space_;
155 Teuchos::RCP<const Tempus::SolutionHistory<Scalar> > sh_;
156 Scalar t_init_;
157 Scalar t_final_;
164
168 mutable Teuchos::RCP<Thyra::VectorBase<Scalar> > my_x_dot_;
169 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdx_;
170 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdxdot_;
171 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdp_op_;
172 mutable Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > my_dfdp_mv_;
173 mutable Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > my_dgdx_mv_;
174 mutable Teuchos::RCP<Tempus::SolutionState<Scalar> > forward_state_;
175 mutable Scalar t_interp_;
176};
177
178} // namespace Tempus
179
180#endif
ModelEvaluator for forming adjoint sensitivity equations.
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAdjointResidualModel() const
Get the underlying adjoint residual model.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int p) const
Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > my_dgdx_mv_
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > adjoint_residual_model_
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Teuchos::RCP< Tempus::SolutionState< Scalar > > forward_state_
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAdjointSolveModel() const
Get the underlying adjoint solve model.
void setForwardSolutionHistory(const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
Set solution history from forward evaluation.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
static Teuchos::RCP< const Teuchos::ParameterList > getValidParameters()
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > model_
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
Get the underlying model 'f'.
AdjointSensitivityModelEvaluator(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &adjoint_residual_model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &adjoint_solve_model, const Scalar &t_init, const Scalar &t_final, const bool is_pseudotransient, const Teuchos::RCP< const Teuchos::ParameterList > &pList=Teuchos::null)
Constructor.
Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > sh_
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
Thyra::DefaultMultiVectorProductVectorSpace< Scalar > DMVPVS
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int p) const
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > adjoint_solve_model_
void setFinalTime(const Scalar t_final)
Set the final time from the forward evaluation.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int j) const
Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > my_dfdp_mv_
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...