9#ifndef Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp
10#define Tempus_IntegratorPseudoTransientForwardSensitivity_decl_hpp
13#include "Tempus_config.hpp"
14#include "Tempus_IntegratorBasic.hpp"
17#include "Tempus_StepperStaggeredForwardSensitivity.hpp"
102 const bool reuse_solver,
const bool force_W_update);
117 virtual bool advanceTime(
const Scalar timeFinal)
override;
119 virtual Scalar
getTime()
const override;
121 virtual int getIndex()
const override;
127 virtual Teuchos::RCP<Stepper<Scalar> >
getStepper()
const override;
131 virtual Teuchos::RCP<const SolutionHistory<Scalar> >
getSolutionHistory()
const override;
137 virtual Teuchos::RCP<const TimeStepControl<Scalar> >
getTimeStepControl()
const override;
142 virtual Teuchos::RCP<IntegratorObserver<Scalar> >
getObserver();
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;
174 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
getG()
const;
176 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
getDgDp()
const;
181 void describe(Teuchos::FancyOStream & out,
182 const Teuchos::EVerbosityLevel verbLevel)
const override;
192 Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>
model_;
214template<
class Scalar>
215Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
217 Teuchos::RCP<Teuchos::ParameterList> pList,
233template<
class Scalar>
234Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
236 Teuchos::RCP<Teuchos::ParameterList> pList,
241 pList, model, sens_residual_model, sens_residual_model);
254template<
class Scalar>
255Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
257 Teuchos::RCP<Teuchos::ParameterList> pList,
261 pList, model, model, model);
273template<
class Scalar>
274Teuchos::RCP<Tempus::IntegratorPseudoTransientForwardSensitivity<Scalar> >
IntegratorObserver class for time integrators.
Time integrator suitable for pseudotransient forward sensitivity analysis.
Teuchos::RCP< const SolutionHistory< Scalar > > getSensSolutionHistory() const
virtual Status getStatus() const override
Get Status.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDotDot() const
Get current the second time derivative of the solution, xdotdot.
Teuchos::RCP< SensitivityModelEvaluatorBase< Scalar > > sens_model_
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getG() const
Return response function g.
virtual ~IntegratorPseudoTransientForwardSensitivity()
Destructor.
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl() override
Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > model_
std::string description() const override
IntegratorPseudoTransientForwardSensitivity()
Destructor.
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 void setStatus(const Status st) override
Set Status.
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< Teuchos::Time > getStepperTimer() const override
Teuchos::RCP< Stepper< Scalar > > getSensStepper() const
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 int getIndex() const override
Get current index.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDot() const
Get current the time derivative of the solution, xdot.
Teuchos::RCP< TimeStepControl< Scalar > > getStateNonConstTimeStepControl()
void buildSolutionHistory()
SensitivityStepMode stepMode_
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const override
Get the TimeStepControl.
Teuchos::RCP< IntegratorBasic< Scalar > > state_integrator_
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDXDotDp() const
Teuchos::RCP< IntegratorBasic< Scalar > > sens_integrator_
Teuchos::RCP< const SolutionHistory< Scalar > > getStateSolutionHistory() const
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDXDotDotDp() const
virtual Scalar getTime() const override
Get current time.
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.
Teuchos::RCP< SolutionHistory< Scalar > > 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.
Teuchos::RCP< TimeStepControl< Scalar > > getSensNonConstTimeStepControl()
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDxDp() const
Teuchos::RCP< Stepper< Scalar > > getStateStepper() 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.