Thyra Base interface for implicit time steppers. More...

#include <Tempus_StepperExplicit_decl.hpp>

Inheritance diagram for Tempus::StepperExplicit< Scalar >:

Public Member Functions
Basic explicit stepper methods
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	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=Teuchos::null)
	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	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, 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...

Public Member Functions inherited from Tempus::Stepper< Scalar >
virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const =0

virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)=0
	Set Observer. More...

virtual Teuchos::RCP < StepperObserver< Scalar > >	getObserver () const =0
	Get Observer. More...

virtual void	initialize ()=0
	Initialize during construction and after changing input parameters. More...

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

virtual Teuchos::RCP < Tempus::StepperState< Scalar > >	getDefaultStepperState ()=0

virtual Scalar	getOrder () const =0

virtual Scalar	getOrderMin () const =0

virtual Scalar	getOrderMax () const =0

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

virtual std::string	description () const

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

Protected Attributes
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::StepperExplicit< Scalar >

Thyra Base interface for implicit time steppers.

Definition at line 41 of file Tempus_StepperExplicit_decl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::evaluateExplicitODE	(	Teuchos::RCP< Thyra::VectorBase< Scalar > >	xDot,
		Teuchos::RCP< const Thyra::VectorBase< Scalar > >	x,
		const Scalar	time,
		const Teuchos::RCP< ExplicitODEParameters< Scalar > > &	p
	)

virtual

Evaluate xDot = f(x,t).

Definition at line 297 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::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
	)

virtual

Evaluate xDotDot = f(x, xDot, t).

Definition at line 326 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperExplicit< Scalar >::getInitTimeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 54 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperExplicit< Scalar >::getModel ( )

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 52 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > Tempus::StepperExplicit< Scalar >::getSolver ( ) const

inlinevirtual

Get solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 65 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

Teuchos::RCP< Thyra::VectorBase< Scalar > > Tempus::StepperExplicit< Scalar >::getStepperX ( Teuchos::RCP< SolutionState< Scalar > > state )

virtual

Get x from SolutionState or Stepper storage.

Definition at line 249 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

Teuchos::RCP< Thyra::VectorBase< Scalar > > Tempus::StepperExplicit< Scalar >::getStepperXDot ( Teuchos::RCP< SolutionState< Scalar > > state )

virtual

Get xDot from SolutionState or Stepper storage.

Definition at line 265 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

Teuchos::RCP< Thyra::VectorBase< Scalar > > Tempus::StepperExplicit< Scalar >::getStepperXDotDot ( Teuchos::RCP< SolutionState< Scalar > > state )

virtual

Get xDotDot from SolutionState or Stepper storage.

Definition at line 281 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

virtual bool Tempus::StepperExplicit< Scalar >::isExplicit ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 73 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperExplicit< Scalar >::isExplicitImplicit ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 75 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperExplicit< Scalar >::isImplicit ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 74 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperExplicit< Scalar >::isMultiStepMethod ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 78 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual bool Tempus::StepperExplicit< Scalar >::isOneStepMethod ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, and Tempus::StepperNewmarkExplicitAForm< Scalar >.

Definition at line 77 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory )

virtual

Set the initial conditions, make them consistent, and set needed memory.

Implements Tempus::Stepper< Scalar >.

Reimplemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperForwardEuler< Scalar >.

Definition at line 36 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

virtual void Tempus::StepperExplicit< Scalar >::setInitialGuess ( Teuchos::RCP< const Thyra::VectorBase< Scalar > > )

inlinevirtual

Pass initial guess to Newton solver (only relevant for implicit solvers)

Implements Tempus::Stepper< Scalar >.

Definition at line 70 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & appModel )

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 17 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::setNonConstModel ( const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > & appModel )

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 29 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

void Tempus::StepperExplicit< Scalar >::setSolver ( Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver = Teuchos::null )

virtual

Set solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 236 of file Tempus_StepperExplicit_impl.hpp.

template<class Scalar >

virtual void Tempus::StepperExplicit< Scalar >::setStepperX ( Teuchos::RCP< Thyra::VectorBase< Scalar > > x )

inlinevirtual

Set x for Stepper storage.

Definition at line 81 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperExplicit< Scalar >::setStepperXDot ( Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot )

inlinevirtual

Set xDot for Stepper storage.

Definition at line 84 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

virtual void Tempus::StepperExplicit< Scalar >::setStepperXDotDot ( Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot )

inlinevirtual

Set x for Stepper storage.

Definition at line 87 of file Tempus_StepperExplicit_decl.hpp.

Member Data Documentation

template<class Scalar >

Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::StepperExplicit< Scalar >::appModel_

protected

Explicit ODE ModelEvaluator.

Definition at line 119 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::StepperExplicit< Scalar >::inArgs_

protected

Definition at line 121 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::StepperExplicit< Scalar >::outArgs_

protected

Definition at line 122 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

Teuchos::RCP<StepperObserver<Scalar> > Tempus::StepperExplicit< Scalar >::stepperObserver_

protected

Definition at line 124 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

Teuchos::RCP<Thyra::VectorBase<Scalar> > Tempus::StepperExplicit< Scalar >::stepperX_

protected

Definition at line 127 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

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

protected

Definition at line 128 of file Tempus_StepperExplicit_decl.hpp.

template<class Scalar >

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

protected

Definition at line 129 of file Tempus_StepperExplicit_decl.hpp.

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

http://docs.trilinos.org/r12.18/packages/tempus/src/Tempus_StepperExplicit_decl.hpp
http://docs.trilinos.org/r12.18/packages/tempus/src/Tempus_StepperExplicit_impl.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<class Scalar> class Tempus::StepperExplicit< Scalar >

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::StepperExplicit< Scalar >