Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperTrapezoidal_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_StepperTrapezoidal_decl_hpp
10#define Tempus_StepperTrapezoidal_decl_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_StepperImplicit.hpp"
17
18
19namespace Tempus {
20
82template<class Scalar>
83class StepperTrapezoidal : virtual public Tempus::StepperImplicit<Scalar>
84{
85public:
86
93
96 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
97 const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
98 bool useFSAL,
99 std::string ICConsistency,
100 bool ICConsistencyCheck,
101 bool zeroInitialGuess,
102 const Teuchos::RCP<StepperTrapezoidalAppAction<Scalar> >& stepperTrapAppAction);
103
105
106 virtual void setAppAction(
107 Teuchos::RCP<StepperTrapezoidalAppAction<Scalar> > appAction);
108
109 virtual Teuchos::RCP<StepperTrapezoidalAppAction<Scalar> > getAppAction() const
110 { return stepperTrapAppAction_; }
111
113 virtual void setInitialConditions (
114 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
115
117 virtual void takeStep(
118 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
119
121 virtual Teuchos::RCP<Tempus::StepperState<Scalar> > getDefaultStepperState();
122 virtual Scalar getOrder() const {return 2.0;}
123 virtual Scalar getOrderMin() const {return 2.0;}
124 virtual Scalar getOrderMax() const {return 2.0;}
125
126 virtual bool isExplicit() const {return false;}
127 virtual bool isImplicit() const {return true;}
128 virtual bool isExplicitImplicit() const
129 {return isExplicit() && isImplicit();}
130 virtual bool isOneStepMethod() const {return true;}
131 virtual bool isMultiStepMethod() const {return !isOneStepMethod();}
132 virtual void setUseFSAL(bool a) { this->setUseFSALTrueOnly(a); }
133 virtual OrderODE getOrderODE() const {return FIRST_ORDER_ODE;}
135
137 virtual Scalar getAlpha(const Scalar dt) const { return Scalar(2.0)/dt; }
139 virtual Scalar getBeta (const Scalar ) const { return Scalar(1.0); }
140
142
143 virtual void describe(Teuchos::FancyOStream & out,
144 const Teuchos::EVerbosityLevel verbLevel) const;
146
147 virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
148
149
150private:
151
152 Teuchos::RCP<StepperTrapezoidalAppAction<Scalar> > stepperTrapAppAction_;
153
154};
155
164template <typename Scalar>
166 : virtual public Tempus::TimeDerivative<Scalar>
167{
168public:
169
172 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xOld,
173 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xDotOld)
174 { initialize(s, xOld, xDotOld); }
175
178
180 virtual void compute(
181 Teuchos::RCP<const Thyra::VectorBase<Scalar> > x,
182 Teuchos::RCP< Thyra::VectorBase<Scalar> > xDot,
183 Teuchos::RCP< Thyra::VectorBase<Scalar> > xDotDot = Teuchos::null)
184 {
185 xDotDot = Teuchos::null;
186 // Calculate the Trapezoidal method x dot vector
187 Thyra::V_StVpStV(xDot.ptr(),s_,*x,-s_,*xOld_);
188 Thyra::V_VpStV (xDot.ptr(),*xDot,Scalar(-1.0),*xDotOld_);
189 }
190
191 virtual void initialize(Scalar s,
192 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xOld,
193 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xDotOld)
194 { s_ = s; xOld_ = xOld; xDotOld_ = xDotOld; }
195
196private:
197
198 Scalar s_; // = 1.0/(dt/2)
199 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xOld_;
200 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xDotOld_;
201};
202
203
205// ------------------------------------------------------------------------
206template<class Scalar>
207Teuchos::RCP<StepperTrapezoidal<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_StepperTrapezoidal_decl_hpp
Thyra Base interface for implicit time steppers.
Time-derivative interface for Trapezoidal method.
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xOld_
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDotOld_
virtual void initialize(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xOld, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDotOld)
StepperTrapezoidalTimeDerivative(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xOld, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDotOld)
Constructor.
virtual void compute(Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot=Teuchos::null)
Compute the time derivative.
Trapezoidal method time stepper.
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
virtual Scalar getAlpha(const Scalar dt) const
Return alpha = d(xDot)/dx.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions and make them consistent.
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
virtual Teuchos::RCP< StepperTrapezoidalAppAction< Scalar > > getAppAction() const
virtual void setAppAction(Teuchos::RCP< StepperTrapezoidalAppAction< Scalar > > appAction)
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
virtual Scalar getBeta(const Scalar) const
Return beta = d(x)/dx.
Teuchos::RCP< StepperTrapezoidalAppAction< Scalar > > stepperTrapAppAction_
void setUseFSALTrueOnly(bool a)
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
Teuchos::RCP< StepperTrapezoidal< Scalar > > createStepperTrapezoidal(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, Teuchos::RCP< Teuchos::ParameterList > pl)
Nonmember constructor - ModelEvaluator and ParameterList.
@ FIRST_ORDER_ODE
Stepper integrates first-order ODEs.