Time integrator implementing forward sensitivity analysis. More...

#include <Tempus_IntegratorForwardSensitivity_decl.hpp>

Inheritance diagram for Tempus::IntegratorForwardSensitivity< Scalar >:

Public Member Functions
	IntegratorForwardSensitivity (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar >> &model, const Teuchos::RCP< IntegratorBasic< Scalar >> &integrator, const Teuchos::RCP< SensitivityModelEvaluatorBase< Scalar >> &sens_model, const Teuchos::RCP< StepperStaggeredForwardSensitivity< Scalar >> &sens_stepper, const bool use_combined_method)
	Full Constructor with model, and will be fully initialized. More...

	IntegratorForwardSensitivity ()
	Destructor. More...

virtual	~IntegratorForwardSensitivity ()
	Destructor. More...

void	parseScreenOutput ()
	Parse when screen output should be executed. More...

SensitivityStepMode	getStepMode () const
	What mode the current time integration step is in. More...

Public Member Functions inherited from Tempus::Integrator< Scalar >
Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Public Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

Protected Attributes
Teuchos::RCP < Thyra::ModelEvaluator < Scalar > >	model_

Teuchos::RCP< IntegratorBasic < Scalar > >	integrator_

Teuchos::RCP < SensitivityModelEvaluatorBase < Scalar > >	sens_model_

Teuchos::RCP < StepperStaggeredForwardSensitivity < Scalar > >	sens_stepper_

bool	use_combined_method_

Basic integrator methods
virtual bool	advanceTime ()
	Advance the solution to timeMax, and return true if successful. More...

virtual bool	advanceTime (const Scalar timeFinal) override
	Advance the solution to timeFinal, and return true if successful. More...

virtual void	startIntegrator ()
	Perform tasks before start of integrator. More...

virtual void	startTimeStep ()
	Start time step. More...

virtual void	checkTimeStep ()
	Check if time step has passed or failed. More...

virtual void	endIntegrator ()
	Perform tasks after end of integrator. More...

Accessor methods
virtual Scalar	getTime () const override
	Get current time. More...

virtual int	getIndex () const override
	Get current index. More...

virtual Status	getStatus () const override
	Get Status. More...

virtual void	setStatus (const Status st) override
	Set the Status. More...

virtual Teuchos::RCP< Stepper < Scalar > >	getStepper () const override
	Get the Stepper. More...

virtual void	setStepper (Teuchos::RCP< Thyra::ModelEvaluator< Scalar >> model)
	Set the Stepper. More...

virtual void	setStepper (Teuchos::RCP< Stepper< Scalar >> stepper)
	Set the Stepper. More...

virtual void	initializeSolutionHistory (Teuchos::RCP< SolutionState< Scalar >> state=Teuchos::null)
	Set the initial state which has the initial conditions. More...

virtual void	initializeSolutionHistory (Scalar t0, Teuchos::RCP< const Thyra::VectorBase< Scalar >> x0, Teuchos::RCP< const Thyra::VectorBase< Scalar >> xdot0=Teuchos::null, Teuchos::RCP< const Thyra::VectorBase< Scalar >> xdotdot0=Teuchos::null, Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >> DxDp0=Teuchos::null, Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >> DxdotDp0=Teuchos::null, Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >> DxdotdotDp0=Teuchos::null)
	Set the initial state from Thyra::VectorBase(s) More...

virtual Teuchos::RCP< const SolutionHistory< Scalar > >	getSolutionHistory () const override
	Get the SolutionHistory. More...

virtual Teuchos::RCP < SolutionHistory< Scalar > >	getNonConstSolutionHistory () override
	Get the SolutionHistory. More...

virtual void	setSolutionHistory (Teuchos::RCP< SolutionHistory< Scalar >> sh=Teuchos::null)
	Set the SolutionHistory. More...

virtual Teuchos::RCP< const TimeStepControl< Scalar > >	getTimeStepControl () const override
	Get the TimeStepControl. More...

virtual Teuchos::RCP < TimeStepControl< Scalar > >	getNonConstTimeStepControl () override

virtual void	setTimeStepControl (Teuchos::RCP< TimeStepControl< Scalar >> tsc=Teuchos::null)
	Set the TimeStepControl. More...

virtual Teuchos::RCP < IntegratorObserver< Scalar > >	getObserver ()
	Get the Observer. More...

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

virtual void	initialize ()
	Initializes the Integrator after set* function calls. More...

virtual Teuchos::RCP < Teuchos::Time >	getIntegratorTimer () const override
	Returns the IntegratorTimer_ for this Integrator. More...

virtual Teuchos::RCP < Teuchos::Time >	getStepperTimer () const override

virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > >	getX () const
	Get the current solution, x, only. If looking for the solution vector and the sensitivities, use `SolutionState->getX()` which will return a Block MultiVector with the first block containing the current solution, x, and the remaining blocks are the forward sensitivities . More...

virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > >	getDxDp () const
	Get the forward sensitivities . More...

virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > >	getXDot () const
	Get current the time derivative of the solution, xdot, only. This is the first block only and not the full Block MultiVector. More...

virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > >	getDXDotDp () const

virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > >	getXDotDot () const
	Get current the second time derivative of the solution, xdotdot, only. This is the first block only and not the full Block MultiVector. More...

virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > >	getDXDotDotDp () const

virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > >	getG () const
	Return response function g. More...

virtual Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > >	getDgDp () const
	Return forward sensitivity stored in Jacobian format. More...

virtual Teuchos::RCP < SolutionState< Scalar > >	getCurrentState ()
	Get current state. More...

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

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

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

Detailed Description

template<class Scalar>
class Tempus::IntegratorForwardSensitivity< Scalar >

Time integrator implementing forward sensitivity analysis.

This integrator implements forward parameter sensitivity analysis by propagating the derivative of the solution with respect to model parameters alongside the solution. It supports sensitivity propagation methods:

"Combined" where the sensitivity and state equations are solved simultaneously. This is most appropriate for explicit time integration methods or implicit methods where a very-lightweight nonlinear solution strategy is used.
"Staggered" where the sensitivity equations are solved at each time step immediately after the state equations are solved. This is useful for implicit methods since it saves the cost of solving the sensitivity equations while the state equations are being solved. It generally does not work for explicit methods (and wouldn't be more efficient than the combined method even if it did).

Note that this integrator implements all of the same functions as the IntegratorBasic, but is not derived from IntegratorBasic. It also provides functions for setting the sensitivity initial conditions and extracting the sensitivity at the final time. One should use the getX() and getDxDp() methods for extracting the final solution and its parameter sensitivity as a multi-vector. This data can also be extracted from the solution history, but is stored as a Thyra product vector which requires knowledge of the internal implementation.

Definition at line 48 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::IntegratorForwardSensitivity< Scalar >::IntegratorForwardSensitivity	(	const Teuchos::RCP< Thyra::ModelEvaluator< Scalar >> &	model,
		const Teuchos::RCP< IntegratorBasic< Scalar >> &	integrator,
		const Teuchos::RCP< SensitivityModelEvaluatorBase< Scalar >> &	sens_model,
		const Teuchos::RCP< StepperStaggeredForwardSensitivity< Scalar >> &	sens_stepper,
		const bool	use_combined_method
	)

Full Constructor with model, and will be fully initialized.

Parameters

[in]	model	The forward physics ModelEvaluator
[in]	integrator	Forward state Integrator
[in]	sens_model	The sensitivity ModelEvaluator
[in]	sens_stepper	Tempus stepper for the sensitivity integration
[in]	use_combined_method	Indicates whether or not to use the "Combined" sensitivity method

In addition to all of the regular integrator options, the supplied parameter list supports the following options contained within a sublist "Sensitivities" from the top-level parameter list:

"Sensitivity Method" (default: "Combined") The sensitivity analysis method as described above.
"Reuse State Linear Solver" (default: false) For the staggered method, 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.
"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 23 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Tempus::IntegratorForwardSensitivity< Scalar >::IntegratorForwardSensitivity ( )

Destructor.

Constructor that requires a subsequent setStepper, and initialize calls.

Definition at line 40 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

virtual Tempus::IntegratorForwardSensitivity< Scalar >::~IntegratorForwardSensitivity ( )

inlinevirtual

Destructor.

Definition at line 102 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

Member Function Documentation

template<class Scalar >

virtual bool Tempus::IntegratorForwardSensitivity< Scalar >::advanceTime ( )

inlinevirtual

Advance the solution to timeMax, and return true if successful.

Definition at line 107 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual bool Tempus::IntegratorForwardSensitivity< Scalar >::advanceTime ( const Scalar timeFinal )

inlineoverridevirtual

Advance the solution to timeFinal, and return true if successful.

Implements Tempus::Integrator< Scalar >.

Definition at line 109 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::startIntegrator ( )

inlinevirtual

Perform tasks before start of integrator.

Definition at line 114 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::startTimeStep ( )

inlinevirtual

Start time step.

Definition at line 116 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::checkTimeStep ( )

inlinevirtual

Check if time step has passed or failed.

Definition at line 118 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::endIntegrator ( )

inlinevirtual

Perform tasks after end of integrator.

Definition at line 120 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Scalar Tempus::IntegratorForwardSensitivity< Scalar >::getTime ( ) const

inlineoverridevirtual

Get current time.

Implements Tempus::Integrator< Scalar >.

Definition at line 126 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual int Tempus::IntegratorForwardSensitivity< Scalar >::getIndex ( ) const

inlineoverridevirtual

Get current index.

Implements Tempus::Integrator< Scalar >.

Definition at line 128 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Status Tempus::IntegratorForwardSensitivity< Scalar >::getStatus ( ) const

inlineoverridevirtual

Get Status.

Implements Tempus::Integrator< Scalar >.

Definition at line 130 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::setStatus ( const Status st )

inlineoverridevirtual

Set the Status.

Implements Tempus::Integrator< Scalar >.

Definition at line 132 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<Stepper<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getStepper ( ) const

inlineoverridevirtual

Get the Stepper.

Implements Tempus::Integrator< Scalar >.

Definition at line 137 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

void Tempus::IntegratorForwardSensitivity< Scalar >::setStepper ( Teuchos::RCP< Thyra::ModelEvaluator< Scalar >> model )

virtual

Set the Stepper.

Definition at line 47 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::setStepper ( Teuchos::RCP< Stepper< Scalar >> stepper )

inlinevirtual

Set the Stepper.

Definition at line 146 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::initializeSolutionHistory ( Teuchos::RCP< SolutionState< Scalar >> state = Teuchos::null )

inlinevirtual

Set the initial state which has the initial conditions.

Definition at line 151 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

void Tempus::IntegratorForwardSensitivity< Scalar >::initializeSolutionHistory	(	Scalar	t0,
		Teuchos::RCP< const Thyra::VectorBase< Scalar >>	x0,
		Teuchos::RCP< const Thyra::VectorBase< Scalar >>	xdot0 = `Teuchos::null`,
		Teuchos::RCP< const Thyra::VectorBase< Scalar >>	xdotdot0 = `Teuchos::null`,
		Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >>	DxDp0 = `Teuchos::null`,
		Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >>	DxdotDp0 = `Teuchos::null`,
		Teuchos::RCP< const Thyra::MultiVectorBase< Scalar >>	DxdotdotDp0 = `Teuchos::null`
	)

virtual

Set the initial state from Thyra::VectorBase(s)

Definition at line 57 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

virtual Teuchos::RCP<const SolutionHistory<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getSolutionHistory ( ) const

inlineoverridevirtual

Get the SolutionHistory.

Implements Tempus::Integrator< Scalar >.

Definition at line 169 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<SolutionHistory<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getNonConstSolutionHistory ( )

inlineoverridevirtual

Get the SolutionHistory.

Implements Tempus::Integrator< Scalar >.

Definition at line 175 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::setSolutionHistory ( Teuchos::RCP< SolutionHistory< Scalar >> sh = Teuchos::null )

inlinevirtual

Set the SolutionHistory.

Definition at line 181 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<const TimeStepControl<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getTimeStepControl ( ) const

inlineoverridevirtual

Get the TimeStepControl.

Implements Tempus::Integrator< Scalar >.

Definition at line 187 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<TimeStepControl<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getNonConstTimeStepControl ( )

inlineoverridevirtual

Implements Tempus::Integrator< Scalar >.

Definition at line 192 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::setTimeStepControl ( Teuchos::RCP< TimeStepControl< Scalar >> tsc = Teuchos::null )

inlinevirtual

Set the TimeStepControl.

Definition at line 198 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<IntegratorObserver<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getObserver ( )

inlinevirtual

Get the Observer.

Definition at line 204 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::setObserver ( Teuchos::RCP< IntegratorObserver< Scalar >> obs = Teuchos::null )

inlinevirtual

Set the Observer.

Definition at line 209 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual void Tempus::IntegratorForwardSensitivity< Scalar >::initialize ( )

inlinevirtual

Initializes the Integrator after set* function calls.

Definition at line 215 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<Teuchos::Time> Tempus::IntegratorForwardSensitivity< Scalar >::getIntegratorTimer ( ) const

inlineoverridevirtual

Returns the IntegratorTimer_ for this Integrator.

Implements Tempus::Integrator< Scalar >.

Definition at line 216 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

virtual Teuchos::RCP<Teuchos::Time> Tempus::IntegratorForwardSensitivity< Scalar >::getStepperTimer ( ) const

inlineoverridevirtual

Implements Tempus::Integrator< Scalar >.

Definition at line 220 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::VectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getX ( ) const

virtual

Get the current solution, x, only. If looking for the solution vector and the sensitivities, use SolutionState->getX() which will return a Block MultiVector with the first block containing the current solution, x, and the remaining blocks are the forward sensitivities $dx/dp$ .

Use getDxDp to get the forward sensitivities $dx/dp$ only.

Returns: The current solution, x, without the sensitivities.

Definition at line 120 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getDxDp ( ) const

virtual

Get the forward sensitivities $dx/dp$ .

Definition at line 132 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::VectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getXDot ( ) const

virtual

Get current the time derivative of the solution, xdot, only. This is the first block only and not the full Block MultiVector.

Returns: Get current the time derivative of the solution, xdot.

Definition at line 146 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getDXDotDp ( ) const

virtual

Definition at line 158 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::VectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getXDotDot ( ) const

virtual

Get current the second time derivative of the solution, xdotdot, only. This is the first block only and not the full Block MultiVector.

Use getDXDotDp to get the forward sensitivities.

Returns: Get current the second time derivative of the solution, xdotdot.

Definition at line 172 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getDXDotDotDp ( ) const

virtual

Definition at line 185 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::VectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getG ( ) const

virtual

Return response function g.

Definition at line 200 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > Tempus::IntegratorForwardSensitivity< Scalar >::getDgDp ( ) const

virtual

Return forward sensitivity stored in Jacobian format.

Definition at line 230 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

virtual Teuchos::RCP<SolutionState<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::getCurrentState ( )

inlinevirtual

Get current state.

Definition at line 265 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

void Tempus::IntegratorForwardSensitivity< Scalar >::parseScreenOutput ( )

inline

Parse when screen output should be executed.

Definition at line 272 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

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

overridevirtual

Reimplemented from Teuchos::Describable.

Definition at line 261 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

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

overridevirtual

Reimplemented from Teuchos::Describable.

Definition at line 268 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

template<class Scalar >

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

What mode the current time integration step is in.

Definition at line 280 of file Tempus_IntegratorForwardSensitivity_impl.hpp.

Member Data Documentation

template<class Scalar >

Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::model_

protected

Definition at line 285 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

Teuchos::RCP<IntegratorBasic<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::integrator_

protected

Definition at line 286 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

Teuchos::RCP<SensitivityModelEvaluatorBase<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::sens_model_

protected

Definition at line 287 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

Teuchos::RCP<StepperStaggeredForwardSensitivity<Scalar> > Tempus::IntegratorForwardSensitivity< Scalar >::sens_stepper_

protected

Definition at line 288 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

template<class Scalar >

bool Tempus::IntegratorForwardSensitivity< Scalar >::use_combined_method_

protected

Definition at line 289 of file Tempus_IntegratorForwardSensitivity_decl.hpp.

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

Public Member Functions

Protected Attributes

Basic integrator methods

Accessor methods

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::IntegratorForwardSensitivity< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::IntegratorForwardSensitivity< Scalar >