Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperSubcyclingModifierXDefault.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_StepperSubcyclingModifierX_hpp
11 #define Tempus_StepperSubcyclingModifierX_hpp
12 
13 #include "Tempus_config.hpp"
15 
16 namespace Tempus {
17 
26 template <class Scalar>
28  : virtual public Tempus::StepperSubcyclingModifierXBase<Scalar> {
29  public:
32 
35 
37  virtual void modify(
38  Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */, const Scalar /* time */,
39  const Scalar /* dt */,
41  modType)
42  {
43  switch (modType) {
46  // No-op.
47  break;
48  }
49  default:
50  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
51  "Error - unknown modifier type.\n");
52  }
53  }
54 };
55 
56 } // namespace Tempus
57 
58 #endif // Tempus_StepperSubcyclingModifierX_hpp
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual void modify(Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const typename StepperSubcyclingModifierXBase< Scalar >::MODIFIER_TYPE modType)
Modify solution based on the MODIFIER_TYPE.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).