Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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.
 
void initialize ()
 Initialize after construction and changing input parameters.
 
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.
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
- Public Member Functions inherited from Tempus::StepperExplicit< Scalar >
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
virtual bool isValidSetup (Teuchos::FancyOStream &out) 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 setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
 Set the initial conditions, make them consistent, and set needed memory.
 
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).
 
- Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual std::string description () const
 
void setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl)
 Set Stepper member data from ParameterList.
 
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasic () const
 Add basic parameters to Steppers ParameterList.
 
virtual bool isInitialized ()
 True if stepper's member data is initialized.
 
virtual void checkInitialized ()
 Check initialization, and error out on failure.
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
 Take the specified timestep, dt, and return true if successful.
 
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.
 

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.
 
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.
 
- Protected Attributes inherited from Tempus::StepperExplicit< Scalar >
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
 Explicit ODE ModelEvaluator.
 
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
 
- Protected Attributes inherited from Tempus::Stepper< Scalar >
bool useFSAL_ = false
 Use First-Same-As-Last (FSAL) principle.
 
bool isInitialized_ = false
 True if stepper's member data is initialized.
 

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

◆ StepperPhysicsStateTest()

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

◆ initialize()

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 42 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

◆ getDefaultStepperState()

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

◆ getOrder()

template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrder ( ) const
inlinevirtual

◆ getOrderMin()

template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMin ( ) const
inlinevirtual

◆ getOrderMax()

template<class Scalar >
Scalar Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderMax ( ) const
inlinevirtual

◆ getOrderODE()

template<class Scalar >
Tempus::OrderODE Tempus_Test::StepperPhysicsStateTest< Scalar >::getOrderODE ( ) const
inlinevirtual

◆ takeStep()

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 51 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP< const Teuchos::ParameterList > Tempus_Test::StepperPhysicsStateTest< Scalar >::getValidParameters ( ) const
inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 97 of file Tempus_PhysicsStateTest_StepperForwardEuler.hpp.


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