ModelEvaluator pair for implicit and explicit (IMEX) evaluations. More...

#include <Tempus_WrapperModelEvaluatorPairIMEX.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorPairIMEX< Scalar >:

Public Member Functions
virtual void	initialize ()=0
	Initialize after setting member data. More...

Public Member Functions inherited from Tempus::WrapperModelEvaluator< Scalar >
virtual void	setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)=0
	Set the underlying application ModelEvaluator. More...

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

virtual 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)=0
	Set parameters for application implicit ModelEvaluator solve. 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 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)

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

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

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

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

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

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

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

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

Overridden from Thyra::StateFuncModelEvaluatorBase
virtual Teuchos::RCP < Thyra::LinearOpBase< Scalar > >	create_W_op () const =0

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

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

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

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

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

Additional Inherited Members
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	EOutArgsDfDp_mp

enum	EOutArgs_g_mp

enum	EOutArgsDgDx_dot_mp

enum	EOutArgsDgDx_mp

enum	EOutArgsDgDp_mp

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

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::WrapperModelEvaluatorPairIMEX< Scalar >

ModelEvaluator pair for implicit and explicit (IMEX) evaluations.

This is an interface for a ModelEvaluator that takes a state, x, and determines the explicit and implicit residuals.

This was taken and modified from Drekar's IMEXModelPair class.

Definition at line 25 of file Tempus_WrapperModelEvaluatorPairIMEX.hpp.

Member Function Documentation

template<typename Scalar >

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

pure virtual

Initialize after setting member data.

Implemented in Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.

template<typename Scalar >

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

pure virtual

Get the x-solution space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implements Thyra::ModelEvaluator< class >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX< Scalar >::get_g_space ( int i ) const

pure virtual

Get the g space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX< Scalar >::get_p_space ( int i ) const

pure virtual

Get the p space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implements Thyra::ModelEvaluator< class >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implements Thyra::ModelEvaluator< class >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implements Thyra::ModelEvaluator< class >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implements Thyra::ModelEvaluator< class >.

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >.

template<typename Scalar >

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

pure virtual

Implemented in Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.

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

Tempus_WrapperModelEvaluatorPairIMEX.hpp

Public Member Functions

Vector Methods.

Overridden from Thyra::StateFuncModelEvaluatorBase

Additional Inherited Members

Detailed Description

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

Member Function Documentation

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