Specialization of IMEX ME for "staggered" FSA method. More...

#include <Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >:

Public Member Functions
	WrapperModelEvaluatorPairIMEX_StaggeredFSA (const Teuchos::RCP< const WrapperModelEvaluatorPairIMEX_Basic< Scalar > > &forwardModel, const bool is_pseudotransient, const Teuchos::RCP< const Teuchos::ParameterList > &pList=Teuchos::null)
	Constructor.

virtual	~WrapperModelEvaluatorPairIMEX_StaggeredFSA ()
	Destructor.

Public Member Functions inherited from Tempus::SensitivityModelEvaluatorBase< Scalar >
	SensitivityModelEvaluatorBase ()
	Constructor.

virtual	~SensitivityModelEvaluatorBase ()
	Destructor.

Public Member Functions inherited from Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >
	WrapperModelEvaluatorPairIMEX_Basic (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel)
	Constructor.

virtual	~WrapperModelEvaluatorPairIMEX_Basic ()
	Destructor.

virtual void	initialize ()
	Initialize after setting member data.

virtual Teuchos::RCP< Thyra::LinearOpBase< Scalar > >	create_W_op () const

Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > >	get_W_factory () const

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_f_space () const

virtual Thyra::ModelEvaluatorBase::InArgs< Scalar >	getNominalValues () const

virtual Thyra::ModelEvaluatorBase::InArgs< Scalar >	createInArgs () const

virtual Thyra::ModelEvaluatorBase::OutArgs< Scalar >	createOutArgsImpl () const

virtual void	evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &in, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &out) const

virtual void	setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
	Set the underlying application ModelEvaluator.

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getAppModel () const
	Get the underlying application ModelEvaluator.

void	setForSolve (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=-1)
	Set parameters for application implicit ModelEvaluator solve.

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const
	Get the x-solution space.

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_g_space (int i) const
	Get the g space.

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_p_space (int i) const
	Get the p space.

virtual void	setExplicitModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)

virtual void	setImplicitModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)

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

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

Public Member Functions inherited from Tempus::WrapperModelEvaluatorPairIMEX< Scalar >
Public Member Functions inherited from Tempus::WrapperModelEvaluator< Scalar >

Overridden from Tempus::SensitivityModelEvaluatorBase
typedef WrapperModelEvaluatorPairIMEX_Basic< Scalar >	Base

typedef StaggeredForwardSensitivityModelEvaluator< Scalar >	FSAME

Teuchos::RCP< const WrapperModelEvaluatorPairIMEX_Basic< Scalar > >	forwardModel_

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appExplicitModel_

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appImplicitModel_

Teuchos::RCP< FSAME >	fsaExplicitModel_

Teuchos::RCP< FSAME >	fsaImplicitModel_

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getForwardModel () const
	Get the underlying forward model.

virtual void	setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
	Set solution history from forward state evaluation (for interpolation)

virtual void	setForwardSolutionState (const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &s)
	Set solution state from forward state evaluation (for frozen state)

virtual void	setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const bool force_W_update)
	Set the solver of the underlying model if you want to reuse it.

	WrapperModelEvaluatorPairIMEX_StaggeredFSA ()
	Default constructor - not allowed.

Additional Inherited Members
Protected Member Functions inherited from Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >
	WrapperModelEvaluatorPairIMEX_Basic ()
	Default constructor – only allowed for derived classes.

void	setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel)
	Setup ME when using default constructor – for derived classes.

Protected Attributes inherited from Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	explicitModel_

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	implicitModel_

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

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

Scalar	time_

Teuchos::RCP< ImplicitODEParameters< Scalar > >	p_

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

int	index_

Teuchos::RCP< TimeDerivative< Scalar > >	timeDer_

Detailed Description

template<typename Scalar>
class Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >

Specialization of IMEX ME for "staggered" FSA method.

This specializes the implementation of several parts of WrapperModelEvaluatorPairIMEX_Basic for forward-sensitivity analysis with StaggeredForwardSensitivityModelEvaluator.

Definition at line 27 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Member Typedef Documentation

◆ Base

template<typename Scalar >

typedef WrapperModelEvaluatorPairIMEX_Basic<Scalar> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::Base

protected

Definition at line 94 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ FSAME

template<typename Scalar >

typedef StaggeredForwardSensitivityModelEvaluator<Scalar> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::FSAME

protected

Definition at line 95 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Constructor & Destructor Documentation

◆ WrapperModelEvaluatorPairIMEX_StaggeredFSA() [1/2]

template<typename Scalar >

Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::WrapperModelEvaluatorPairIMEX_StaggeredFSA	(	const Teuchos::RCP< const WrapperModelEvaluatorPairIMEX_Basic< Scalar > > &	forwardModel,
		const bool	is_pseudotransient,
		const Teuchos::RCP< const Teuchos::ParameterList > &	pList = `Teuchos::null`
	)

inline

Constructor.

Definition at line 32 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ ~WrapperModelEvaluatorPairIMEX_StaggeredFSA()

template<typename Scalar >

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

inlinevirtual

Destructor.

Definition at line 51 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ WrapperModelEvaluatorPairIMEX_StaggeredFSA() [2/2]

template<typename Scalar >

Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::WrapperModelEvaluatorPairIMEX_StaggeredFSA ( )

inlineprivate

Default constructor - not allowed.

Definition at line 91 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Member Function Documentation

◆ getForwardModel()

template<typename Scalar >

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::getForwardModel ( ) const

inlinevirtual

Get the underlying forward model.

Reimplemented from Tempus::SensitivityModelEvaluatorBase< Scalar >.

Definition at line 57 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ setForwardSolutionHistory()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::setForwardSolutionHistory ( const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > & sh )

inlinevirtual

Set solution history from forward state evaluation (for interpolation)

Reimplemented from Tempus::SensitivityModelEvaluatorBase< Scalar >.

Definition at line 64 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ setForwardSolutionState()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::setForwardSolutionState ( const Teuchos::RCP< const Tempus::SolutionState< Scalar > > & s )

inlinevirtual

Set solution state from forward state evaluation (for frozen state)

Reimplemented from Tempus::SensitivityModelEvaluatorBase< Scalar >.

Definition at line 72 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

◆ setSolver()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::setSolver	(	const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		const bool	force_W_update
	)