Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperForwardEuler_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_StepperForwardEuler_decl_hpp
10#define Tempus_StepperForwardEuler_decl_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_StepperExplicit.hpp"
15
16namespace Tempus {
17
78template<class Scalar>
79class StepperForwardEuler : virtual public Tempus::StepperExplicit<Scalar>
80{
81public:
82
89
92 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
93 bool useFSAL,
94 std::string ICConsistency,
95 bool ICConsistencyCheck,
96 const Teuchos::RCP<StepperForwardEulerAppAction<Scalar> >& stepperFEAppAction);
97
98 virtual void setAppAction(
99 Teuchos::RCP<StepperForwardEulerAppAction<Scalar> > appAction);
100
101 virtual Teuchos::RCP<StepperForwardEulerAppAction<Scalar> > getAppAction() const
102 { return stepperFEAppAction_; }
103
105 virtual void setInitialConditions (
106 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
107
109 virtual void takeStep(
110 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
111
113 virtual Teuchos::RCP<Tempus::StepperState<Scalar> > getDefaultStepperState();
114 virtual Scalar getOrder() const {return 1.0;}
115 virtual Scalar getOrderMin() const {return 1.0;}
116 virtual Scalar getOrderMax() const {return 1.0;}
117 virtual void setUseFSAL(bool a) { this->useFSAL_ = a; this->isInitialized_ = false; }
118 virtual OrderODE getOrderODE() const {return FIRST_ORDER_ODE;}
120
122
123 virtual void describe(Teuchos::FancyOStream & out,
124 const Teuchos::EVerbosityLevel verbLevel) const;
126
127 virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
128
129protected:
130
131 Teuchos::RCP<StepperForwardEulerAppAction<Scalar> > stepperFEAppAction_;
132
133};
134
135
137// ------------------------------------------------------------------------
138template<class Scalar>
139Teuchos::RCP<StepperForwardEuler<Scalar> >
141 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
142 Teuchos::RCP<Teuchos::ParameterList> pl);
143
144
145} // namespace Tempus
146
147#endif // Tempus_StepperForwardEuler_decl_hpp
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Thyra Base interface for implicit time steppers.
Application Action for StepperForwardEuler.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions, make them consistent, and set needed memory.
virtual Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > getAppAction() const
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > stepperFEAppAction_
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
virtual void setAppAction(Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > appAction)
bool isInitialized_
True if stepper's member data is initialized.
bool useFSAL_
Use First-Same-As-Last (FSAL) principle.
Teuchos::RCP< StepperForwardEuler< Scalar > > createStepperForwardEuler(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.