Trapezoidal method time stepper. More...

#include <Tempus_StepperTrapezoidal_decl.hpp>

Inheritance diagram for Tempus::StepperTrapezoidal< Scalar >:

Public Member Functions
	StepperTrapezoidal ()
	Default constructor. More...

	StepperTrapezoidal (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
	Constructor. More...

virtual Scalar	getAlpha (const Scalar dt) const
	Return alpha = d(xDot)/dx. More...

virtual Scalar	getBeta (const Scalar) const
	Return beta = d(x)/dx. More...

Basic stepper methods
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 and make them consistent. 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 bool	isExplicit () const

virtual bool	isImplicit () const

virtual bool	isExplicitImplicit () const

virtual bool	isOneStepMethod () const

virtual bool	isMultiStepMethod () const

virtual OrderODE	getOrderODE () const

ParameterList methods
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

Overridden from Teuchos::Describable
virtual std::string	description () const

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Public Member Functions inherited from Tempus::StepperImplicit< 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 Teuchos::RCP< const WrapperModelEvaluator< Scalar > >	getWrapperModel ()

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

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x)
	Solve problem using x in-place. (Needs to be deprecated!) More...

const Thyra::SolveStatus< Scalar >	solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Solve implicit ODE, f(x, xDot, t, p) = 0. More...

void	evaluateImplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > &f, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
	Evaluate implicit ODE, f(x, xDot, t, p), residual. More...

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver (only relevant for implicit solvers) More...

virtual void	setZeroInitialGuess (bool zIG)
	Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False). More...

virtual bool	getZeroInitialGuess () const

virtual Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) 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	setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot)
	Set xDot for 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...

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

Private Attributes
Teuchos::RCP< Stepper< Scalar > >	predictorStepper_

Teuchos::RCP < StepperTrapezoidalObserver < Scalar > >	stepperTrapObserver_

Additional Inherited Members
Protected Attributes inherited from Tempus::StepperImplicit< Scalar >
Teuchos::RCP < Teuchos::ParameterList >	stepperPL_

Teuchos::RCP < WrapperModelEvaluator < Scalar > >	wrapperModel_

Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	solver_

Teuchos::RCP< const Thyra::VectorBase< Scalar > >	initial_guess_

Teuchos::RCP< StepperObserver < Scalar > >	stepperObserver_

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

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

Detailed Description

template<class Scalar>
class Tempus::StepperTrapezoidal< Scalar >

Trapezoidal method time stepper.

For the implicit ODE system, $\mathcal{F}(\dot{x},x,t) = 0$ , the solution, $\dot{x}$ and $x$ , is determined using a solver (e.g., a non-linear solver, like NOX).

Algorithm The single-timestep algorithm for Trapezoidal method is simply,

Solve $f(\dot{x}=(x_n-x_{n-1})/(\Delta t_n/2) - \dot{x}_{n-1}, x_n, t_n)=0$ for
$\dot{x}_n \leftarrow (x_n-x_{n-1})/(\Delta t_n/2) - \dot{x}_{n-1}$

The First-Step-As-Last (FSAL) principle is required for the Trapezoidal Stepper (i.e., useFSAL=true)! There are at least two ways around this, but are not implemented.

Do a solve for xDotOld, xDot_{n-1}, at each time step as for the initial conditions. This is expensive since you would be doing two solves every time step.
Use evaluateExplicitODE to get xDot_{n-1} if the application provides it. Explicit evaluations are cheaper but requires the application to implement xDot = f(x,t).

Definition at line 41 of file Tempus_StepperTrapezoidal_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperTrapezoidal< Scalar >::StepperTrapezoidal ( )

Default constructor.

Constructs with a default ParameterList.
Can reset ParameterList with setParameterList().
Requires subsequent setModel() and initialize() calls before calling takeStep().

Definition at line 26 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

Tempus::StepperTrapezoidal< Scalar >::StepperTrapezoidal	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		Teuchos::RCP< Teuchos::ParameterList >	pList = `Teuchos::null`
	)

Constructor.

Definition at line 34 of file Tempus_StepperTrapezoidal_impl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperTrapezoidal< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

virtual

Definition at line 205 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

std::string Tempus::StepperTrapezoidal< Scalar >::description ( ) const

virtual

Definition at line 197 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperTrapezoidal< Scalar >::getAlpha ( const Scalar dt ) const

inlinevirtual

Return alpha = d(xDot)/dx.

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 91 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperTrapezoidal< Scalar >::getBeta ( const Scalar ) const

inlinevirtual

Return beta = d(x)/dx.

Implements Tempus::StepperImplicit< Scalar >.

Definition at line 93 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperTrapezoidal< Scalar >::getDefaultParameters ( ) const

virtual

Implements Tempus::Stepper< Scalar >.

Definition at line 264 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperTrapezoidal< Scalar >::getDefaultStepperState ( )

virtual

Get a default (initial) StepperState.

Provide a StepperState to the SolutionState. This Stepper does not have any special state data, so just provide the base class StepperState with the Stepper description. This can be checked to ensure that the input StepperState can be used by this Stepper.

Implements Tempus::Stepper< Scalar >.

Definition at line 188 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperTrapezoidal< Scalar >::getNonconstParameterList ( )

Definition at line 283 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperTrapezoidal< Scalar >::getOrder ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 77 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperTrapezoidal< Scalar >::getOrderMax ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 79 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::StepperTrapezoidal< Scalar >::getOrderMin ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 78 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

virtual OrderODE Tempus::StepperTrapezoidal< Scalar >::getOrderODE ( ) const

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 87 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

Teuchos::RCP< const Teuchos::ParameterList > Tempus::StepperTrapezoidal< Scalar >::getValidParameters ( ) const

Definition at line 246 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

void Tempus::StepperTrapezoidal< Scalar >::initialize ( )

virtual

Initialize during construction and after changing input parameters.

Implements Tempus::Stepper< Scalar >.

Definition at line 73 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 81 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 83 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 82 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 86 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 85 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

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

virtual

Set the initial conditions and make them consistent.

Reimplemented from Tempus::StepperImplicit< Scalar >.

Definition at line 87 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

void Tempus::StepperTrapezoidal< Scalar >::setObserver ( Teuchos::RCP< StepperObserver< Scalar > > obs = Teuchos::null )

virtual

Set Observer.

Implements Tempus::Stepper< Scalar >.

Definition at line 51 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

void Tempus::StepperTrapezoidal< Scalar >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > & pl )

Definition at line 215 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

void Tempus::StepperTrapezoidal< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > & solutionHistory )

virtual

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

Implements Tempus::Stepper< Scalar >.

Definition at line 114 of file Tempus_StepperTrapezoidal_impl.hpp.

template<class Scalar >

Teuchos::RCP< Teuchos::ParameterList > Tempus::StepperTrapezoidal< Scalar >::unsetParameterList ( )

Definition at line 291 of file Tempus_StepperTrapezoidal_impl.hpp.

Member Data Documentation

template<class Scalar >

Teuchos::RCP<Stepper<Scalar> > Tempus::StepperTrapezoidal< Scalar >::predictorStepper_

private

Definition at line 113 of file Tempus_StepperTrapezoidal_decl.hpp.

template<class Scalar >

Teuchos::RCP<StepperTrapezoidalObserver<Scalar> > Tempus::StepperTrapezoidal< Scalar >::stepperTrapObserver_

private

Definition at line 114 of file Tempus_StepperTrapezoidal_decl.hpp.

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

http://docs.trilinos.org/r12.16/packages/tempus/src/Tempus_StepperTrapezoidal_decl.hpp
http://docs.trilinos.org/r12.16/packages/tempus/src/Tempus_StepperTrapezoidal_impl.hpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperTrapezoidal< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::StepperTrapezoidal< Scalar >