Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 namespace Tempus {
17 
36 template <class Scalar>
38  : virtual public Tempus::StepperBDF2AppAction<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  * StepperBDF2AppAction::ACTION_LOCATION to the
49  * StepperBDF2ModifierX::MODIFIERX_TYPE, and only pass the solution
50  * (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
51  * function.
52  */
53  void execute(
57  {
58  using Teuchos::RCP;
59 
60  MODIFIER_TYPE modType = X_BEGIN_STEP;
61  RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
62  const Scalar time = workingState->getTime();
63  const Scalar dt = workingState->getTimeStep();
64  RCP<Thyra::VectorBase<Scalar> > x;
65 
66  switch (actLoc) {
68  modType = X_BEGIN_STEP;
69  x = workingState->getX();
70  break;
71  }
73  modType = X_BEFORE_SOLVE;
74  x = workingState->getX();
75  break;
76  }
78  modType = X_AFTER_SOLVE;
79  x = workingState->getX();
80  break;
81  }
83  modType = X_END_STEP;
84  x = workingState->getX();
85  break;
86  }
87  default:
88  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
89  "Error - unknown action location.\n");
90  }
91 
92  this->modify(x, time, dt, modType);
93  }
94 
95  public:
102  };
103 
105  virtual void modify(Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */,
106  const Scalar /* time */, const Scalar /* dt */,
107  const MODIFIER_TYPE modType) = 0;
108 };
109 
110 } // namespace Tempus
111 
112 #endif // Tempus_StepperBDF2ModifierXBase_hpp
BDF2 (Backward-Difference-Formula-2) time stepper.
ACTION_LOCATION
Indicates the location of application action (see algorithm).
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual void modify(Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
Modify solution based on the MODIFIER_TYPE.
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.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Application Action for StepperBDF2.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).