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 >:

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 ()
	Default constructor. More...

	StepperForwardEuler (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
	Constructor. 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	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Set the initial conditions, make them consistent, and set needed memory. More...

virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Take the specified timestep, dt, and return true if successful. More...

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 OrderODE	getOrderODE () const

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::StepperExplicit< Scalar >
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 Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const

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 std::string	getStepperType () const

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 bool	getEmbedded () const

virtual void	setUseFSAL (bool a)

virtual bool	getUseFSAL () const

virtual void	setICConsistency (std::string s)

virtual std::string	getICConsistency () const

virtual void	setICConsistencyCheck (bool c)

virtual bool	getICConsistencyCheck () const

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...

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 void	evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time)
	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)
	Evaluate xDotDot = f(x, xDot, t). More...

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual void	modelWarning () const

void	getValidParametersBasic (Teuchos::RCP< Teuchos::ParameterList > pl) const

virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)

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 < StepperForwardEulerObserver < Scalar > >	stepperFEObserver_

Protected Attributes inherited from Tempus::StepperExplicit< 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 < Thyra::VectorBase< Scalar > >	stepperX_

Teuchos::RCP < Thyra::VectorBase< Scalar > >	stepperXDot_

Teuchos::RCP < Thyra::VectorBase< Scalar > >	stepperXDotDot_

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

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

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:

http://docs.trilinos.org/r12.16/packages/tempus/test/PhysicsState/Tempus_PhysicsStateTest_StepperForwardEuler.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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