Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperNewmarkImplicitAFormModifierXBase.hpp
Go to the documentation of this file.
1 //@HEADER
2 // *****************************************************************************
3 // Tempus: Time Integration and Sensitivity Analysis Package
4 //
5 // Copyright 2017 NTESS and the Tempus contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 //@HEADER
9 
10 #ifndef Tempus_StepperNewmarkImplicitAFormModifierXBase_hpp
11 #define Tempus_StepperNewmarkImplicitAFormModifierXBase_hpp
12 
13 #include "Tempus_config.hpp"
14 #include "Tempus_SolutionHistory.hpp"
16 
17 namespace Tempus {
18 
36 template <class Scalar>
38  : virtual public Tempus::StepperNewmarkImplicitAFormAppAction<Scalar> {
39  private:
40  /* \brief Adaptor execute function
41  *
42  * This is an adaptor function to bridge between the AppAction
43  * interface and the ModifierX interface. It is meant to be private
44  * and non-virtual as deriving from this class should only need to
45  * implement the modify function.
46  *
47  * For the ModifierX interface, this adaptor maps the
48  * StepperNewmarkImplicitAFormAppAction::ACTION_LOCATION to the
49  * StepperNewmarkImplicitAFormModifierX::MODIFIERX_TYPE, and only pass the
50  * solution
51  * (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
52  * function.
53  */
57  Scalar>::ACTION_LOCATION actLoc)
58  {
59  using Teuchos::RCP;
60 
61  MODIFIER_TYPE modType = X_BEGIN_STEP;
62  RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
63  const Scalar time = workingState->getTime();
64  const Scalar dt = workingState->getTimeStep();
65  RCP<Thyra::VectorBase<Scalar> > x;
66 
67  switch (actLoc) {
69  modType = X_BEGIN_STEP;
70  x = workingState->getX();
71  break;
72  }
74  modType = X_BEFORE_SOLVE;
75  x = workingState->getX();
76  break;
77  }
79  modType = X_AFTER_SOLVE;
80  x = workingState->getX();
81  break;
82  }
84  modType = X_END_STEP;
85  x = workingState->getX();
86  break;
87  }
88  default:
89  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
90  "Error - unknown action location.\n");
91  }
92 
93  this->modify(x, time, dt, modType);
94  }
95 
96  public:
103  };
104 
106  virtual void modify(Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
107  const Scalar /* time */, const Scalar /* dt */,
108  const MODIFIER_TYPE modType) = 0;
109 };
110 
111 } // namespace Tempus
112 
113 #endif // Tempus_StepperNewmarkImplicitAFormModifierXBase_hpp
Application Action for StepperNewmarkImplicitAForm.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperNewmarkImplicitAForm< Scalar > > stepper, const typename StepperNewmarkImplicitAFormAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for NewmarkImplicitAForm Stepper.
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).
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
ACTION_LOCATION
Indicates the location of application action (see algorithm).
Newmark time stepper in acceleration form (a-form).