Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_UnitTest_NewmarkImplicitAForm.cpp
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
10
11#include "Teuchos_XMLParameterListHelpers.hpp"
12
13#include "Tempus_TimeStepControl.hpp"
14
15#include "Tempus_StepperNewmarkImplicitAForm.hpp"
20
21#include "../TestModels/HarmonicOscillatorModel.hpp"
22
23
24namespace Tempus_Unit_Test {
25
26using Teuchos::RCP;
27using Teuchos::rcp;
28using Teuchos::rcp_const_cast;
29using Teuchos::rcp_dynamic_cast;
30using Teuchos::ParameterList;
31using Teuchos::sublist;
32
34
35// ************************************************************
36// ************************************************************
37TEUCHOS_UNIT_TEST(NewmarkImplicitAForm, Default_Construction)
38{
40
41 // Default construction.
42 auto stepper = rcp(new Tempus::StepperNewmarkImplicitAForm<double>());
43 stepper->setModel(model);
44 stepper->initialize();
45 TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
46
49
50 // Default values for construction.
51 auto solver = rcp(new Thyra::NOXNonlinearSolver());
52 solver->setParameterList(Tempus::defaultSolverParameters());
53
54 bool useFSAL = stepper->getUseFSAL();
55 std::string ICConsistency = stepper->getICConsistency();
56 bool ICConsistencyCheck = stepper->getICConsistencyCheck();
57 bool zeroInitialGuess = stepper->getZeroInitialGuess();
58 std::string schemeName = "Average Acceleration";
59 double beta = 0.25;
60 double gamma = 0.5;
61
62
63 // Test the set functions.
64 stepper->setAppAction(modifier); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
65 stepper->setAppAction(modifierX); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
66 stepper->setSolver(solver); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
67 stepper->setUseFSAL(useFSAL); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
68 stepper->setICConsistency(ICConsistency); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
69 stepper->setICConsistencyCheck(ICConsistencyCheck); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
70 stepper->setZeroInitialGuess(zeroInitialGuess); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
71
72 stepper->setSchemeName(schemeName); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
73 stepper->setBeta(beta); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
74 stepper->setGamma(gamma); stepper->initialize(); TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
75
76
77 // Full argument list construction.
79 model, solver, useFSAL,
80 ICConsistency, ICConsistencyCheck, zeroInitialGuess,
81 schemeName, beta, gamma, modifier));
82 TEUCHOS_TEST_FOR_EXCEPT(!stepper->isInitialized());
83
84 // Test stepper properties.
85 TEUCHOS_ASSERT(stepper->getOrder() == 2);
86}
87
88
89// ************************************************************
90// ************************************************************
91TEUCHOS_UNIT_TEST(NewmarkImplicitAForm, StepperFactory_Construction)
92{
94 testFactoryConstruction("Newmark Implicit a-Form", model);
95}
96
97// ************************************************************
98// ************************************************************
99class StepperNewmarkImplicitAFormModifierTest
101{
102public:
103
105 StepperNewmarkImplicitAFormModifierTest()
106 : testBEGIN_STEP(false), testBEFORE_SOLVE(false),
107 testAFTER_SOLVE(false), testEND_STEP(false),
108 testCurrentValue(-0.99),
109 testDt(-1.5), testName("")
110 {}
111
113 virtual ~StepperNewmarkImplicitAFormModifierTest(){}
114
116 virtual void modify(
117 Teuchos::RCP<Tempus::SolutionHistory<double> > sh,
118 Teuchos::RCP<Tempus::StepperNewmarkImplicitAForm<double> > stepper,
120 {
121 switch(actLoc) {
122 case StepperNewmarkImplicitAFormAppAction<double>::BEGIN_STEP:
123 {
124 testBEGIN_STEP = true;
125 break;
126 }
127 case StepperNewmarkImplicitAFormAppAction<double>::BEFORE_SOLVE:
128 {
129 testBEFORE_SOLVE = true;
130 testDt = sh->getWorkingState()->getTimeStep();
131 //sh->getWorkingState()->setTimeStep(testDt);
132 break;
133 }
134 case StepperNewmarkImplicitAFormAppAction<double>::AFTER_SOLVE:
135 {
136 testAFTER_SOLVE = true;
137 testName = "Newmark Implicit A Form - Modifier";
138 stepper->setStepperName(testName);
139 break;
140 }
141 case StepperNewmarkImplicitAFormAppAction<double>::END_STEP:
142 {
143 testEND_STEP = true;
144 auto x = sh->getWorkingState()->getX();
145 testCurrentValue = get_ele(*(x), 0);
146 break;
147 }
148 default:
149 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
150 "Error - unknown action location.\n");
151 }
152 }
153
154 bool testBEGIN_STEP;
155 bool testBEFORE_SOLVE;
156 bool testAFTER_SOLVE;
157 bool testEND_STEP;
158 double testCurrentValue;
159 double testDt;
160 std::string testName;
161};
162
163
164// ************************************************************
165// ************************************************************
166class StepperNewmarkImplicitAFormModifierXTest
168{
169public:
170
172 StepperNewmarkImplicitAFormModifierXTest()
173 : testX_BEGIN_STEP(false), testX_BEFORE_SOLVE(false),
174 testX_AFTER_SOLVE(false), testX_END_STEP(false),
175 testX(-0.99), testXDot(-0.99),
176 testDt(-1.5), testTime(-1.5)
177 {}
178
180 virtual ~StepperNewmarkImplicitAFormModifierXTest(){}
181
183 virtual void modify(
184 Teuchos::RCP<Thyra::VectorBase<double> > x,
185 const double time, const double dt,
187 {
188 switch(modType) {
189 case StepperNewmarkImplicitAFormModifierXBase<double>::X_BEGIN_STEP:
190 {
191 testX_BEGIN_STEP = true;
192 testX = get_ele(*(x), 0);
193 break;
194 }
195 case StepperNewmarkImplicitAFormModifierXBase<double>::X_BEFORE_SOLVE:
196 {
197 testX_BEFORE_SOLVE = true;
198 testDt = dt;
199 break;
200 }
201 case StepperNewmarkImplicitAFormModifierXBase<double>::X_AFTER_SOLVE:
202 {
203 testX_AFTER_SOLVE = true;
204 testTime = time;
205 testX = get_ele(*(x), 0);
206 break;
207 }
208 case StepperNewmarkImplicitAFormModifierXBase<double>::X_END_STEP:
209 {
210 testX_END_STEP = true;
211 testX = get_ele(*(x), 0);
212 break;
213 }
214 default:
215 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
216 "Error - unknown action location.\n");
217 }
218 }
219
220 bool testX_BEGIN_STEP;
221 bool testX_BEFORE_SOLVE;
222 bool testX_AFTER_SOLVE;
223 bool testX_END_STEP;
224 double testX;
225 double testXDot;
226 double testDt;
227 double testTime;
228};
229
230TEUCHOS_UNIT_TEST(NewmarkImplicitAForm, AppAction_Modifier)
231{
232 using Teuchos::RCP;
233 using Teuchos::sublist;
234 using Teuchos::ParameterList;
235
236 double dt = 1.0;
237
238 // Read params from .xml file
239 RCP<ParameterList> pList = Teuchos::getParametersFromXmlFile(
240 "Tempus_NewmarkImplicitAForm_HarmonicOscillator_Damped_SecondOrder.xml");
241 RCP<ParameterList> pl = sublist(pList, "Tempus", true);
242
243 // Setup the HarmonicOscillatorModel
244 RCP<ParameterList> hom_pl = sublist(pList, "HarmonicOscillatorModel", true);
245 RCP<const Thyra::ModelEvaluator<double> > model =
246 Teuchos::rcp(new Tempus_Test::HarmonicOscillatorModel<double>(hom_pl));
247
248 // Setup Stepper for field solve ----------------------------
249 RCP<Tempus::StepperNewmarkImplicitAForm<double> > stepper =
250 Tempus::createStepperNewmarkImplicitAForm(model, Teuchos::null);
251
252 auto modifier = rcp(new StepperNewmarkImplicitAFormModifierTest());
253 stepper->setAppAction(modifier);
254 stepper->initialize();
255
256 // Setup TimeStepControl ------------------------------------
257 RCP<Tempus::TimeStepControl<double> > timeStepControl =
258 Teuchos::rcp(new Tempus::TimeStepControl<double>());
259 ParameterList tscPL = pl->sublist("Default Integrator")
260 .sublist("Time Step Control");
261 timeStepControl->setInitIndex(tscPL.get<int> ("Initial Time Index"));
262 timeStepControl->setInitTime (tscPL.get<double>("Initial Time"));
263 timeStepControl->setFinalTime(dt);
264 timeStepControl->setInitTimeStep(dt);
265 timeStepControl->initialize();
266
267 // Setup initial condition SolutionState --------------------
268 using Teuchos::rcp_const_cast;
269 auto inArgsIC = model->getNominalValues();
270 RCP<Thyra::VectorBase<double> > icX =
271 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x());
272 RCP<Thyra::VectorBase<double> > icXDot =
273 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x_dot());
274 RCP<Thyra::VectorBase<double> > icXDotDot =
275 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x_dot_dot());
276 RCP<Tempus::SolutionState<double> > icState =
277 Tempus::createSolutionStateX(icX, icXDot, icXDotDot);
278 icState->setTime (timeStepControl->getInitTime());
279 icState->setIndex (timeStepControl->getInitIndex());
280 icState->setTimeStep(0.0);
281 icState->setOrder (stepper->getOrder());
282 icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.
283
284 // Setup SolutionHistory ------------------------------------
285 RCP<Tempus::SolutionHistory<double> > solutionHistory =
286 Teuchos::rcp(new Tempus::SolutionHistory<double>());
287 solutionHistory->setName("Forward States");
288 solutionHistory->setStorageType(Tempus::STORAGE_TYPE_STATIC);
289 solutionHistory->setStorageLimit(2);
290 solutionHistory->addState(icState);
291
292 // Setup Integrator -----------------------------------------
293 RCP<Tempus::IntegratorBasic<double> > integrator =
294 Tempus::createIntegratorBasic<double>();
295 integrator->setStepper(stepper);
296 integrator->setTimeStepControl(timeStepControl);
297 integrator->setSolutionHistory(solutionHistory);
298 integrator->initialize();
299
300 // Integrate to timeMax
301 bool integratorStatus = integrator->advanceTime();
302 TEST_ASSERT(integratorStatus)
303
304
305 // Testing that each ACTION_LOCATION has been called.
306 TEST_COMPARE(modifier->testBEGIN_STEP, ==, true);
307 TEST_COMPARE(modifier->testBEFORE_SOLVE, ==, true);
308 TEST_COMPARE(modifier->testAFTER_SOLVE, ==, true);
309 TEST_COMPARE(modifier->testEND_STEP, ==, true);
310
311 // Testing that values can be set through the Modifier.
312 auto x = integrator->getX();
313 auto Dt = integrator->getTime();
314 TEST_FLOATING_EQUALITY(modifier->testDt, Dt, 1.0e-14);
315 TEST_FLOATING_EQUALITY(modifier->testCurrentValue, get_ele(*(x), 0), 1.0e-14);
316 TEST_COMPARE(modifier->testName, ==, stepper->getStepperName());
317}
318
319
320TEUCHOS_UNIT_TEST(NewmarkImplicitAForm, AppAction_ModifierX)
321{
322 using Teuchos::RCP;
323 using Teuchos::sublist;
324 using Teuchos::ParameterList;
325
326 double dt = 1.0;
327
328 // Read params from .xml file
329 RCP<ParameterList> pList = Teuchos::getParametersFromXmlFile(
330 "Tempus_NewmarkImplicitAForm_HarmonicOscillator_Damped_SecondOrder.xml");
331 RCP<ParameterList> pl = sublist(pList, "Tempus", true);
332
333 // Setup the HarmonicOscillatorModel
334 RCP<ParameterList> hom_pl = sublist(pList, "HarmonicOscillatorModel", true);
335 RCP<const Thyra::ModelEvaluator<double> > model =
336 Teuchos::rcp(new Tempus_Test::HarmonicOscillatorModel<double>(hom_pl));
337
338 // Setup Stepper for field solve ----------------------------
339 RCP<Tempus::StepperNewmarkImplicitAForm<double> > stepper =
340 Tempus::createStepperNewmarkImplicitAForm(model, Teuchos::null);
341
342 auto modifierX = rcp(new StepperNewmarkImplicitAFormModifierXTest());
343 stepper->setAppAction(modifierX);
344 stepper->initialize();
345
346 // Setup TimeStepControl ------------------------------------
347 RCP<Tempus::TimeStepControl<double> > timeStepControl =
348 Teuchos::rcp(new Tempus::TimeStepControl<double>());
349 ParameterList tscPL = pl->sublist("Default Integrator")
350 .sublist("Time Step Control");
351 timeStepControl->setInitIndex(tscPL.get<int> ("Initial Time Index"));
352 timeStepControl->setInitTime (tscPL.get<double>("Initial Time"));
353 timeStepControl->setFinalTime(dt);
354 timeStepControl->setInitTimeStep(dt);
355 timeStepControl->initialize();
356
357 // Setup initial condition SolutionState --------------------
358 using Teuchos::rcp_const_cast;
359 auto inArgsIC = model->getNominalValues();
360 RCP<Thyra::VectorBase<double> > icX =
361 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x());
362 RCP<Thyra::VectorBase<double> > icXDot =
363 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x_dot());
364 RCP<Thyra::VectorBase<double> > icXDotDot =
365 rcp_const_cast<Thyra::VectorBase<double> > (inArgsIC.get_x_dot_dot());
366 RCP<Tempus::SolutionState<double> > icState =
367 Tempus::createSolutionStateX(icX, icXDot, icXDotDot);
368 icState->setTime (timeStepControl->getInitTime());
369 icState->setIndex (timeStepControl->getInitIndex());
370 icState->setTimeStep(0.0);
371 icState->setOrder (stepper->getOrder());
372 icState->setSolutionStatus(Tempus::Status::PASSED); // ICs are passing.
373
374 // Setup SolutionHistory ------------------------------------
375 RCP<Tempus::SolutionHistory<double> > solutionHistory =
376 Teuchos::rcp(new Tempus::SolutionHistory<double>());
377 solutionHistory->setName("Forward States");
378 solutionHistory->setStorageType(Tempus::STORAGE_TYPE_STATIC);
379 solutionHistory->setStorageLimit(2);
380 solutionHistory->addState(icState);
381
382 // Setup Integrator -----------------------------------------
383 RCP<Tempus::IntegratorBasic<double> > integrator =
384 Tempus::createIntegratorBasic<double>();
385 integrator->setStepper(stepper);
386 integrator->setTimeStepControl(timeStepControl);
387 integrator->setSolutionHistory(solutionHistory);
388 integrator->initialize();
389
390 // Integrate to timeMax
391 bool integratorStatus = integrator->advanceTime();
392 TEST_ASSERT(integratorStatus)
393
394 // Testing that each ACTION_LOCATION has been called.
395 TEST_COMPARE(modifierX->testX_BEGIN_STEP, ==, true);
396 TEST_COMPARE(modifierX->testX_BEFORE_SOLVE, ==, true);
397 TEST_COMPARE(modifierX->testX_AFTER_SOLVE, ==, true);
398 TEST_COMPARE(modifierX->testX_END_STEP, ==, true);
399
400
401 // Testing that values can be set through the Modifier.
402 auto Dt = integrator->getTime();
403 TEST_FLOATING_EQUALITY(modifierX->testDt, Dt, 1.0e-14);
404
405 const auto x = integrator->getX();
406 TEST_FLOATING_EQUALITY(modifierX->testX, get_ele(*(x), 0), 1.0e-14);
407}
408
409} // namespace Tempus_Test
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< Thyra::VectorBase< double > >, const double, const double, const MODIFIER_TYPE modType)=0
Modify solution based on the MODIFIER_TYPE.
MODIFIER_TYPE
Indicates the location of application action (see algorithm).
Newmark time stepper in acceleration form (a-form).
TimeStepControl manages the time step size. There several mechanisms that effect the time step size a...
TEUCHOS_UNIT_TEST(BackwardEuler, Default_Construction)
void testFactoryConstruction(std::string stepperType, const Teuchos::RCP< const Thyra::ModelEvaluator< double > > &model)
Unit test utility for Stepper construction through StepperFactory.
@ STORAGE_TYPE_STATIC
Keep a fix number of states.
Teuchos::RCP< SolutionState< Scalar > > createSolutionStateX(const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdot=Teuchos::null, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xdotdot=Teuchos::null)
Nonmember constructor from non-const solution vectors, x.
Teuchos::RCP< StepperNewmarkImplicitAForm< Scalar > > createStepperNewmarkImplicitAForm(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, Teuchos::RCP< Teuchos::ParameterList > pl)
Nonmember constructor - ModelEvaluator and ParameterList.
Teuchos::RCP< Teuchos::ParameterList > defaultSolverParameters()
Returns the default solver ParameterList for implicit Steppers.