Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperForwardEulerModifierXBase.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_StepperForwardEulerModifierXBase_hpp
10#define Tempus_StepperForwardEulerModifierXBase_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_SolutionHistory.hpp"
15
16
17namespace Tempus {
18
37template<class Scalar>
39 : virtual public Tempus::StepperForwardEulerAppAction<Scalar>
40{
41private:
42
43 /* \brief Adaptor execute function
44 *
45 * This is an adaptor function to bridge between the AppAction
46 * interface and the ModifierX interface. It is meant to be private
47 * and non-virtual as deriving from this class should only need to
48 * implement the modify function.
49 *
50 * For the ModifierX interface, this adaptor maps the
51 * StepperForwardEulerAppAction::ACTION_LOCATION to the
52 * StepperForwardEulerModifierX::MODIFIERX_TYPE, and only pass the solution
53 * (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
54 * function.
55 */
56 void execute(
57 Teuchos::RCP<SolutionHistory<Scalar> > sh,
58 Teuchos::RCP<StepperForwardEuler<Scalar> > stepper,
60 {
61 using Teuchos::RCP;
62
64 RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
65 const Scalar time = workingState->getTime();
66 const Scalar dt = workingState->getTimeStep();
67 RCP<Thyra::VectorBase<Scalar> > x;
68
69 switch(actLoc) {
71 {
72 modType = X_BEGIN_STEP;
73 x = workingState->getX();
74 break;
75 }
77 {
78 modType = X_BEFORE_EXPLICIT_EVAL;
79 x = workingState->getX();
80 break;
81 }
83 {
84 modType = XDOT_END_STEP;
85 if (workingState->getXDot() != Teuchos::null)
86 x = workingState->getXDot();
87 else
88 x = stepper->getStepperXDot();
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
106 };
107
109 virtual void modify(
110 Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
111 const Scalar /* time */, const Scalar /* dt */,
112 const MODIFIER_TYPE modType) = 0;
113
114};
115
116} // namespace Tempus
117
118#endif // Tempus_StepperForwardEulerModifierXBase_hpp
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Application Action for StepperForwardEuler.
ACTION_LOCATION
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.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperForwardEuler< Scalar > > stepper, const typename StepperForwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for ForwardEuler Stepper.