9#ifndef Tempus_IntegratorAdjointSensitivity_decl_hpp
10#define Tempus_IntegratorAdjointSensitivity_decl_hpp
13#include "Tempus_config.hpp"
14#include "Tempus_IntegratorBasic.hpp"
15#include "Tempus_AdjointAuxSensitivityModelEvaluator.hpp"
17#include "Tempus_StepperStaggeredForwardSensitivity.hpp"
116 const Teuchos::RCP<IntegratorBasic<Scalar> > &state_integrator,
118 const Teuchos::RCP<AdjointAuxSensitivityModelEvaluator<Scalar> > &adjoint_aux_model,
119 const Teuchos::RCP<IntegratorBasic<Scalar> > &adjoint_integrator,
120 const Teuchos::RCP<SolutionHistory<Scalar> > &solution_history,
123 const bool g_depends_on_p,
124 const bool f_depends_on_p,
125 const bool ic_depends_on_p,
126 const bool mass_matrix_is_identity);
140 virtual bool advanceTime(
const Scalar timeFinal)
override;
142 virtual Scalar
getTime()
const override;
144 virtual int getIndex()
const override;
150 virtual Teuchos::RCP<Stepper<Scalar> >
getStepper()
const override;
152 virtual Teuchos::RCP<const SolutionHistory<Scalar> >
getSolutionHistory()
const override;
158 virtual Teuchos::RCP<const TimeStepControl<Scalar> >
getTimeStepControl()
const override;
181 virtual Teuchos::RCP<IntegratorObserver<Scalar> >
getObserver();
184 Teuchos::RCP<IntegratorObserver<Scalar> > obs = Teuchos::null);
189 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
getX()
const;
191 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
getXDot()
const;
193 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
getXDotDot()
const;
196 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
getY()
const;
198 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
getYDot()
const;
200 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
getYDotDot()
const;
203 virtual Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
getDgDp()
const;
208 void describe(Teuchos::FancyOStream & out,
209 const Teuchos::EVerbosityLevel verbLevel)
const override;
218 Teuchos::RCP<AdjointAuxSensitivityModelEvaluator<Scalar> >
222 const Teuchos::RCP<Teuchos::ParameterList>& inputPL);
225 const Teuchos::RCP<
const SolutionHistory<Scalar> >& state_solution_history,
226 const Teuchos::RCP<
const SolutionHistory<Scalar> >& adjoint_solution_history);
228 Teuchos::RCP<Thyra::ModelEvaluator<Scalar>>
model_;
240 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar>>
dxdp_init_;
241 Teuchos::RCP<Thyra::MultiVectorBase<Scalar>>
dgdp_;
262template <
class Scalar>
263Teuchos::RCP<IntegratorAdjointSensitivity<Scalar>>
265 Teuchos::RCP<Teuchos::ParameterList> pList,
270template<
class Scalar>
271Teuchos::RCP<IntegratorAdjointSensitivity<Scalar> >
Time integrator suitable for adjoint sensitivity analysis.
Teuchos::RCP< const SolutionHistory< Scalar > > getSensSolutionHistory() const
virtual Teuchos::RCP< SolutionHistory< Scalar > > getNonConstSolutionHistory() override
Get the SolutionHistory.
virtual Teuchos::RCP< Teuchos::Time > getStepperTimer() const override
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getYDot() const
Get the current time derivative of the adjoint solution, ydot.
virtual void setObserver(Teuchos::RCP< IntegratorObserver< Scalar > > obs=Teuchos::null)
Set the Observer.
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDotDot() const
Get the current second time derivative of the solution, xdotdot.
virtual Scalar getTime() const override
Get current time.
virtual int getIndex() const override
Get current index.
virtual Status getStatus() const override
Get Status.
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const override
Get the SolutionHistory.
void buildSolutionHistory(const Teuchos::RCP< const SolutionHistory< Scalar > > &state_solution_history, const Teuchos::RCP< const SolutionHistory< Scalar > > &adjoint_solution_history)
Teuchos::RCP< TimeStepControl< Scalar > > getSensNonConstTimeStepControl()
bool mass_matrix_is_identity_
virtual void initialize()
Initializes the Integrator after set* function calls.
IntegratorAdjointSensitivity()
Constructor that requires a subsequent setParameterList, setStepper, and initialize calls.
std::string description() const override
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer() const override
Returns the IntegratorTimer_ for this Integrator.
Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > model_
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getX() const
Get the current solution, x.
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getYDotDot() const
Get the current second time derivative of the adjoint solution, ydotdot.
Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > dxdp_init_
virtual bool advanceTime()
Advance the solution to timeMax, and return true if successful.
Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > adjoint_model_
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDot() const
Get the current time derivative of the solution, xdot.
virtual ~IntegratorAdjointSensitivity()
Destructor.
virtual void setStatus(const Status st) override
Set Status.
SensitivityStepMode getStepMode() const
What mode the current time integration step is in.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const override
Get the TimeStepControl.
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl() override
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< Stepper< Scalar > > getStepper() const override
Get the Stepper.
Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > dgdp_
SensitivityStepMode stepMode_
Teuchos::RCP< const SolutionHistory< Scalar > > getStateSolutionHistory() const
Teuchos::RCP< IntegratorBasic< Scalar > > adjoint_integrator_
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDgDp() const
Return adjoint sensitivity stored in gradient format.
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getY() const
Get the current adjoint solution, y.
virtual Teuchos::RCP< IntegratorObserver< Scalar > > getObserver()
Get the Observer.
Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory_
Teuchos::RCP< IntegratorBasic< Scalar > > state_integrator_
Teuchos::RCP< TimeStepControl< Scalar > > getStateNonConstTimeStepControl()
Teuchos::RCP< AdjointAuxSensitivityModelEvaluator< Scalar > > createAdjointModel(const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjoint_model, const Teuchos::RCP< Teuchos::ParameterList > &inputPL)
Teuchos::RCP< AdjointAuxSensitivityModelEvaluator< Scalar > > adjoint_aux_model_
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
Status
Status for the Integrator, the Stepper and the SolutionState.
Teuchos::RCP< IntegratorAdjointSensitivity< Scalar > > createIntegratorAdjointSensitivity()
Nonmember constructor.