Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.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_IntegratorPseudoTransientAdjointSensitivity_impl_hpp
10#define Tempus_IntegratorPseudoTransientAdjointSensitivity_impl_hpp
11
12#include "Thyra_DefaultMultiVectorProductVector.hpp"
13#include "Thyra_VectorStdOps.hpp"
14#include "Thyra_MultiVectorStdOps.hpp"
15#include "Thyra_ImplicitAdjointModelEvaluator.hpp"
16
17
18namespace Tempus {
19
20template<class Scalar>
21IntegratorPseudoTransientAdjointSensitivity<Scalar>::
22IntegratorPseudoTransientAdjointSensitivity(
23 Teuchos::RCP<Teuchos::ParameterList> inputPL,
24 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
25 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
26 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model)
27{
28 model_ = model;
29 adjoint_residual_model_ = adjoint_residual_model;
30 adjoint_solve_model_ = adjoint_solve_model;
31 state_integrator_ = createIntegratorBasic<Scalar>(inputPL, model_);
32 sens_model_ = createSensitivityModel(model_, adjoint_residual_model_,
33 adjoint_solve_model_, inputPL);
34 sens_integrator_ = createIntegratorBasic<Scalar>(inputPL, sens_model_);
35 stepMode_ = SensitivityStepMode::Forward;
36 do_forward_integration_ = true;
37 do_adjoint_integration_ = true;
38}
39
40template<class Scalar>
41IntegratorPseudoTransientAdjointSensitivity<Scalar>::
42IntegratorPseudoTransientAdjointSensitivity(
43 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
44 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
45 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
46 std::string stepperType)
47{
48 model_ = model;
49 adjoint_residual_model_ = adjoint_residual_model;
50 adjoint_solve_model_ = adjoint_solve_model;
51 state_integrator_ = createIntegratorBasic<Scalar>(model_, stepperType);
52 sens_model_ = createSensitivityModel(model_, adjoint_residual_model_,
53 adjoint_solve_model_, Teuchos::null);
54 sens_integrator_ = createIntegratorBasic<Scalar>(sens_model_, stepperType);
55 stepMode_ = SensitivityStepMode::Forward;
56 do_forward_integration_ = true;
57 do_adjoint_integration_ = true;
58}
59
60template<class Scalar>
61IntegratorPseudoTransientAdjointSensitivity<Scalar>::
62IntegratorPseudoTransientAdjointSensitivity(
63 Teuchos::RCP<Teuchos::ParameterList> inputPL,
64 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
65 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model) :
66 IntegratorPseudoTransientAdjointSensitivity(
67 inputPL, model, adjoint_model, adjoint_model)
68{
69}
70
71template<class Scalar>
72IntegratorPseudoTransientAdjointSensitivity<Scalar>::
73IntegratorPseudoTransientAdjointSensitivity(
74 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
75 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model,
76 std::string stepperType) :
77 IntegratorPseudoTransientAdjointSensitivity(
78 model, adjoint_model, adjoint_model, stepperType)
79{
80}
81
82template<class Scalar>
83IntegratorPseudoTransientAdjointSensitivity<Scalar>::
84IntegratorPseudoTransientAdjointSensitivity(
85 Teuchos::RCP<Teuchos::ParameterList> inputPL,
86 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model) :
87 IntegratorPseudoTransientAdjointSensitivity(
88 inputPL, model, Thyra::implicitAdjointModelEvaluator(model))
89{
90}
91
92template<class Scalar>
93IntegratorPseudoTransientAdjointSensitivity<Scalar>::
94IntegratorPseudoTransientAdjointSensitivity(
95 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
96 std::string stepperType) :
97 IntegratorPseudoTransientAdjointSensitivity(
98 model, Thyra::implicitAdjointModelEvaluator(model), stepperType)
99{
100}
101
102template<class Scalar>
110
111template<class Scalar>
112bool
113IntegratorPseudoTransientAdjointSensitivity<Scalar>::
114advanceTime()
115{
116 const Scalar tfinal =
117 state_integrator_->getTimeStepControl()->getFinalTime();
118 return advanceTime(tfinal);
119}
120
121template<class Scalar>
122bool
123IntegratorPseudoTransientAdjointSensitivity<Scalar>::
124advanceTime(const Scalar timeFinal)
125{
126 TEMPUS_FUNC_TIME_MONITOR_DIFF("Tempus::IntegratorPseudoTransientAdjointSensitivity::advanceTime()", TEMPUS_PTAS_AT);
127
128 using Teuchos::RCP;
129 using Thyra::VectorBase;
130 typedef Thyra::ModelEvaluatorBase MEB;
131
132 bool state_status = true;
133 if (do_forward_integration_) {
134 TEMPUS_FUNC_TIME_MONITOR_DIFF("Tempus::IntegratorPseudoTransientAdjointSensitivity::advanceTime::state", TEMPUS_PTAS_AT_FWD);
135
136 // Run state integrator and get solution
137 stepMode_ = SensitivityStepMode::Forward;
138 state_status = state_integrator_->advanceTime(timeFinal);
139 }
140
141 bool sens_status = true;
142 if (do_adjoint_integration_) {
143 TEMPUS_FUNC_TIME_MONITOR_DIFF("Tempus::IntegratorPseudoTransientAdjointSensitivity::advanceTime::adjoint", TEMPUS_PTAS_AT_ADJ);
144
145 // For at least some time-stepping methods, the time of the last time step
146 // may not be timeFinal (e.g., it may be greater by at most delta_t).
147 // But since the adjoint model requires timeFinal in its formulation, reset
148 // it to the achieved final time.
149 sens_model_->setFinalTime(state_integrator_->getTime());
150
151 // Set solution in sensitivity ME
152 sens_model_->setForwardSolutionHistory(
153 state_integrator_->getSolutionHistory());
154
155 // Run sensitivity integrator
156 stepMode_ = SensitivityStepMode::Adjoint;
157 sens_status = sens_integrator_->advanceTime(timeFinal);
158
159 // Compute final dg/dp, g which is computed by response 0, 1 of the adjoint
160 // model evaluator
161 MEB::InArgs<Scalar> inargs = sens_model_->getNominalValues();
162 MEB::OutArgs<Scalar> outargs = sens_model_->createOutArgs();
163 inargs.set_t(sens_integrator_->getTime());
164 inargs.set_x(sens_integrator_->getX());
165 if (inargs.supports(MEB::IN_ARG_x_dot))
166 inargs.set_x_dot(sens_integrator_->getXDot());
167 if (inargs.supports(MEB::IN_ARG_x_dot_dot))
168 inargs.set_x_dot_dot(sens_integrator_->getXDotDot());
169 RCP<VectorBase<Scalar> > G = dgdp_;
170 if (G == Teuchos::null) {
171 G = Thyra::createMember(sens_model_->get_g_space(0));
172 dgdp_ = Teuchos::rcp_dynamic_cast<DMVPV>(G);
173 }
174 if (g_ == Teuchos::null)
175 g_ = Thyra::createMember(sens_model_->get_g_space(1));
176 outargs.set_g(0, G);
177 outargs.set_g(1, g_);
178 sens_model_->evalModel(inargs, outargs);
179
180 buildSolutionHistory();
181 }
182
183 return state_status && sens_status;
184}
185
186template<class Scalar>
187Scalar
188IntegratorPseudoTransientAdjointSensitivity<Scalar>::
189getTime() const
190{
191 return solutionHistory_->getCurrentTime();
192}
193
194template<class Scalar>
195int
196IntegratorPseudoTransientAdjointSensitivity<Scalar>::
197getIndex() const
198{
199 return solutionHistory_->getCurrentIndex();
200}
201
202template<class Scalar>
203Status
204IntegratorPseudoTransientAdjointSensitivity<Scalar>::
205getStatus() const
206{
207 Status state_status = state_integrator_->getStatus();
208 Status sens_status = sens_integrator_->getStatus();
209 if (state_status == FAILED || sens_status == FAILED)
210 return FAILED;
211 if (state_status == WORKING || sens_status == WORKING)
212 return WORKING;
213 return PASSED;
214}
215
216template <class Scalar>
217void IntegratorPseudoTransientAdjointSensitivity<Scalar>::setStatus(
218 const Status st) {
219 state_integrator_->setStatus(st);
220 sens_integrator_->setStatus(st);
221}
222
223template<class Scalar>
224Teuchos::RCP<Stepper<Scalar> >
230
231template<class Scalar>
232Teuchos::RCP<Stepper<Scalar> >
238
239template<class Scalar>
240Teuchos::RCP<Stepper<Scalar> >
246
247template<class Scalar>
248Teuchos::RCP<const SolutionHistory<Scalar> >
254
255template<class Scalar>
256Teuchos::RCP<const SolutionHistory<Scalar> >
262
263template<class Scalar>
264Teuchos::RCP<const SolutionHistory<Scalar> >
270
271template<class Scalar>
272Teuchos::RCP<SolutionHistory<Scalar> >
278
279template<class Scalar>
280Teuchos::RCP<const TimeStepControl<Scalar> >
286
287template<class Scalar>
288Teuchos::RCP<TimeStepControl<Scalar> >
294
295template<class Scalar>
296Teuchos::RCP<TimeStepControl<Scalar> >
302
303template<class Scalar>
304Teuchos::RCP<TimeStepControl<Scalar> >
310
311template<class Scalar>
312Teuchos::RCP<IntegratorObserver<Scalar> >
318
319template<class Scalar>
320void
327
328template<class Scalar>
329void IntegratorPseudoTransientAdjointSensitivity<Scalar>::
330initializeSolutionHistory(Scalar t0,
331 Teuchos::RCP<const Thyra::VectorBase<Scalar> > x0,
332 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdot0,
333 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xdotdot0,
334 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > y0,
335 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > ydot0,
336 Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > ydotdot0)
337{
338 using Teuchos::RCP;
339 using Teuchos::rcp_dynamic_cast;
340 using Thyra::VectorSpaceBase;
341 using Thyra::assign;
342 using Thyra::createMember;
343
344 //
345 // Create and initialize product X, Xdot, Xdotdot
346
347 RCP< const VectorSpaceBase<Scalar> > space = sens_model_->get_x_space();
348 RCP<DMVPV> Y = rcp_dynamic_cast<DMVPV>(createMember(space));
349 RCP<DMVPV> Ydot = rcp_dynamic_cast<DMVPV>(createMember(space));
350 RCP<DMVPV> Ydotdot = rcp_dynamic_cast<DMVPV>(createMember(space));
351 const Scalar zero = Teuchos::ScalarTraits<Scalar>::zero();
352
353 // y
354 if (y0 == Teuchos::null)
355 assign(Y->getNonconstMultiVector().ptr(), zero);
356 else
357 assign(Y->getNonconstMultiVector().ptr(), *y0);
358
359 // ydot
360 if (ydot0 == Teuchos::null)
361 assign(Ydot->getNonconstMultiVector().ptr(), zero);
362 else
363 assign(Ydot->getNonconstMultiVector().ptr(), *ydot0);
364
365 // ydotdot
366 if (ydotdot0 == Teuchos::null)
367 assign(Ydotdot->getNonconstMultiVector().ptr(), zero);
368 else
369 assign(Ydotdot->getNonconstMultiVector().ptr(), *ydotdot0);
370
371 state_integrator_->initializeSolutionHistory(t0, x0, xdot0, xdotdot0);
372 sens_integrator_->initializeSolutionHistory(t0, Y, Ydot, Ydotdot);
373}
374
375template<class Scalar>
376Teuchos::RCP<const Thyra::VectorBase<Scalar> >
382
383template<class Scalar>
384Teuchos::RCP<const Thyra::VectorBase<Scalar> >
390
391template<class Scalar>
392Teuchos::RCP<const Thyra::VectorBase<Scalar> >
398
399template<class Scalar>
400Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
401IntegratorPseudoTransientAdjointSensitivity<Scalar>::
402getY() const
403{
404 using Teuchos::RCP;
405 using Teuchos::rcp_dynamic_cast;
406 RCP<const DMVPV> mvpv =
407 rcp_dynamic_cast<const DMVPV>(sens_integrator_->getX());
408 return mvpv->getMultiVector();
409}
410
411template<class Scalar>
412Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
413IntegratorPseudoTransientAdjointSensitivity<Scalar>::
414getYDot() const
415{
416 using Teuchos::RCP;
417 using Teuchos::rcp_dynamic_cast;
418 RCP<const DMVPV> mvpv =
419 rcp_dynamic_cast<const DMVPV>(sens_integrator_->getXDot());
420 return mvpv->getMultiVector();
421}
422
423template<class Scalar>
424Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
425IntegratorPseudoTransientAdjointSensitivity<Scalar>::
426getYDotDot() const
427{
428 using Teuchos::RCP;
429 using Teuchos::rcp_dynamic_cast;
430 RCP<const DMVPV> mvpv =
431 rcp_dynamic_cast<const DMVPV>(sens_integrator_->getXDotDot());
432 return mvpv->getMultiVector();
433}
434
435template<class Scalar>
436Teuchos::RCP<const Thyra::VectorBase<Scalar> >
442
443template<class Scalar>
444Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> >
445IntegratorPseudoTransientAdjointSensitivity<Scalar>::
446getDgDp() const
447{
448 return dgdp_->getMultiVector();
449}
450
451template<class Scalar>
452std::string
453IntegratorPseudoTransientAdjointSensitivity<Scalar>::
454description() const
455{
456 std::string name = "Tempus::IntegratorPseudoTransientAdjointSensitivity";
457 return(name);
458}
459
460template<class Scalar>
461void
462IntegratorPseudoTransientAdjointSensitivity<Scalar>::
463describe(
464 Teuchos::FancyOStream &out,
465 const Teuchos::EVerbosityLevel verbLevel) const
466{
467 auto l_out = Teuchos::fancyOStream( out.getOStream() );
468 Teuchos::OSTab ostab(*l_out, 2, this->description());
469 l_out->setOutputToRootOnly(0);
470
471 *l_out << description() << "::describe" << std::endl;
472 state_integrator_->describe(*l_out, verbLevel);
473 sens_integrator_->describe(*l_out, verbLevel);
474}
475
476template<class Scalar>
477void
478IntegratorPseudoTransientAdjointSensitivity<Scalar>::
479setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & inputPL)
480{
481 // IntegratorBasic is no longer a Teuchos::ParameterListAcceptor.
482 // Since setting the ParameterList is essentially a complete reset,
483 // we will rebuild from scratch and reuse the ModelEvaluator.
484 auto model = Teuchos::rcp_const_cast<Thyra::ModelEvaluator<Scalar>> (
485 state_integrator_->getStepper()->getModel());
486 auto tmp_state_integrator = createIntegratorBasic<Scalar>(inputPL, model);
487 state_integrator_->copy(tmp_state_integrator);
488
489 model = Teuchos::rcp_const_cast<Thyra::ModelEvaluator<Scalar>> (
490 sens_integrator_->getStepper()->getModel());
491 auto tmp_sens_integrator = createIntegratorBasic<Scalar>(inputPL, model);
492 sens_integrator_->copy(tmp_sens_integrator);
493}
494
495template<class Scalar>
496Teuchos::RCP<Teuchos::ParameterList>
497IntegratorPseudoTransientAdjointSensitivity<Scalar>::
498unsetParameterList()
499{
500 // IntegratorBasic is no longer a Teuchos::ParameterListAcceptor.
501 // We will treat unsetting the ParameterList as a reset to default
502 // settings, and reuse the ModelEvaluator.
503 auto tmp_state_integrator = createIntegratorBasic<Scalar>();
504 auto model = state_integrator_->getStepper()->getModel();
505 tmp_state_integrator->setModel(model);
506 state_integrator_->copy(tmp_state_integrator);
507
508 auto tmp_sens_integrator = createIntegratorBasic<Scalar>();
509 model = sens_integrator_->getStepper()->getModel();
510 tmp_sens_integrator->setModel(model);
511 sens_integrator_->copy(tmp_sens_integrator);
512
513 auto pl = Teuchos::rcp_const_cast<Teuchos::ParameterList> (
514 sens_integrator_->getValidParameters());
515 return pl;
516}
517
518template<class Scalar>
519Teuchos::RCP<const Teuchos::ParameterList>
520IntegratorPseudoTransientAdjointSensitivity<Scalar>::
521getValidParameters() const
522{
523 Teuchos::RCP<Teuchos::ParameterList> pl =
524 Teuchos::rcp(new Teuchos::ParameterList);
525 Teuchos::RCP<const Teuchos::ParameterList> integrator_pl =
526 state_integrator_->getValidParameters();
527 Teuchos::RCP<const Teuchos::ParameterList> sensitivity_pl =
528 AdjointSensitivityModelEvaluator<Scalar>::getValidParameters();
529 pl->setParameters(*integrator_pl);
530 pl->sublist("Sensitivities").setParameters(*sensitivity_pl);
531
532 return pl;
533}
534
535template<class Scalar>
536Teuchos::RCP<Teuchos::ParameterList>
537IntegratorPseudoTransientAdjointSensitivity<Scalar>::
538getNonconstParameterList()
539{
540 auto pl = Teuchos::rcp_const_cast<Teuchos::ParameterList> (
541 state_integrator_->getValidParameters());
542 return pl;
543}
544
545template<class Scalar>
546SensitivityStepMode
552
553template <class Scalar>
554Teuchos::RCP<AdjointSensitivityModelEvaluator<Scalar> >
555IntegratorPseudoTransientAdjointSensitivity<Scalar>::
556createSensitivityModel(
557 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
558 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
559 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
560 const Teuchos::RCP<Teuchos::ParameterList>& inputPL)
561{
562 using Teuchos::rcp;
563
564 Teuchos::RCP<Teuchos::ParameterList> pl = Teuchos::parameterList();
565 if (inputPL != Teuchos::null) {
566 *pl = inputPL->sublist("Sensitivities");
567 }
568 const Scalar tinit = state_integrator_->getTimeStepControl()->getInitTime();
569 const Scalar tfinal = state_integrator_->getTimeStepControl()->getFinalTime();
570 return rcp(new AdjointSensitivityModelEvaluator<Scalar>(
571 model, adjoint_residual_model, adjoint_solve_model_,
572 tinit, tfinal, true, pl));
573}
574
575template<class Scalar>
576void
577IntegratorPseudoTransientAdjointSensitivity<Scalar>::
578buildSolutionHistory()
579{
580 using Teuchos::RCP;
581 using Teuchos::rcp;
582 using Teuchos::rcp_dynamic_cast;
583 using Teuchos::ParameterList;
584 using Thyra::VectorBase;
585 using Thyra::VectorSpaceBase;
586 using Thyra::assign;
587 using Thyra::defaultProductVector;
588 typedef Thyra::DefaultProductVector<Scalar> DPV;
589 typedef Thyra::DefaultProductVectorSpace<Scalar> DPVS;
590
591 // Create combined solution histories, first for the states with zero
592 // adjoint and then for the adjoint with frozen states
593 auto shPL = Teuchos::rcp_const_cast<Teuchos::ParameterList> (
594 state_integrator_->getSolutionHistory()->getValidParameters());
595 solutionHistory_ = createSolutionHistoryPL<Scalar>(shPL);
596
597 RCP<const VectorSpaceBase<Scalar> > x_space =
598 model_->get_x_space();
599 RCP<const VectorSpaceBase<Scalar> > adjoint_space =
600 sens_model_->get_x_space();
601 Teuchos::Array< RCP<const VectorSpaceBase<Scalar> > > spaces(2);
602 spaces[0] = x_space;
603 spaces[1] = adjoint_space;
604 RCP<const DPVS > prod_space = Thyra::productVectorSpace(spaces());
605 const Scalar zero = Teuchos::ScalarTraits<Scalar>::zero();
606
607 RCP<const SolutionHistory<Scalar> > state_solution_history =
608 state_integrator_->getSolutionHistory();
609 int num_states = state_solution_history->getNumStates();
610 for (int i=0; i<num_states; ++i) {
611 RCP<const SolutionState<Scalar> > state = (*state_solution_history)[i];
612
613 // X
614 RCP<DPV> x = defaultProductVector(prod_space);
615 assign(x->getNonconstVectorBlock(0).ptr(), *(state->getX()));
616 assign(x->getNonconstVectorBlock(1).ptr(), zero);
617 RCP<VectorBase<Scalar> > x_b = x;
618
619 // X-Dot
620 RCP<VectorBase<Scalar> > x_dot_b;
621 if (state->getXDot() != Teuchos::null) {
622 RCP<DPV> x_dot = defaultProductVector(prod_space);
623 assign(x_dot->getNonconstVectorBlock(0).ptr(), *(state->getXDot()));
624 assign(x_dot->getNonconstVectorBlock(1).ptr(), zero);
625 x_dot_b = x_dot;
626 }
627
628 // X-Dot-Dot
629 RCP<VectorBase<Scalar> > x_dot_dot_b;
630 if (state->getXDotDot() != Teuchos::null) {
631 RCP<DPV> x_dot_dot = defaultProductVector(prod_space);
632 assign(x_dot_dot->getNonconstVectorBlock(0).ptr(),*(state->getXDotDot()));
633 assign(x_dot_dot->getNonconstVectorBlock(1).ptr(), zero);
634 x_dot_dot_b = x_dot_dot;
635 }
636
637 RCP<SolutionState<Scalar> > prod_state = state->clone();
638 prod_state->setX(x_b);
639 prod_state->setXDot(x_dot_b);
640 prod_state->setXDotDot(x_dot_dot_b);
641 solutionHistory_->addState(prod_state);
642 }
643
644 RCP<const VectorBase<Scalar> > frozen_x =
645 state_solution_history->getCurrentState()->getX();
646 RCP<const VectorBase<Scalar> > frozen_x_dot =
647 state_solution_history->getCurrentState()->getXDot();
648 RCP<const VectorBase<Scalar> > frozen_x_dot_dot =
649 state_solution_history->getCurrentState()->getXDotDot();
650 RCP<const SolutionHistory<Scalar> > sens_solution_history =
651 sens_integrator_->getSolutionHistory();
652 num_states = sens_solution_history->getNumStates();
653 for (int i=0; i<num_states; ++i) {
654 RCP<const SolutionState<Scalar> > state = (*sens_solution_history)[i];
655
656 // X
657 RCP<DPV> x = defaultProductVector(prod_space);
658 assign(x->getNonconstVectorBlock(0).ptr(), *frozen_x);
659 assign(x->getNonconstVectorBlock(1).ptr(), *(state->getX()));
660 RCP<VectorBase<Scalar> > x_b = x;
661
662 // X-Dot
663 RCP<VectorBase<Scalar> > x_dot_b;
664 if (state->getXDot() != Teuchos::null) {
665 RCP<DPV> x_dot = defaultProductVector(prod_space);
666 assign(x_dot->getNonconstVectorBlock(0).ptr(), *frozen_x_dot);
667 assign(x_dot->getNonconstVectorBlock(1).ptr(), *(state->getXDot()));
668 x_dot_b = x_dot;
669 }
670
671 // X-Dot-Dot
672 RCP<VectorBase<Scalar> > x_dot_dot_b;
673 if (state->getXDotDot() != Teuchos::null) {
674 RCP<DPV> x_dot_dot = defaultProductVector(prod_space);
675 assign(x_dot_dot->getNonconstVectorBlock(0).ptr(), *frozen_x_dot_dot);
676 assign(x_dot_dot->getNonconstVectorBlock(1).ptr(),*(state->getXDotDot()));
677 x_dot_dot_b = x_dot_dot;
678 }
679
680 RCP<SolutionState<Scalar> > prod_state = state->clone();
681 prod_state->setX(x_b);
682 prod_state->setXDot(x_dot_b);
683 prod_state->setXDotDot(x_dot_dot_b);
684 solutionHistory_->addState(prod_state, false);
685 }
686}
687
689template<class Scalar>
690Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
691integratorPseudoTransientAdjointSensitivity(
692 Teuchos::RCP<Teuchos::ParameterList> pList,
693 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model)
694{
695 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
696 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(pList, model));
697 return(integrator);
698}
699
701template<class Scalar>
702Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
703integratorPseudoTransientAdjointSensitivity(
704 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
705 std::string stepperType)
706{
707 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
708 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(model, stepperType));
709 return(integrator);
710}
711
713template<class Scalar>
714Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
715integratorPseudoTransientAdjointSensitivity(
716 Teuchos::RCP<Teuchos::ParameterList> pList,
717 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
718 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model)
719{
720 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
721 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(pList, model, adjoint_model));
722 return(integrator);
723}
724
726template<class Scalar>
727Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
728integratorPseudoTransientAdjointSensitivity(
729 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
730 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_model,
731 std::string stepperType)
732{
733 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
734 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(model, adjoint_model, stepperType));
735 return(integrator);
736}
737
739template<class Scalar>
740Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
741integratorPseudoTransientAdjointSensitivity(
742 Teuchos::RCP<Teuchos::ParameterList> pList,
743 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
744 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
745 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model)
746{
747 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
748 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(pList, model, adjoint_residual_model, adjoint_solve_model));
749 return(integrator);
750}
751
753template<class Scalar>
754Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
755integratorPseudoTransientAdjointSensitivity(
756 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& model,
757 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_residual_model,
758 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& adjoint_solve_model,
759 std::string stepperType)
760{
761 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
762 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>(model, adjoint_residual_model, adjoint_solve_model, stepperType));
763 return(integrator);
764}
765
767template<class Scalar>
768Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> >
769integratorPseudoTransientAdjointSensitivity()
770{
771 Teuchos::RCP<IntegratorPseudoTransientAdjointSensitivity<Scalar> > integrator =
772 Teuchos::rcp(new IntegratorPseudoTransientAdjointSensitivity<Scalar>());
773 return(integrator);
774}
775
776} // namespace Tempus
777#endif // Tempus_IntegratorPseudoTransientAdjointSensitivity_impl_hpp
Thyra_ImplicitAdjointModelEvaluator.hpp
Tempus::AdjointSensitivityModelEvaluator
ModelEvaluator for forming adjoint sensitivity equations.
Definition Tempus_AdjointSensitivityModelEvaluator_decl.hpp:55
Tempus::AdjointSensitivityModelEvaluator::getValidParameters
static Teuchos::RCP< const Teuchos::ParameterList > getValidParameters()
Definition Tempus_AdjointSensitivityModelEvaluator_impl.hpp:555
Tempus::IntegratorObserver
IntegratorObserver class for time integrators.
Definition Tempus_IntegratorObserver.hpp:43
Tempus::IntegratorPseudoTransientAdjointSensitivity
Time integrator suitable for pseudotransient adjoint sensitivity analysis.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_decl.hpp:63
Tempus::IntegratorPseudoTransientAdjointSensitivity::getNonConstSolutionHistory
virtual Teuchos::RCP< SolutionHistory< Scalar > > getNonConstSolutionHistory() override
Get the SolutionHistory.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:274
Tempus::IntegratorPseudoTransientAdjointSensitivity::getY
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getY() const
Get the current adjoint solution, y.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:402
Tempus::IntegratorPseudoTransientAdjointSensitivity::getStepMode
SensitivityStepMode getStepMode() const
What mode the current time integration step is in.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:548
Tempus::IntegratorPseudoTransientAdjointSensitivity::getYDot
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getYDot() const
Get the current time derivative of the adjoint solution, ydot.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:414
Tempus::IntegratorPseudoTransientAdjointSensitivity::createSensitivityModel
Teuchos::RCP< AdjointSensitivityModelEvaluator< Scalar > > createSensitivityModel(const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjoint_residual_model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjoint_solve_model, const Teuchos::RCP< Teuchos::ParameterList > &inputPL)
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:556
Tempus::IntegratorPseudoTransientAdjointSensitivity::getXDotDot
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDotDot() const
Get the current second time derivative of the solution, xdotdot.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:394
Tempus::IntegratorPseudoTransientAdjointSensitivity::getStepper
virtual Teuchos::RCP< Stepper< Scalar > > getStepper() const override
Get the Stepper.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:226
Tempus::IntegratorPseudoTransientAdjointSensitivity::getTimeStepControl
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const override
Get the TimeStepControl.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:282
Tempus::IntegratorPseudoTransientAdjointSensitivity::getG
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getG() const
Return response function g.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:438
Tempus::IntegratorPseudoTransientAdjointSensitivity::setObserver
virtual void setObserver(Teuchos::RCP< IntegratorObserver< Scalar > > obs=Teuchos::null)
Set the Observer.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:322
Tempus::IntegratorPseudoTransientAdjointSensitivity::getSolutionHistory
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const override
Get the SolutionHistory.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:250
Tempus::IntegratorPseudoTransientAdjointSensitivity::getObserver
virtual Teuchos::RCP< IntegratorObserver< Scalar > > getObserver()
Get the Observer.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:314
Tempus::IntegratorPseudoTransientAdjointSensitivity::IntegratorPseudoTransientAdjointSensitivity
IntegratorPseudoTransientAdjointSensitivity(Teuchos::RCP< Teuchos::ParameterList > pList, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjoint_residual_model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjoint_solve_model)
Constructor with ParameterList and model, and will be fully initialized.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:22
Tempus::IntegratorPseudoTransientAdjointSensitivity::initializeSolutionHistory
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 > > y0=Teuchos::null, Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > ydot0=Teuchos::null, Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > ydotdot0=Teuchos::null)
Set the initial state from Thyra::VectorBase(s).
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:330
Tempus::IntegratorPseudoTransientAdjointSensitivity::getXDot
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getXDot() const
Get the current time derivative of the solution, xdot.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:386
Tempus::IntegratorPseudoTransientAdjointSensitivity::setParameterList
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &pl) override
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:479
Tempus::IntegratorPseudoTransientAdjointSensitivity::getDgDp
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getDgDp() const
Return adjoint sensitivity stored in gradient format.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:446
Tempus::IntegratorPseudoTransientAdjointSensitivity::getNonConstTimeStepControl
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl() override
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:290
Tempus::IntegratorPseudoTransientAdjointSensitivity::getX
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > getX() const
Get the current solution, x.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:378
Tempus::IntegratorPseudoTransientAdjointSensitivity::getYDotDot
virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > getYDotDot() const
Get the current second time derivative of the adjoint solution, ydotdot.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:426
Tempus::IntegratorPseudoTransientAdjointSensitivity::describe
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:463
Tempus::IntegratorPseudoTransientAdjointSensitivity::advanceTime
virtual bool advanceTime()
Advance the solution to timeMax, and return true if successful.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:114
Tempus::IntegratorPseudoTransientAdjointSensitivity::getValidParameters
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:521
Tempus::Status
Status
Status for the Integrator, the Stepper and the SolutionState.
Definition Tempus_Types.hpp:19
Tempus::createSolutionHistoryPL
Teuchos::RCP< SolutionHistory< Scalar > > createSolutionHistoryPL(Teuchos::RCP< Teuchos::ParameterList > pList)
Nonmember constructor from a ParameterList.
Definition Tempus_SolutionHistory_impl.hpp:706
Tempus::createIntegratorBasic
Teuchos::RCP< IntegratorBasic< Scalar > > createIntegratorBasic()
Nonmember constructor.
Definition Tempus_IntegratorBasic_impl.hpp:730
Tempus::integratorPseudoTransientAdjointSensitivity
Teuchos::RCP< Tempus::IntegratorPseudoTransientAdjointSensitivity< Scalar > > integratorPseudoTransientAdjointSensitivity()
Nonmember constructor.
Definition Tempus_IntegratorPseudoTransientAdjointSensitivity_impl.hpp:769
Generated by doxygen 1.17.0