Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus_Test::StepperPhysicsStateTest< 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::StepperPhysicsStateTest< Scalar >:
Tempus::StepperExplicit< Scalar > Tempus::Stepper< Scalar >

Public Member Functions

 StepperPhysicsStateTest (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 Constructor. More...
 
void setObserver (Teuchos::RCP< Tempus::StepperObserver< Scalar > >)
 Set Observer. More...
 
virtual Teuchos::RCP
< Tempus::StepperObserver
< Scalar > > 
getObserver () const
 Get Observer. More...
 
void initialize ()
 Initialize after construction and changing input parameters. More...
 
Teuchos::RCP
< Tempus::StepperState< Scalar > > 
getDefaultStepperState ()
 
Scalar getOrder () const
 
Scalar getOrderMin () const
 
Scalar getOrderMax () const
 
Tempus::OrderODE getOrderODE () const
 
virtual void takeStep (const Teuchos::RCP< Tempus::SolutionHistory< Scalar > > &solutionHistory)
 Take the specified timestep, dt, and return true if successful. More...
 
Teuchos::RCP< const
Teuchos::ParameterList > 
getValidParameters () const
 
- Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
virtual bool isValidSetup (Teuchos::FancyOStream &out) const
 
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getModel ()
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const
 
virtual void setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Set the initial conditions, make them consistent, and set needed memory. 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 setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
 Pass initial guess to Newton solver (only relevant for implicit solvers) More...
 
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). More...
 
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). More...
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)
 
virtual bool isInitialized ()
 True if stepper's member data is initialized. More...
 
virtual void checkInitialized ()
 Check initialization, and error out on failure. More...
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
 Take the specified timestep, dt, and return true if successful. More...
 
void setStepperType (std::string s)
 
std::string getStepperType () const
 
void setUseFSAL (bool a)
 
bool getUseFSAL () const
 
virtual bool getUseFSALDefault () const
 
void setICConsistency (std::string s)
 
std::string getICConsistency () const
 
virtual std::string getICConsistencyDefault () const
 
void setICConsistencyCheck (bool c)
 
bool getICConsistencyCheck () const
 
virtual bool getICConsistencyCheckDefault () const
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperX (Teuchos::RCP< SolutionState< Scalar > > state)
 Get x from SolutionState or Stepper storage. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperXDot (Teuchos::RCP< SolutionState< Scalar > > state)
 Get xDot from SolutionState or Stepper storage. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< Scalar > > 
getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state)
 Get xDotDot from SolutionState or Stepper storage. More...
 
virtual std::string description () const
 
virtual void createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)
 

Additional Inherited Members

- Protected Member Functions inherited from Tempus::Stepper< Scalar >
virtual void setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x)
 Set x for Stepper storage. More...
 
virtual void setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
 Set xDot for Stepper storage. More...
 
virtual void setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot)
 Set x for Stepper storage. More...
 
- Protected Attributes inherited from Tempus::StepperExplicit< Scalar >
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_
 
- Protected Attributes inherited from Tempus::Stepper< Scalar >
bool isInitialized_ = false
 True if stepper's member data is initialized. More...
 

Detailed Description

template<class Scalar>
class Tempus_Test::StepperPhysicsStateTest< 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

template<class Scalar >
Tempus_Test::StepperPhysicsStateTest< Scalar >::StepperPhysicsStateTest ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel)
inline

Constructor.

Definition at line 31 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

Member Function Documentation

template<class Scalar >
Teuchos::RCP<Tempus::StepperState<Scalar> > Tempus_Test::StepperPhysicsStateTest< Scalar >::getDefaultStepperState ( )
inlinevirtual
template<class Scalar >
virtual Teuchos::RCP<Tempus::StepperObserver<Scalar> > Tempus_Test::StepperPhysicsStateTest< Scalar >::getObserver ( ) const
inlinevirtual

Get Observer.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 43 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrder ( ) const
inlinevirtual
template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMax ( ) const
inlinevirtual
template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMin ( ) const
inlinevirtual
template<class Scalar >
Tempus::OrderODE Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderODE ( ) const
inlinevirtual
template<class Scalar >
Teuchos::RCP<const Teuchos::ParameterList> Tempus_Test::StepperPhysicsStateTest< Scalar >::getValidParameters ( ) const
inlinevirtual
template<class Scalar >
void Tempus_Test::StepperPhysicsStateTest< Scalar >::initialize ( )
inlinevirtual

Initialize after construction and changing input parameters.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 45 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

template<class Scalar >
void Tempus_Test::StepperPhysicsStateTest< Scalar >::setObserver ( Teuchos::RCP< Tempus::StepperObserver< Scalar > >  obs)
inlinevirtual

Set Observer.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 42 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

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

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

Definition at line 54 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.


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