Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperHHTAlphaModifierXBase.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_StepperHHTAlphaModifierXBase_hpp
10#define Tempus_StepperHHTAlphaModifierXBase_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_SolutionHistory.hpp"
15
16
17namespace Tempus {
18
31template<class Scalar>
33 : virtual public Tempus::StepperHHTAlphaAppAction<Scalar>
34{
35private:
36
37 /* \brief Adaptor execute function
38 *
39 * This is an adaptor function to bridge between the AppAction
40 * interface and the ModifierX interface. It is meant to be private
41 * and non-virtual as deriving from this class should only need to
42 * implement the modify function.
43 *
44 * For the ModifierX interface, this adaptor maps the
45 * StepperHHTAlphaAppAction::ACTION_LOCATION to the
46 * StepperHHTAlphaModifierX::MODIFIERX_TYPE, and only pass the solution
47 * (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
48 * function.
49 */
50 void execute(
51 Teuchos::RCP<SolutionHistory<Scalar> > sh,
52 Teuchos::RCP<StepperHHTAlpha<Scalar> > stepper,
54 {
55 using Teuchos::RCP;
56
58 RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
59 const Scalar time = workingState->getTime();
60 const Scalar dt = workingState->getTimeStep();
61 RCP<Thyra::VectorBase<Scalar> > x;
62
63 switch(actLoc) {
65 {
66 modType = X_BEGIN_STEP;
67 x = workingState->getX();
68 break;
69 }
71 {
72 modType = X_BEFORE_SOLVE;
73 x = workingState->getX();
74 break;
75 }
77 {
78 modType = X_AFTER_SOLVE;
79 x = workingState->getX();
80 break;
81 }
83 {
84 modType = X_END_STEP;
85 if (workingState->getX() != Teuchos::null)
86 x = workingState->getX();
87 else
88 x = stepper->getStepperX();
89 break;
90 }
91 default:
92 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
93 "Error - unknown action location.\n");
94 }
95
96 this->modify(x, time, dt, modType);
97 }
98
99public:
100
108
110 virtual void modify(
111 Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
112 const Scalar /* time */, const Scalar /* dt */,
113 const MODIFIER_TYPE modType) = 0;
114
115};
116
117} // namespace Tempus
118
119#endif // Tempus_StepperHHTAlphaModifierXBase_hpp
ACTION_LOCATION
Indicates the location of application action (see algorithm).
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperHHTAlpha< Scalar > > stepper, const typename StepperHHTAlphaAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for HHTAlpha Stepper.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).
virtual void modify(Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
Modify solution based on the MODIFIER_TYPE.