Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperNewmarkImplicitDForm_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_StepperNewmarkImplicitDForm_decl_hpp
10#define Tempus_StepperNewmarkImplicitDForm_decl_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_StepperImplicit.hpp"
14#include "Tempus_WrapperModelEvaluatorSecondOrder.hpp"
16
17namespace Tempus {
18
73template <class Scalar>
75 public:
76
83
86 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
87 const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
88 bool useFSAL,
89 std::string ICConsistency,
90 bool ICConsistencyCheck,
91 bool zeroInitialGuess,
92 std::string schemeName,
93 Scalar beta,
94 Scalar gamma,
95 const Teuchos::RCP<StepperNewmarkImplicitDFormAppAction<Scalar> >& stepperAppAction);
96
98
99 virtual void
100 setModel(const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar>>& appModel);
101
102 virtual Teuchos::RCP<StepperNewmarkImplicitDFormAppAction<Scalar> > getAppAction() const
104
105 virtual void setAppAction(
106 Teuchos::RCP<StepperNewmarkImplicitDFormAppAction<Scalar> > appAction);
107
109 virtual void setInitialConditions (
110 const Teuchos::RCP<SolutionHistory<Scalar> >& /* solutionHistory */){}
111
113 virtual void
114 takeStep(const Teuchos::RCP<SolutionHistory<Scalar>>& solutionHistory);
115
117 virtual Teuchos::RCP<Tempus::StepperState<Scalar>>
119 virtual Scalar
120 getOrder() const {
121 if (gamma_ == 0.5)
122 return 2.0;
123 else
124 return 1.0;
125 }
126 virtual Scalar
127 getOrderMin() const {
128 return 1.0;
129 }
130 virtual Scalar
131 getOrderMax() const {
132 return 2.0;
133 }
134 virtual bool isExplicit() const {return false;}
135 virtual bool isImplicit() const {return true;}
136 virtual bool isExplicitImplicit() const
137 {return isExplicit() && isImplicit();}
138 virtual bool isOneStepMethod() const {return true;}
139 virtual bool isMultiStepMethod() const {return !isOneStepMethod();}
140 virtual OrderODE getOrderODE() const {return SECOND_ORDER_ODE;}
142
144 virtual Scalar getW_xDotDot_coeff (const Scalar dt) const
145 { return Scalar(1.0)/(beta_*dt*dt); }
147 virtual Scalar getAlpha(const Scalar dt) const { return gamma_/(beta_*dt); }
149 virtual Scalar getBeta (const Scalar ) const { return Scalar(1.0); }
150
151 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
152
154
155 virtual void describe(Teuchos::FancyOStream& out,
156 const Teuchos::EVerbosityLevel verbLevel) const;
158
159 virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
160
161 void
164 const Thyra::VectorBase<Scalar>& a, const Scalar dt) const;
165
166 void
170 const Scalar dt) const;
171
172 void
175 const Thyra::VectorBase<Scalar>& a, const Scalar dt) const;
176
177 void
180 const Thyra::VectorBase<Scalar>& a, const Scalar dt) const;
181
182 void
185 const Thyra::VectorBase<Scalar>& d, const Scalar dt) const;
186
187
188 void setSchemeName(std::string schemeName);
189 void setBeta(Scalar beta);
190 void setGamma(Scalar gamma);
191
192 protected:
193
194 std::string schemeName_;
195 Scalar beta_;
196 Scalar gamma_;
197
198 Teuchos::RCP<Teuchos::FancyOStream> out_;
199 Teuchos::RCP<StepperNewmarkImplicitDFormAppAction<Scalar> > stepperNewmarkImpAppAction_;
200
201};
202
203
205// ------------------------------------------------------------------------
206template<class Scalar>
207Teuchos::RCP<StepperNewmarkImplicitDForm<Scalar> >
209 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
210 Teuchos::RCP<Teuchos::ParameterList> pl);
211
212
213} // namespace Tempus
214
215#endif // Tempus_StepperNewmarkImplicitDForm_decl_hpp
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Thyra Base interface for implicit time steppers.
Application Action for StepperNewmarkImplicitDForm.
virtual void setAppAction(Teuchos::RCP< StepperNewmarkImplicitDFormAppAction< Scalar > > appAction)
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
Set the model.
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
virtual Scalar getW_xDotDot_coeff(const Scalar dt) const
Return W_xDotxDot_coeff = d(xDotDot)/d(x).
void correctVelocity(Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
void correctAcceleration(Thyra::VectorBase< Scalar > &a, const Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &d, const Scalar dt) const
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
void predictVelocity(Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
virtual Scalar getAlpha(const Scalar dt) const
Return alpha = d(xDot)/d(x).
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual Scalar getBeta(const Scalar) const
Return beta = d(x)/d(x).
virtual Teuchos::RCP< StepperNewmarkImplicitDFormAppAction< Scalar > > getAppAction() const
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &)
Set the initial conditions and make them consistent.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
void correctDisplacement(Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
Teuchos::RCP< StepperNewmarkImplicitDFormAppAction< Scalar > > stepperNewmarkImpAppAction_
Teuchos::RCP< StepperNewmarkImplicitDForm< Scalar > > createStepperNewmarkImplicitDForm(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.