Tempus Version of the Day
Time Integration
|
Leapfrog time stepper. More...
#include <Tempus_StepperLeapfrog_decl.hpp>
Public Member Functions | |
StepperLeapfrog () | |
Default constructor. | |
StepperLeapfrog (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, const Teuchos::RCP< StepperLeapfrogAppAction< Scalar > > &stepperLFAppAction) | |
Constructor. | |
![]() | |
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 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 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. | |
virtual void | setUseFSAL (bool a) |
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< StepperLeapfrogAppAction< Scalar > > | stepperLFAppAction_ |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
Basic stepper methods | |
virtual void | setAppAction (Teuchos::RCP< StepperLeapfrogAppAction< Scalar > > appAction) |
virtual Teuchos::RCP< StepperLeapfrogAppAction< Scalar > > | getAppAction () const |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions and make them consistent. | |
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 Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const |
virtual bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual OrderODE | getOrderODE () 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. | |
Leapfrog time stepper.
For the governing equation,
one can write the explicit ODE system,
where
The Leapfrog stepper can be written as
where the position and velocity are leapfrogged over each other. On startup the velocity half-step can be obtained with
and to complete the time step, the final velocity half-step is obtained with
Algorithm The single-timestep algorithm for Leapfrog is
where one can begin with
The First-Same-As-Last (FSAL) principle is not used with Leapfrog because of the algorithm's prescribed order of solution update. The default is to set useFSAL=false, and useFSAL=true will issue a warning that it will have no affect.
Definition at line 96 of file Tempus_StepperLeapfrog_decl.hpp.
Tempus::StepperLeapfrog< Scalar >::StepperLeapfrog |
Default constructor.
Definition at line 21 of file Tempus_StepperLeapfrog_impl.hpp.
Tempus::StepperLeapfrog< Scalar >::StepperLeapfrog | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
const Teuchos::RCP< StepperLeapfrogAppAction< Scalar > > & | stepperLFAppAction | ||
) |
Constructor.
Definition at line 33 of file Tempus_StepperLeapfrog_impl.hpp.
|
virtual |
Definition at line 55 of file Tempus_StepperLeapfrog_impl.hpp.
|
inlinevirtual |
Definition at line 120 of file Tempus_StepperLeapfrog_decl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 70 of file Tempus_StepperLeapfrog_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 97 of file Tempus_StepperLeapfrog_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 178 of file Tempus_StepperLeapfrog_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 133 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 134 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 135 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 136 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 140 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 141 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 142 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 144 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 145 of file Tempus_StepperLeapfrog_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 146 of file Tempus_StepperLeapfrog_decl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 188 of file Tempus_StepperLeapfrog_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 205 of file Tempus_StepperLeapfrog_impl.hpp.
|
protected |
Definition at line 159 of file Tempus_StepperLeapfrog_decl.hpp.