Tempus  Version of the Day
Time Integration
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_WrapperModelEvaluatorSecondOrder_decl.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_WrapperModelEvaluatorSecondOrder_decl_hpp
10 #define Tempus_WrapperModelEvaluatorSecondOrder_decl_hpp
11 
12 #include <functional>
13 #include "Tempus_config.hpp"
15 #include "Thyra_VectorBase.hpp"
16 
17 
18 //#define VERBOSE_DEBUG_OUTPUT
19 
20 namespace Tempus {
21 
32 template <typename Scalar>
34  : public Tempus::WrapperModelEvaluator<Scalar>
35 {
36 public:
38 
41  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel, const std::string schemeName)
42  : appModel_(appModel),
43  out_(Teuchos::VerboseObjectBase::getDefaultOStream())
44  {
45 #ifdef VERBOSE_DEBUG_OUTPUT
46  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
47  *out_ << " schemeName = " << schemeName << "\n";
48 #endif
49  if (schemeName == "Newmark Implicit a-Form" || schemeName == "HHT-Alpha") {
51  }
52  else if (schemeName == "Newmark Implicit d-Form") {
54  }
55  else {
56  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
57  "Error: WrapperModelEvaluatorSecondOrder called with unsopported schemeName = " << schemeName
58  <<"! Supported schemeNames are: 'Newmark Implicit a-Form' and 'HHT-Alpha'.\n");
59  }
60  }
61 
65  {
66 #ifdef VERBOSE_DEBUG_OUTPUT
67  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
68 #endif
69  appModel_ = me;
70  }
71 
74  {
75 #ifdef VERBOSE_DEBUG_OUTPUT
76  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
77 #endif
78  return appModel_;
79  }
80 
83  Teuchos::RCP<const Vector> d_pred, Scalar delta_t,
84  Scalar t, Scalar beta, Scalar gamma)
85  {
86 #ifdef VERBOSE_DEBUG_OUTPUT
87  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
88 #endif
89  v_pred_ = v_pred; d_pred_ = d_pred;
90  delta_t_ = delta_t; t_ = t; beta_ = beta; gamma_ = gamma;
91  }
92 
94 
96  {
97 #ifdef VERBOSE_DEBUG_OUTPUT
98  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
99 #endif
100  return appModel_->create_W_op();
101  }
102 
105  {
106 #ifdef VERBOSE_DEBUG_OUTPUT
107  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
108 #endif
109  return appModel_->get_W_factory();
110  }
111 
113  {
114 #ifdef VERBOSE_DEBUG_OUTPUT
115  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
116 #endif
117  return appModel_->get_f_space();
118  }
119 
121  {
122 #ifdef VERBOSE_DEBUG_OUTPUT
123  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
124 #endif
125  return appModel_->get_p_space(p);
126  }
127 
129  {
130 #ifdef VERBOSE_DEBUG_OUTPUT
131  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
132 #endif
133  return appModel_->get_p_names(p);
134  }
135 
137  {
138 #ifdef VERBOSE_DEBUG_OUTPUT
139  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
140 #endif
141  return appModel_->get_x_space();
142  }
143 
145  { return appModel_->get_g_space(i); }
146 
148  {
149 #ifdef VERBOSE_DEBUG_OUTPUT
150  *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
151 #endif
152  return appModel_->getNominalValues();
153  }
154 
157  { wrapperInArgs_.setArgs(inArgs); }
158 
161  { return wrapperInArgs_; }
162 
165  { wrapperOutArgs_.setArgs(outArgs); }
166 
169  { return wrapperOutArgs_; }
170 
175  EVALUATION_TYPE /* evaluationType */ = SOLVE_FOR_X)
176  {
177  timeDer_ = timeDer;
178  wrapperInArgs_.setArgs(inArgs);
179  wrapperOutArgs_.setArgs(outArgs);
180  }
181 
184 
185  void evalModelImpl(
187  const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;
189 
191 
192 private:
193 
196 
197 private:
198 
200  Scalar t_;
201  Scalar gamma_;
202  Scalar beta_;
203  Scalar delta_t_;
208 
212 
213 };
214 
215 } // namespace Tempus
216 
217 #endif // Tempus_WrapperModelEvaluatorSecondOrder_hpp
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
virtual Thyra::ModelEvaluatorBase::OutArgs< Scalar > getOutArgs()
Get OutArgs the wrapper ModelEvalutor.
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
void initializeNewmark(Teuchos::RCP< const Vector > v_pred, Teuchos::RCP< const Vector > d_pred, Scalar delta_t, Scalar t, Scalar beta, Scalar gamma)
Set values needed in evalModelImpl.
void setAppModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
Set the underlying application ModelEvaluator.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAppModel() const
Get the underlying application model &#39;f&#39;.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int p) const
Get the p space.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Get the x-solution space.
A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state...
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
WrapperModelEvaluatorSecondOrder(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const std::string schemeName)
Constructor.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
A ModelEvaluator which wraps the application ModelEvaluator.
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int p) const
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
virtual void setForSolve(Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE=SOLVE_FOR_X)
Set parameters for application implicit ModelEvaluator solve.
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > getInArgs()
Get InArgs the wrapper ModelEvalutor.
WrapperModelEvaluatorSecondOrder()
Default constructor - not allowed.
virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)
Set InArgs the wrapper ModelEvalutor.
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Solve for x and determine xDot from x.
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int i) const
Get the g space.
virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)
Set OutArgs the wrapper ModelEvalutor.