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.
	StepperStaggeredForwardSensitivity (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &sens_residual_model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &sens_solve_model, const Teuchos::RCP< Teuchos::ParameterList > &pList=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &sens_pList=Teuchos::null)
	Constructor.
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 void	initialize ()
	Initialize after construction and changing input parameters.
virtual bool	isInitialized ()
	True if stepper's member data is initialized.
virtual void	checkInitialized ()
	Check initialization, and error out on failure.
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.
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.

Overridden from Teuchos::Describable
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_
SensitivityStepMode	stepMode_
virtual std::string	description () const
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
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
SensitivityStepMode	getStepMode () const
	What mode the current time integration step is in.
void	setParams (const Teuchos::RCP< Teuchos::ParameterList > &pl, const Teuchos::RCP< Teuchos::ParameterList > &spl)

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &sens_residual_model, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &sens_solve_model)
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel () const
virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null)
	Set solver.
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >	getSolver () const
	Get solver.
virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &)
	Set the initial conditions and make them consistent.
virtual void	takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Take the specified timestep, dt, and return true if successful.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > >	getDefaultStepperState ()
	Get a default (initial) StepperState.
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
virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
	Pass initial guess to Newton solver.

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

Additional Inherited Members
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.
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::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 38 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

Constructor & Destructor Documentation

◆ StepperStaggeredForwardSensitivity() [1/2]

template<class Scalar>

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

Default constructor.

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

Definition at line 26 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ StepperStaggeredForwardSensitivity() [2/2]

template<class Scalar>

Tempus::StepperStaggeredForwardSensitivity< Scalar >::StepperStaggeredForwardSensitivity	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	sens_residual_model,
		const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	sens_solve_model,
		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 37 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

Member Function Documentation

◆ setModel() [1/2]

template<class Scalar>

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

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 92 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setModel() [2/2]

template<class Scalar>

void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setModel	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	sens_residual_model,
		const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	sens_solve_model )

virtual

Definition at line 56 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getModel()

template<class Scalar>

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 99 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ setSolver()

template<class Scalar>

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

virtual

Set solver.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 107 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getSolver()

template<class Scalar>

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

inlinevirtual

Get solver.

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 103 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setInitialConditions()

template<class Scalar>

virtual void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setInitialConditions ( const Teuchos::RCP< SolutionHistory< Scalar > > & )

inlinevirtual

Set the initial conditions and make them consistent.

Implements Tempus::Stepper< Scalar >.

Definition at line 107 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ takeStep()

template<class Scalar>

void Tempus::StepperStaggeredForwardSensitivity< 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 119 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getDefaultStepperState()

template<class Scalar>

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

virtual

Get a default (initial) StepperState.

Implements Tempus::Stepper< Scalar >.

Definition at line 271 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getOrder()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 117 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getOrderMin()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 118 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getOrderMax()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 119 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getInitTimeStep()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 120 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ isExplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 124 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ isImplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 126 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ isExplicitImplicit()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 128 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ isOneStepMethod()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 131 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ isMultiStepMethod()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 134 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getOrderODE()

template<class Scalar>

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

inlinevirtual

Implements Tempus::Stepper< Scalar >.

Definition at line 136 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setUseFSAL()

template<class Scalar>

virtual void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setUseFSAL ( bool a )

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 138 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getUseFSAL()

template<class Scalar>

virtual bool Tempus::StepperStaggeredForwardSensitivity< Scalar >::getUseFSAL ( ) const

inlinevirtual

Definition at line 139 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setICConsistency()

template<class Scalar>

virtual void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setICConsistency ( std::string s )

inlinevirtual

Definition at line 142 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getICConsistency()

template<class Scalar>

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

inlinevirtual

Definition at line 144 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setICConsistencyCheck()

template<class Scalar>

virtual void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setICConsistencyCheck ( bool c )

inlinevirtual

Definition at line 148 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getICConsistencyCheck()

template<class Scalar>

virtual bool Tempus::StepperStaggeredForwardSensitivity< Scalar >::getICConsistencyCheck ( ) const

inlinevirtual

Definition at line 150 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setInitialGuess()

template<class Scalar>

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

inlinevirtual

Pass initial guess to Newton solver.

Implements Tempus::Stepper< Scalar >.

Definition at line 156 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setParameterList()

template<class Scalar>

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

Definition at line 341 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getNonconstParameterList()

template<class Scalar>

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

Definition at line 368 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ unsetParameterList()

template<class Scalar>

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

Definition at line 377 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getValidParameters()

template<class Scalar>

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

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 359 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getDefaultParameters()

template<class Scalar>

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

◆ description()

template<class Scalar>

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

inlinevirtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 170 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ describe()

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 283 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ isValidSetup()

template<class Scalar>

bool Tempus::StepperStaggeredForwardSensitivity< Scalar >::isValidSetup ( Teuchos::FancyOStream & out ) const

virtual

Reimplemented from Tempus::Stepper< Scalar >.

Definition at line 309 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ get_x_space()

template<class Scalar>

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

Definition at line 412 of file Tempus_StepperStaggeredForwardSensitivity_impl.hpp.

◆ getParameterList()

template<class Scalar>

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

inlinevirtual

Definition at line 180 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ getStepMode()

template<class Scalar>

SensitivityStepMode Tempus::StepperStaggeredForwardSensitivity< Scalar >::getStepMode ( ) const

inline

What mode the current time integration step is in.

Definition at line 184 of file Tempus_StepperStaggeredForwardSensitivity_decl.hpp.

◆ setParams()

template<class Scalar>

void Tempus::StepperStaggeredForwardSensitivity< Scalar >::setParams	(	const Teuchos::RCP< Teuchos::ParameterList > &	pl,
		const Teuchos::RCP< Teuchos::ParameterList > &	spl )