Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar > Class Template Reference

This is a Forward Euler time stepper to test the PhysicsState. More...

#include <Tempus_PhysicsStateTest_StepperForwardEuler.hpp>

Inheritance diagram for Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar >:
Tempus::StepperForwardEuler< Scalar > Tempus::Stepper< Scalar >

Public Member Functions

 PhysicsStateTest_StepperForwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
 Constructor. More...
 
virtual void takeStep (const Teuchos::RCP< Tempus::SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful. More...
 
- Public Member Functions inherited from Tempus::StepperForwardEuler< Scalar >
 StepperForwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
 Constructor. More...
 
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual void setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel ()
 
virtual void setSolver (std::string solverName)
 Set solver via ParameterList solver name. More...
 
virtual void setSolver (Teuchos::RCP< Teuchos::ParameterList > solverPL=Teuchos::null)
 Set solver via solver ParameterList. More...
 
virtual void setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
 Set solver. More...
 
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver () const
 Get solver. More...
 
virtual void setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)
 Set Observer. More...
 
virtual void initialize ()
 Initialize during construction and after changing input parameters. More...
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful. More...
 
virtual std::string getStepperType () const
 
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState ()
 Get a default (initial) StepperState. More...
 
virtual Scalar getOrder () const
 
virtual Scalar getOrderMin () const
 
virtual Scalar getOrderMax () const
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const
 
virtual bool isExplicit () const
 
virtual bool isImplicit () const
 
virtual bool isExplicitImplicit () const
 
virtual bool isOneStepMethod () const
 
virtual bool isMultiStepMethod () const
 
virtual void setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
 Pass initial guess to Newton solver (only relevant for implicit solvers) More...
 
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getXDotTemp (Teuchos::RCP< Thyra::VectorBase< Scalar > > x)
 Provide temporary xDot memory for Stepper if SolutionState doesn't. More...
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)
 
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList ()
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
Teuchos::RCP< Teuchos::ParameterList > getDefaultParameters () const
 
virtual std::string description () const
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models)
 
void validExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate that the model supports explicit ODE evaluation, f(x,t) [=xdot]. More...
 
void validSecondOrderExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate that the model supports explicit second order ODE evaluation, f(x,xdot,t) [=xdotdot]. More...
 
void validImplicitODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate ME supports implicit ODE/DAE evaluation, f(xdot,x,t) [= 0]. More...
 
void validSecondOrderODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate ME supports 2nd order implicit ODE/DAE evaluation, f(xdotdot,xdot,x,t) [= 0]. More...
 
Teuchos::RCP< Teuchos::ParameterList > defaultSolverParameters () const
 

Additional Inherited Members

- Protected Attributes inherited from Tempus::StepperForwardEuler< Scalar >
Teuchos::RCP< Teuchos::ParameterList > stepperPL_
 
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
 Explicit ODE ModelEvaluator. More...
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
 
Teuchos::RCP< StepperObserver< Scalar > > stepperObserver_
 
Teuchos::RCP< StepperForwardEulerObserver< Scalar > > stepperFEObserver_
 
Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotTemp_
 
Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess_
 

Detailed Description

template<class Scalar>
class Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar >

This is a Forward Euler time stepper to test the PhysicsState.

It is derived from StepperForwardEuler, and simply increments a physics counter.

Definition at line 25 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

Constructor & Destructor Documentation

◆ PhysicsStateTest_StepperForwardEuler()

template<class Scalar >
Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar >::PhysicsStateTest_StepperForwardEuler ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel,
Teuchos::RCP< Teuchos::ParameterList >  pList = Teuchos::null 
)
inline

Constructor.

Definition at line 31 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

Member Function Documentation

◆ takeStep()

template<class Scalar >
virtual void Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar >::takeStep ( const Teuchos::RCP< Tempus::SolutionHistory< Scalar > > &  solutionHistory)
inlinevirtual

Take the specified timestep, dt, and return true if successful.

Definition at line 37 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

The documentation for this class was generated from the following file: