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