ModelEvaluator for integrating auxiliary equations. More...

#include <Tempus_AuxiliaryIntegralModelEvaluator_decl.hpp>

Inheritance diagram for Tempus::AuxiliaryIntegralModelEvaluator< Scalar >:

Public Types
typedef Thyra::VectorBase< Scalar >	Vector

typedef Thyra::MultiVectorBase < Scalar >	MultiVector

Public Types inherited from Thyra::ModelEvaluator< class >
enum	EInArgsMembers

enum	EInArgs_p_mp

enum	EEvalType

enum	EDerivativeMultiVectorOrientation

enum	EDerivativeLinearOp

enum	EDerivativeLinearity

enum	ERankStatus

enum	EOutArgsMembers

enum	EOutArgsDfDp

enum	EOutArgsDgDx_dot

enum	EOutArgsDgDx

enum	EOutArgsDgDp

enum	EOutArgs_hess_vec_prod_f_xx

enum	EOutArgs_hess_vec_prod_f_xp

enum	EOutArgs_hess_vec_prod_f_px

enum	EOutArgs_hess_vec_prod_f_pp

enum	EOutArgs_hess_vec_prod_g_xx

enum	EOutArgs_hess_vec_prod_g_xp

enum	EOutArgs_hess_vec_prod_g_px

enum	EOutArgs_hess_vec_prod_g_pp

enum	EOutArgs_hess_f_xx

enum	EOutArgs_hess_f_xp

enum	EOutArgs_hess_f_pp

enum	EOutArgs_hess_g_xx

enum	EOutArgs_hess_g_xp

enum	EOutArgs_hess_g_pp

enum	EOutArgs_H_xx

enum	EOutArgs_H_xp

enum	EOutArgs_H_pp

enum	EOutArgsDfDp_mp

enum	EOutArgs_g_mp

enum	EOutArgsDgDx_dot_mp

enum	EOutArgsDgDx_mp

enum	EOutArgsDgDp_mp

typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Public Member Functions
	AuxiliaryIntegralModelEvaluator (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int g_index)
	Constructor. More...

Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel () const
	Get the underlying model 'f'. More...

void	setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
	Set solution history from forward evaluation. More...

Public Member Functions inherited from Thyra::StateFuncModelEvaluatorBase< Scalar >
RCP< const VectorSpaceBase < Scalar > >	get_p_space (int l) const

RCP< const Teuchos::Array < std::string > >	get_p_names (int l) const

RCP< const VectorSpaceBase < Scalar > >	get_g_space (int j) const

Teuchos::ArrayView< const std::string >	get_g_names (int j) const

ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const

ModelEvaluatorBase::InArgs < Scalar >	getLowerBounds () const

ModelEvaluatorBase::InArgs < Scalar >	getUpperBounds () const

RCP< LinearOpBase< Scalar > >	create_W_op () const

RCP< PreconditionerBase< Scalar > >	create_W_prec () const

RCP< const LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const

void	reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)

Public Member Functions inherited from Thyra::ModelEvaluator< class >
virtual int	Np () const =0

virtual int	Ng () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_f_multiplier_space () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_g_multiplier_space (int j) const =0

virtual RCP < LinearOpWithSolveBase < Scalar > >	create_W () const =0

virtual RCP< LinearOpBase < Scalar > >	create_DfDp_op (int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDx_dot_op (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDx_op (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDp_op (int j, int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_xx () const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_xp (int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_pp (int l1, int l2) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_xx (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_xp (int j, int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_pp (int j, int l1, int l2) const =0

virtual ModelEvaluatorBase::OutArgs < Scalar >	createOutArgs () const =0

virtual void	evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const =0

	ModelEvaluatorBase ()

std::string	toString (ModelEvaluatorBase::EInArgsMembers)

std::string	toString (ModelEvaluatorBase::EOutArgsMembers)

std::string	toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)

ModelEvaluatorBase::EDerivativeMultiVectorOrientation	getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

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)

Private Member Functions
Thyra::ModelEvaluatorBase::OutArgs < Scalar >	createOutArgsImpl () const

void	evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

Private Attributes
Thyra::ModelEvaluatorBase::InArgs < Scalar >	prototypeInArgs_

Thyra::ModelEvaluatorBase::OutArgs < Scalar >	prototypeOutArgs_

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

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	space_

Teuchos::RCP< const Tempus::SolutionHistory < Scalar > >	sh_

int	g_index_

Teuchos::RCP < Tempus::SolutionState < Scalar > >	forward_state_

Scalar	t_interp_

Public functions overridden from ModelEvaulator.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_p_space (int p) const

Teuchos::RCP< const Teuchos::Array< std::string > >	get_p_names (int p) const

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

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

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

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

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

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

Additional Inherited Members
Static Public Attributes inherited from Thyra::ModelEvaluator< class >
static const int	NUM_E_IN_ARGS_MEMBERS

static const int	NUM_E_OUT_ARGS_MEMBERS

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

Detailed Description

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

ModelEvaluator for integrating auxiliary equations.

Given a ModelEvaluator defining an auxiliary/response function g(x_dot,x,p,t) this ModelEvaluator defines a new ODE dz/dt = g(x_dot(t),x(t),p,t) used to compute the integral of g over some time range. This ModelEvaluator can then be used by Tempus to compute the definite integral.

Definition at line 28 of file Tempus_AuxiliaryIntegralModelEvaluator_decl.hpp.

Member Typedef Documentation

template<typename Scalar >

typedef Thyra::VectorBase<Scalar> Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::Vector

Definition at line 31 of file Tempus_AuxiliaryIntegralModelEvaluator_decl.hpp.

template<typename Scalar >

typedef Thyra::MultiVectorBase<Scalar> Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::MultiVector

Definition at line 32 of file Tempus_AuxiliaryIntegralModelEvaluator_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::AuxiliaryIntegralModelEvaluator	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const int	g_index
	)

Constructor.

Definition at line 20 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

Member Function Documentation

template<typename Scalar >

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

inline

Get the underlying model 'f'.

Definition at line 40 of file Tempus_AuxiliaryIntegralModelEvaluator_decl.hpp.

template<typename Scalar >

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

Set solution history from forward evaluation.

Definition at line 55 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::get_p_space ( int p ) const

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 66 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

Teuchos::RCP< const Teuchos::Array< std::string > > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::get_p_names ( int p ) const

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 75 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

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

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 84 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

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

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 92 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

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

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 100 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

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

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 108 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::createInArgs ( ) const

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 116 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::getNominalValues ( ) const

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 124 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::OutArgs< Scalar > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::createOutArgsImpl ( ) const

private

Definition at line 156 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

template<typename Scalar >

void Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::evalModelImpl	(	const Thyra::ModelEvaluatorBase::InArgs< Scalar > &	inArgs,
		const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &	outArgs
	)		const