Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperNewmarkExplicitAForm_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_StepperNewmarkExplicitAForm_decl_hpp
10#define Tempus_StepperNewmarkExplicitAForm_decl_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_StepperExplicit.hpp"
15
16namespace Tempus {
17
18
92template<class Scalar>
94 : virtual public Tempus::StepperExplicit<Scalar>
95{
96public:
97
104
105
108 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
109 bool useFSAL,
110 std::string ICConsistency,
111 bool ICConsistencyCheck,
112 Scalar gamma,
113 const Teuchos::RCP<StepperNewmarkExplicitAFormAppAction<Scalar> >& stepperAppAction);
114
115 virtual Teuchos::RCP<StepperNewmarkExplicitAFormAppAction<Scalar> > getAppAction() const
117
119 virtual void setInitialConditions (
120 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
121
123 virtual void takeStep(
124 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
125
127 virtual Teuchos::RCP<Tempus::StepperState<Scalar> > getDefaultStepperState();
128 virtual Scalar getOrder() const {
129 if (gamma_ == 0.5) return 2.0;
130 else return 1.0;
131 }
132 virtual Scalar getOrderMin() const {return 1.0;}
133 virtual Scalar getOrderMax() const {return 2.0;}
134 virtual Scalar getInitTimeStep(
135 const Teuchos::RCP<SolutionHistory<Scalar> >& /* solutionHistory */) const
136 {return Scalar(1.0e+99);}
137
138 virtual bool isExplicit() const {return true;}
139 virtual bool isImplicit() const {return false;}
140 virtual bool isExplicitImplicit() const
141 {return isExplicit() && isImplicit();}
142 virtual bool isOneStepMethod() const {return true;}
143 virtual bool isMultiStepMethod() const {return !isOneStepMethod();}
144 virtual void setUseFSAL(bool a) { this->useFSAL_ = a; this->isInitialized_ = false; }
145 virtual OrderODE getOrderODE() const {return SECOND_ORDER_ODE;}
147
148 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
149
151
152 virtual void describe(Teuchos::FancyOStream & out,
153 const Teuchos::EVerbosityLevel verbLevel) const;
155
156 virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
157
161 const Scalar dt) const;
162
167 const Scalar dt) const;
168
170 const Thyra::VectorBase<Scalar>& vPred,
172 const Scalar dt) const;
173
174 void setGamma(Scalar gamma)
175 {
176 gamma_ = gamma;
177
178 TEUCHOS_TEST_FOR_EXCEPTION( (gamma_ > 1.0) || (gamma_ < 0.0),
179 std::logic_error,
180 "Error in 'Newmark Explicit a-Form' stepper: invalid value of Gamma = "
181 << gamma_ << ". Please select 0 <= Gamma <= 1. \n");
182
183 this->isInitialized_ = false;
184 }
185
186 virtual void setAppAction(
187 Teuchos::RCP<StepperNewmarkExplicitAFormAppAction<Scalar> > appAction);
188
189protected:
190
192 Scalar gamma_;
193 Teuchos::RCP<StepperNewmarkExplicitAFormAppAction<Scalar> > stepperNewmarkExpAppAction_;
194
195};
196
197
199// ------------------------------------------------------------------------
200template<class Scalar>
201Teuchos::RCP<StepperNewmarkExplicitAForm<Scalar> >
203 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
204 Teuchos::RCP<Teuchos::ParameterList> pl);
205
206
207} // namespace Tempus
208
209#endif // Tempus_StepperNewmarkExplicitAForm_decl_hpp
Thyra Base interface for implicit time steppers.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
void correctVelocity(Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > stepperNewmarkExpAppAction_
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &) const
void predictVelocity(Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
virtual Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > getAppAction() const
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
virtual void setAppAction(Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > appAction)
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions and make them consistent.
void predictDisplacement(Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
bool isInitialized_
True if stepper's member data is initialized.
bool useFSAL_
Use First-Same-As-Last (FSAL) principle.
Teuchos::RCP< StepperNewmarkExplicitAForm< Scalar > > createStepperNewmarkExplicitAForm(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, Teuchos::RCP< Teuchos::ParameterList > pl)
Nonmember constructor - ModelEvaluator and ParameterList.
@ SECOND_ORDER_ODE
Stepper integrates second-order ODEs.