Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Tempus::WrapperModelEvaluatorPairIMEX< Scalar > Class Template Referenceabstract

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

#include <Tempus_WrapperModelEvaluatorPairIMEX.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorPairIMEX< Scalar >:
Tempus::WrapperModelEvaluator< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar > Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_CombinedFSA< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar > Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar > Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >

Public Member Functions

virtual void initialize ()=0
 Initialize after setting member data. More...
 
virtual void setForSolve (Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE evaluationType=SOLVE_FOR_X)=0
 Set parameters for application implicit ModelEvaluator solve. More...
 
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
 
- 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 setInArgs (Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)=0
 Set InArgs the wrapper ModelEvalutor. More...
 
virtual
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 		getInArgs ()=0
 Get InArgs the wrapper ModelEvalutor. More...
 
virtual void setOutArgs (Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)=0
 Set OutArgs the wrapper ModelEvalutor. More...
 
virtual
Thyra::ModelEvaluatorBase::OutArgs
< Scalar > 		getOutArgs ()=0
 Get OutArgs the wrapper ModelEvalutor. More...
 

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 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX< Scalar >::create_W_op ( ) const
pure virtual

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

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 >.

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

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::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_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::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.

template<typename Scalar >
Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX< Scalar >::get_W_factory ( ) const
pure virtual

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_x_space ( ) const
pure virtual

Get the x-solution space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

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

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

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

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

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

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

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

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_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.

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

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

template<typename Scalar >
virtual void Tempus::WrapperModelEvaluatorPairIMEX< Scalar >::setForSolve ( Teuchos::RCP< TimeDerivative< Scalar > >  timeDer,
Thyra::ModelEvaluatorBase::InArgs< Scalar >  inArgs,
Thyra::ModelEvaluatorBase::OutArgs< Scalar >  outArgs,
EVALUATION_TYPE  evaluationType = SOLVE_FOR_X 
)
pure virtual

Set parameters for application implicit ModelEvaluator solve.

Implements Tempus::WrapperModelEvaluator< Scalar >.

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

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

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

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