Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperBDF2ModifierXBase.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_StepperBDF2ModifierXBase_hpp
10#define Tempus_StepperBDF2ModifierXBase_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_SolutionHistory.hpp"
15
16
17namespace Tempus {
18
37template<class Scalar>
39 : virtual public Tempus::StepperBDF2AppAction<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 * StepperBDF2AppAction::ACTION_LOCATION to the
52 * StepperBDF2ModifierX::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<StepperBDF2<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_SOLVE;
79 x = workingState->getX();
80 break;
81 }
83 {
84 modType = X_AFTER_SOLVE;
85 x = workingState->getX();
86 break;
87 }
89 {
90 modType = X_END_STEP;
91 x = workingState->getX();
92 break;
93 }
94 default:
95 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
96 "Error - unknown action location.\n");
97 }
98
99 this->modify(x, time, dt, modType);
100 }
101
102public:
103
110 };
111
113 virtual void modify(
114 Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
115 const Scalar /* time */, const Scalar /* dt */,
116 const MODIFIER_TYPE modType) = 0;
117
118};
119
120} // namespace Tempus
121
122#endif // Tempus_StepperBDF2ModifierXBase_hpp
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Application Action for StepperBDF2.
ACTION_LOCATION
Indicates the location of application action (see algorithm).
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBDF2< Scalar > > stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for BDF2 Stepper.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).
@ X_AFTER_SOLVE
Modify after the implicit solve.
@ X_BEFORE_SOLVE
Modify before the implicit solve.
@ X_BEGIN_STEP
Modify at the beginning of the step.
virtual void modify(Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
Modify solution based on the MODIFIER_TYPE.
BDF2 (Backward-Difference-Formula-2) time stepper.