Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperRKModifierDefault.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_StepperRKModifierDefault_hpp
10 #define Tempus_StepperRKModifierDefault_hpp
11 
12 #include "Tempus_config.hpp"
14 
15 // Applications can uncomment this include in their implementation,
16 // if they need access to the stepper methods.
17 //#include "Tempus_StepperRKBase.hpp"
18 
19 namespace Tempus {
20 
29 template <class Scalar>
31  : virtual public Tempus::StepperRKModifierBase<Scalar> {
32  public:
35 
38 
40  virtual void modify(
42  Teuchos::RCP<StepperRKBase<Scalar> > /* stepper */,
43  const typename StepperRKAppAction<Scalar>::ACTION_LOCATION actLoc)
44  {
45  switch (actLoc) {
53  // No-op.
54  break;
55  }
56  default:
58  true, std::logic_error,
59  "Error - unknown action location = " + std::to_string(actLoc) +
60  "\n"
61  " Valid actions are\n"
62  " StepperRKAppAction<Scalar>::BEGIN_STEP = " +
64  "\n"
65  " StepperRKAppAction<Scalar>::BEGIN_STAGE = " +
67  "\n"
68  " StepperRKAppAction<Scalar>::BEFORE_SOLVE = " +
70  "\n"
71  " StepperRKAppAction<Scalar>::AFTER_SOLVE = " +
73  "\n"
74  " StepperRKAppAction<Scalar>::BEFORE_EXPLICIT_EVAL = " +
75  std::to_string(
77  "\n"
78  " StepperRKAppAction<Scalar>::END_STAGE = " +
80  "\n"
81  " StepperRKAppAction<Scalar>::END_STEP = " +
82  std::to_string(StepperRKAppAction<Scalar>::END_STEP) + "\n");
83  }
84  }
85 };
86 
87 } // namespace Tempus
88 
89 #endif // Tempus_StepperRKModifierDefault_hpp
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX.
Application Action for StepperRKBase.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
ACTION_LOCATION
Indicates the location of application action (see algorithm).
virtual void modify(Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperRKBase< Scalar > >, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)
Modify RK Stepper.