Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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
20namespace Tempus {
21
32template <typename Scalar>
34 : public Tempus::WrapperModelEvaluator<Scalar>
35{
36public:
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
64 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & me)
65 {
66#ifdef VERBOSE_DEBUG_OUTPUT
67 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
68#endif
69 appModel_ = me;
70 }
71
73 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getAppModel() const
74 {
75#ifdef VERBOSE_DEBUG_OUTPUT
76 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
77#endif
78 return appModel_;
79 }
80
82 void initializeNewmark(Teuchos::RCP<const Vector> v_pred,
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
95 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const
96 {
97#ifdef VERBOSE_DEBUG_OUTPUT
98 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
99#endif
100 return appModel_->create_W_op();
101 }
102
103 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
105 {
106#ifdef VERBOSE_DEBUG_OUTPUT
107 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
108#endif
109 return appModel_->get_W_factory();
110 }
111
112 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const
113 {
114#ifdef VERBOSE_DEBUG_OUTPUT
115 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
116#endif
117 return appModel_->get_f_space();
118 }
119
120 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int p) const
121 {
122#ifdef VERBOSE_DEBUG_OUTPUT
123 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
124#endif
125 return appModel_->get_p_space(p);
126 }
127
128 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int p) const
129 {
130#ifdef VERBOSE_DEBUG_OUTPUT
131 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
132#endif
133 return appModel_->get_p_names(p);
134 }
135
136 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const
137 {
138#ifdef VERBOSE_DEBUG_OUTPUT
139 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
140#endif
141 return appModel_->get_x_space();
142 }
143
144 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int i) const
145 { return appModel_->get_g_space(i); }
146
147 Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const
148 {
149#ifdef VERBOSE_DEBUG_OUTPUT
150 *out_ << "DEBUG: " << __PRETTY_FUNCTION__ << "\n";
151#endif
152 return appModel_->getNominalValues();
153 }
154
156 virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs)
157 { wrapperInArgs_.setArgs(inArgs); }
158
160 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> getInArgs()
161 { return wrapperInArgs_; }
162
164 virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs)
165 { wrapperOutArgs_.setArgs(outArgs); }
166
168 virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> getOutArgs()
169 { return wrapperOutArgs_; }
170
172 virtual void setForSolve(Teuchos::RCP<TimeDerivative<Scalar> > timeDer,
173 Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs,
174 Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs,
175 EVALUATION_TYPE /* evaluationType */ = SOLVE_FOR_X)
176 {
177 timeDer_ = timeDer;
178 wrapperInArgs_.setArgs(inArgs);
179 wrapperOutArgs_.setArgs(outArgs);
180 }
181
182 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
183 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
184
185 void evalModelImpl(
186 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs,
187 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;
189
191
192private:
193
196
197private:
198
199 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appModel_;
200 Scalar t_;
201 Scalar gamma_;
202 Scalar beta_;
203 Scalar delta_t_;
204 Teuchos::RCP<const Vector> d_pred_;
205 Teuchos::RCP<const Vector> v_pred_;
206 Teuchos::RCP<Teuchos::FancyOStream> out_;
208
209 Teuchos::RCP<TimeDerivative<Scalar> > timeDer_;
210 Thyra::ModelEvaluatorBase::InArgs<Scalar> wrapperInArgs_;
211 Thyra::ModelEvaluatorBase::OutArgs<Scalar> wrapperOutArgs_;
212
213};
214
215} // namespace Tempus
216
217#endif // Tempus_WrapperModelEvaluatorSecondOrder_hpp
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state,...
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.
WrapperModelEvaluatorSecondOrder()
Default constructor - not allowed.
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > getInArgs()
Get InArgs the wrapper ModelEvalutor.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int i) const
Get the g space.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int p) const
Get the p space.
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
void setAppModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
Set the underlying application ModelEvaluator.
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::OutArgs< Scalar > getOutArgs()
Get OutArgs the wrapper ModelEvalutor.
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Get the x-solution space.
virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)
Set OutArgs the wrapper ModelEvalutor.
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int p) const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)
Set InArgs the wrapper ModelEvalutor.
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAppModel() const
Get the underlying application model 'f'.
WrapperModelEvaluatorSecondOrder(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const std::string schemeName)
Constructor.
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
A ModelEvaluator which wraps the application ModelEvaluator.
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
@ SOLVE_FOR_X
Solve for x and determine xDot from x.