Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_IntegratorPseudoTransientForwardSensitivity_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_IntegratorPseudoTransientForwardSensitivity_decl_hpp
10#define Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp
11
12// Tempus
13#include "Tempus_config.hpp"
14#include "Tempus_IntegratorBasic.hpp"
16
17#include "Tempus_StepperStaggeredForwardSensitivity.hpp" // For SensitivityStepMode
18
19namespace Tempus {
20
21
57template<class Scalar>
59 : virtual public Tempus::Integrator<Scalar>
60{
61public:
62
98 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
99 const Teuchos::RCP<SensitivityModelEvaluatorBase<Scalar> >&sens_model,
100 const Teuchos::RCP<IntegratorBasic<Scalar> > &fwd_integrator,
101 const Teuchos::RCP<IntegratorBasic<Scalar> > &sens_integrator,
102 const bool reuse_solver, const bool force_W_update);
103
105
107
110
112
113
115 virtual bool advanceTime();
117 virtual bool advanceTime(const Scalar timeFinal) override;
119 virtual Scalar getTime() const override;
121 virtual int getIndex() const override;
123 virtual Status getStatus() const override;
125 virtual void setStatus(const Status st) override;
127 virtual Teuchos::RCP<Stepper<Scalar> > getStepper() const override;
128 Teuchos::RCP<Stepper<Scalar> > getStateStepper() const;
129 Teuchos::RCP<Stepper<Scalar> > getSensStepper() const;
131 virtual Teuchos::RCP<const SolutionHistory<Scalar> > getSolutionHistory() const override;
132 Teuchos::RCP<const SolutionHistory<Scalar> > getStateSolutionHistory() const;
133 Teuchos::RCP<const SolutionHistory<Scalar> > getSensSolutionHistory() const;
135 virtual Teuchos::RCP<SolutionHistory<Scalar> > getNonConstSolutionHistory() override;
137 virtual Teuchos::RCP<const TimeStepControl<Scalar> > getTimeStepControl() const override;
138 virtual Teuchos::RCP<TimeStepControl<Scalar> > getNonConstTimeStepControl() override;
139 Teuchos::RCP<TimeStepControl<Scalar> > getStateNonConstTimeStepControl();
140 Teuchos::RCP<TimeStepControl<Scalar> > getSensNonConstTimeStepControl();
142 virtual Teuchos::RCP<IntegratorObserver<Scalar> > getObserver();
144 virtual void setObserver(
145 Teuchos::RCP<IntegratorObserver<Scalar> > obs = Teuchos::null);
146 virtual Teuchos::RCP<Teuchos::Time> getIntegratorTimer() const override
147 {return state_integrator_->getIntegratorTimer();}
148 virtual Teuchos::RCP<Teuchos::Time> getStepperTimer() const override
149 {return state_integrator_->getStepperTimer();}
150
152
154 virtual void initializeSolutionHistory(
155 Scalar t0,
156 Teuchos::RCP<const Thyra::VectorBase<Scalar> > x0,
157 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdot0 = Teuchos::null,
158 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdotdot0 = Teuchos::null,
159 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > DxDp0 = Teuchos::null,
160 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > DxdotDp0 = Teuchos::null,
161 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > DxdotdotDp0 = Teuchos::null);
162
164 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getX() const;
165 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getDxDp() const;
167 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getXDot() const;
168 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getDXDotDp() const;
170 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getXDotDot() const;
171 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getDXDotDotDp() const;
172
174 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> > getG() const;
176 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > getDgDp() const;
177
179
180 std::string description() const override;
181 void describe(Teuchos::FancyOStream & out,
182 const Teuchos::EVerbosityLevel verbLevel) const override;
184
187
188protected:
189
191
192 Teuchos::RCP<Thyra::ModelEvaluator<Scalar>> model_;
193 Teuchos::RCP<SensitivityModelEvaluatorBase<Scalar>> sens_model_;
194 Teuchos::RCP<IntegratorBasic<Scalar>> state_integrator_;
195 Teuchos::RCP<IntegratorBasic<Scalar>> sens_integrator_;
196 Teuchos::RCP<SolutionHistory<Scalar>> solutionHistory_;
200};
201
203
214template<class Scalar>
215Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
217 Teuchos::RCP<Teuchos::ParameterList> pList,
218 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
219 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& sens_residual_model,
220 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& sens_solve_model);
221
223
233template<class Scalar>
234Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
236 Teuchos::RCP<Teuchos::ParameterList> pList,
237 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
238 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& sens_residual_model)
239{
241 pList, model, sens_residual_model, sens_residual_model);
242}
243
245
254template<class Scalar>
255Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
257 Teuchos::RCP<Teuchos::ParameterList> pList,
258 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model)
259{
261 pList, model, model, model);
262}
263
265
273template<class Scalar>
274Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
276
277} // namespace Tempus
278
279#endif // Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp
IntegratorObserver class for time integrators.
Time integrator suitable for pseudotransient forward sensitivity analysis.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDotDot() const
Get current the second time derivative of the solution, xdotdot.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getG() const
Return response function g.
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl() override
SensitivityStepMode getStepMode() const
What mode the current time integration step is in.
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)
Set the initial state from Thyra::VectorBase(s)
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer() const override
Returns the IntegratorTimer_ for this Integrator.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getX() const
Get current the solution, x.
virtual Teuchos::RCP< SolutionHistory< Scalar > > getNonConstSolutionHistory() override
Get the SolutionHistory.
virtual Teuchos::RCP< IntegratorObserver< Scalar > > getObserver()
Get the Observer.
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDgDp() const
Return forward sensitivity stored in Jacobian format.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDot() const
Get current the time derivative of the solution, xdot.
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const override
Get the TimeStepControl.
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDXDotDp() const
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDXDotDotDp() const
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
virtual Teuchos::RCP< Stepper< Scalar > > getStepper() const override
Get the Stepper.
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const override
Get the SolutionHistory.
virtual void setObserver(Teuchos::RCP< IntegratorObserver< Scalar > > obs=Teuchos::null)
Set the Observer.
virtual bool advanceTime()
Advance the solution to timeMax, and return true if successful.
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDxDp() const
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
A ModelEvaluator decorator for sensitivity analysis.
Status
Status for the Integrator, the Stepper and the SolutionState.
Teuchos::RCP< Tempus::IntegratorPseudoTransientForwardSensitivity< Scalar > > createIntegratorPseudoTransientForwardSensitivity()
Nonmember constructor.