Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_AdjointAuxSensitivityModelEvaluator_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_AdjointAuxSensitivityModelEvaluator_decl_hpp
10#define Tempus_AdjointAuxSensitivityModelEvaluator_decl_hpp
11
12#include "Thyra_StateFuncModelEvaluatorBase.hpp"
13#include "Thyra_DefaultProductVectorSpace.hpp"
14#include "Thyra_DefaultProductVector.hpp"
15#include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
16#include "Thyra_DefaultMultiVectorProductVector.hpp"
17
18#include "Tempus_config.hpp"
19#include "Tempus_SolutionHistory.hpp"
20
21namespace Tempus {
22
56template <typename Scalar>
58 public Thyra::StateFuncModelEvaluatorBase<Scalar> {
59public:
62
64
83 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model,
84 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & adjoint_model,
85 const Scalar& t_init,
86 const Scalar& t_final,
87 const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null);
88
90 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getModel() const
91 { return model_; }
92
94 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getAdjointModel() const
95 { return adjoint_model_; }
96
98 void setFinalTime(const Scalar t_final);
99
102 const Teuchos::RCP<const Tempus::SolutionHistory<Scalar> >& sh);
103
106
107 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int p) const;
108
109 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int p) const;
110
111 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
112
113 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
114
115 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
116
117 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
118 get_W_factory() const;
119
120 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
121
122 Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
123
125
126 static Teuchos::RCP<const Teuchos::ParameterList> getValidParameters();
127
128private:
129
130 typedef Thyra::DefaultProductVectorSpace<Scalar> DPVS;
131 typedef Thyra::DefaultProductVector<Scalar> DPV;
132 typedef Thyra::DefaultMultiVectorProductVectorSpace<Scalar> DMVPVS;
133 typedef Thyra::DefaultMultiVectorProductVector<Scalar> DMVPV;
134
135 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
136
137 void evalModelImpl(
138 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs,
139 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;
140
141
142 Thyra::ModelEvaluatorBase::InArgs<Scalar> prototypeInArgs_;
143 Thyra::ModelEvaluatorBase::OutArgs<Scalar> prototypeOutArgs_;
144
145 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > model_;
146 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > adjoint_model_;
147
148 Teuchos::RCP<const DMVPVS> adjoint_space_;
149 Teuchos::RCP<const DMVPVS> residual_space_;
150 Teuchos::RCP<const DMVPVS> response_space_;
151 Teuchos::RCP<const DPVS> x_prod_space_;
152 Teuchos::RCP<const DPVS> f_prod_space_;
153 Teuchos::RCP<const Tempus::SolutionHistory<Scalar> > sh_;
154 Scalar t_init_;
155 Scalar t_final_;
161
163 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdx_;
164 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdxdot_;
165 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdp_op_;
166 mutable Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > my_dfdp_mv_;
167 mutable Teuchos::RCP<Tempus::SolutionState<Scalar> > forward_state_;
168 mutable Scalar t_interp_;
169};
170
171} // namespace Tempus
172
173#endif
ModelEvaluator for forming adjoint sensitivity equations.
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int p) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > adjoint_model_
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Thyra::DefaultMultiVectorProductVectorSpace< Scalar > DMVPVS
static Teuchos::RCP< const Teuchos::ParameterList > getValidParameters()
void setFinalTime(const Scalar t_final)
Set the final time from the forward evaluation.
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAdjointModel() const
Get the underlying adjoint model.
Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > sh_
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
Get the underlying model 'f'.
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
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
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > model_
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int p) const
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...