Tempus Version of the Day
Time Integration
|
Forward Euler time stepper. More...
#include <Tempus_StepperForwardEuler_decl.hpp>
Public Member Functions | |
StepperForwardEuler () | |
Default constructor. | |
StepperForwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, const Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > &stepperFEAppAction) | |
Constructor. | |
virtual void | setAppAction (Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > appAction) |
virtual Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > | getAppAction () const |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions, make them consistent, and set needed memory. | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. | |
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. | |
virtual Scalar | getOrder () const |
virtual Scalar | getOrderMin () const |
virtual Scalar | getOrderMax () const |
virtual void | setUseFSAL (bool a) |
virtual OrderODE | getOrderODE () const |
![]() | |
void | setStepperExplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperExplicit member data from the ParameterList. | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) |
Set model. | |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const |
Return the application ModelEvaluator. | |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) |
Set solver. | |
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const |
Get solver. | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >) |
Pass initial guess to Newton solver (only relevant for implicit solvers) | |
virtual bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual void | evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p) |
Evaluate xDot = f(x,t). | |
virtual void | evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDot, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p) |
Evaluate xDotDot = f(x, xDot, t). | |
![]() | |
virtual std::string | description () const |
void | setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl) |
Set Stepper member data from ParameterList. | |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Teuchos::RCP< Teuchos::ParameterList > | getValidParametersBasic () const |
Add basic parameters to Steppers ParameterList. | |
virtual void | initialize () |
Initialize after construction and changing input parameters. | |
virtual bool | isInitialized () |
True if stepper's member data is initialized. | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. | |
void | setStepperName (std::string s) |
Set the stepper name. | |
std::string | getStepperName () const |
Get the stepper name. | |
std::string | getStepperType () const |
Get the stepper type. The stepper type is used as an identifier for the stepper, and can only be set by the derived Stepper class. | |
void | setUseFSALTrueOnly (bool a) |
void | setUseFSALFalseOnly (bool a) |
bool | getUseFSAL () const |
void | setICConsistency (std::string s) |
std::string | getICConsistency () const |
void | setICConsistencyCheck (bool c) |
bool | getICConsistencyCheck () const |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperX () |
Get Stepper x. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDot () |
Get Stepper xDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot () |
Get Stepper xDotDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state) |
Get xDotDot from SolutionState or Stepper storage. | |
Overridden from Teuchos::Describable | |
Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > | stepperFEAppAction_ |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
Additional Inherited Members | |
![]() | |
virtual void | setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x) |
Set x for Stepper storage. | |
virtual void | setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot) |
Set xDot for Stepper storage. | |
virtual void | setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot) |
Set x for Stepper storage. | |
void | setStepperType (std::string s) |
Set the stepper type. | |
![]() | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | appModel_ |
Explicit ODE ModelEvaluator. | |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | inArgs_ |
Thyra::ModelEvaluatorBase::OutArgs< Scalar > | outArgs_ |
![]() | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. | |
Forward Euler time stepper.
For the explicit ODE system,
the Forward Euler stepper can be written as
Forward Euler is an explicit time stepper (i.e., no solver used). Note that the time derivative by definition is
Algorithm The single-timestep algorithm for Forward Euler is
Note that with useFSAL=false
To have them at the same time level, we can use the First-Same-As-Last (FSAL) principle where the function evaulation from the last time step can be used as the first function evalulation of the current step.
The default for Forward Euler is to use FSAL (useFSAL=true), but will also work with useFSAL=false. Using useFSAL=true does assume that the solution,
Definition at line 79 of file Tempus_StepperForwardEuler_decl.hpp.
Tempus::StepperForwardEuler< Scalar >::StepperForwardEuler |
Default constructor.
Definition at line 20 of file Tempus_StepperForwardEuler_impl.hpp.
Tempus::StepperForwardEuler< Scalar >::StepperForwardEuler | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
const Teuchos::RCP< StepperForwardEulerAppAction< Scalar > > & | stepperFEAppAction | ||
) |
Constructor.
Definition at line 31 of file Tempus_StepperForwardEuler_impl.hpp.
|
virtual |
Definition at line 52 of file Tempus_StepperForwardEuler_impl.hpp.
|
inlinevirtual |
Definition at line 101 of file Tempus_StepperForwardEuler_decl.hpp.
|
virtual |
Set the initial conditions, make them consistent, and set needed memory.
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 67 of file Tempus_StepperForwardEuler_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 84 of file Tempus_StepperForwardEuler_impl.hpp.
|
virtual |
Get a default (initial) StepperState.
Provide a StepperState to the SolutionState. This Stepper does not have any special state data, so just provide the base class StepperState with the Stepper description. This can be checked to ensure that the input StepperState can be used by this Stepper.
Implements Tempus::Stepper< Scalar >.
Definition at line 174 of file Tempus_StepperForwardEuler_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 114 of file Tempus_StepperForwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 115 of file Tempus_StepperForwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 116 of file Tempus_StepperForwardEuler_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 117 of file Tempus_StepperForwardEuler_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 118 of file Tempus_StepperForwardEuler_decl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 184 of file Tempus_StepperForwardEuler_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 202 of file Tempus_StepperForwardEuler_impl.hpp.
|
protected |
Definition at line 131 of file Tempus_StepperForwardEuler_decl.hpp.