Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperHHTAlphaModifierXDefault.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_StepperHHTAlphaModifierX_hpp
10 #define Tempus_StepperHHTAlphaModifierX_hpp
11 
12 #include "Tempus_config.hpp"
14 
15 namespace Tempus {
16 
25 template <class Scalar>
27  : virtual public Tempus::StepperHHTAlphaModifierXBase<Scalar> {
28  public:
31 
34 
36  virtual void modify(
37  Teuchos::RCP<Thyra::VectorBase<Scalar> > /* x */, const Scalar /* time */,
38  const Scalar /* dt */,
40  modType)
41  {
42  switch (modType) {
47  // No-op.
48  break;
49  }
50  default:
51  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
52  "Error - unknown modifier type.\n");
53  }
54  }
55 };
56 
57 } // namespace Tempus
58 
59 #endif // Tempus_StepperHHTAlphaModifierX_hpp
MODIFIER_TYPE
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 typename StepperHHTAlphaModifierXBase< Scalar >::MODIFIER_TYPE modType)
Modify solution based on the MODIFIER_TYPE.