A stepper implementing staggered forward sensitivity analysis. More...

#include <Tempus_StepperStaggeredForwardSensitivity_decl.hpp>

Inheritance diagram for Tempus::StepperStaggeredForwardSensitivity< Scalar >:

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

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

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
	Pass initial guess to Newton solver. More...

virtual bool	isValidSetup (Teuchos::FancyOStream &out) const

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const

virtual Teuchos::RCP< const Teuchos::ParameterList >	getParameterList () const

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

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

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	setObserver (Teuchos::RCP< StepperObserver< Scalar > >=Teuchos::null)
	Set Observer. More...

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

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

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

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::Stepper< Scalar >
virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &)

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

virtual bool	isInitialized ()
	True if stepper's member data is initialized. More...

virtual void	checkInitialized ()
	Check initialization, and error out on failure. 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 void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)

Protected Attributes
Teuchos::RCP < Teuchos::ParameterList >	stepperPL_

Teuchos::RCP < Teuchos::ParameterList >	sensPL_

Teuchos::RCP< Stepper< Scalar > >	stateStepper_

Teuchos::RCP< Stepper< Scalar > >	sensitivityStepper_

Teuchos::RCP < SensitivityModelEvaluatorBase < Scalar > >	combined_fsa_model_

Teuchos::RCP < SensitivityModelEvaluatorBase < Scalar > >	fsa_model_

Teuchos::RCP< SolutionHistory < Scalar > >	stateSolutionHistory_

Teuchos::RCP< SolutionHistory < Scalar > >	sensSolutionHistory_

bool	reuse_solver_

bool	force_W_update_

Protected Attributes inherited from Tempus::Stepper< Scalar >
bool	isInitialized_ = false
	True if stepper's member data is initialized. More...

Private Member Functions
void	setParams (const Teuchos::RCP< Teuchos::ParameterList > &pl, const Teuchos::RCP< Teuchos::ParameterList > &spl)

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

Detailed Description

template<class Scalar>
class Tempus::StepperStaggeredForwardSensitivity< Scalar >

A stepper implementing staggered forward sensitivity analysis.

It constructs two internal steppers, one for the state equations as usual and one for the sensitivity equations using Tempus::StaggeredForwardSensitivityModelEvaluator. It's implementation of takeStep() first takes a step using the state stepper, updates the sensitivity model evaluator with the compute state solution and time derivatives, and then takes a step using the sensitivity stepper. It optionally can reuse the state solver for the sensitivity equations as well.

Definition at line 29 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperStaggeredForwardSensitivity< Scalar >::StepperStaggeredForwardSensitivity ( )

Default constructor.

Requires subsequent setModel() and initialize() calls before calling takeStep().

Definition at line 29 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

template<class Scalar >

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

Constructor.

The first parameter list argument supplies supplies regular stepper options, while the second provides sensitivity specific options:

"Reuse State Linear Solver" (default: false) Whether to reuse the model's W matrix, solver, and preconditioner when solving the sensitivity equations. If they can be reused, substantial savings in compute time are possible.
"Force W Update" (default: false) When reusing the solver as above whether to force recomputation of W. This can be necessary when the solver overwrites it during the solve-phase (e.g., by a factorization).
"Use DfDp as Tangent" (default: false) Reinterpret the df/dp out-arg as the tangent vector (df/dx)(x,p) * dx/dp + df/dp(x,p) as described in the Tempus::CombinedForwardSensitivityModelEvaluator documentation.
"Sensitivity Parameter Index" (default: 0) Model evaluator parameter index for which sensitivities will be computed.
"Sensitivity X Tangent Index" (default: 1) If "Use DfDp as Tangent" is true, the model evaluator parameter index for passing dx/dp as a Thyra::DefaultMultiVectorProductVector.
"Sensitivity X-Dot Tangent Index" (default: 2) If "Use DfDp as Tangent" is true, the model evaluator parameter index for passing dx_dot/dp as a Thyra::DefaultMultiVectorProductVector.
"Sensitivity X-Dot-Dot Tangent Index" (default: 3) If "Use DfDp as Tangent" is true, the model evaluator parameter index for passing dx_dot_dot/dp as a Thyra::DefaultMultiVectorProductVector (if the model supports x_dot_dot).

Definition at line 38 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

Member Function Documentation

template<class Scalar >

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 273 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

template<class Scalar >

virtual std::string Tempus::StepperStaggeredForwardSensitivity< Scalar >::description ( ) const

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 161 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::StepperStaggeredForwardSensitivity< Scalar >::get_x_space ( ) const

Definition at line 400 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

template<class Scalar >

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

template<class Scalar >

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

virtual

Get a default (initial) StepperState.

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperStaggeredForwardSensitivity< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::StepperStaggeredForwardSensitivity< Scalar >