Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Types | Protected Attributes | Private Member Functions | List of all members
Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar > Class Template Reference

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

#include <Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >:
Tempus::SensitivityModelEvaluatorBase< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar > Thyra::ModelEvaluatorDefaultBase< Scalar > Tempus::WrapperModelEvaluatorPairIMEX< Scalar > Thyra::ModelEvaluator< class > Tempus::WrapperModelEvaluator< Scalar > Thyra::ModelEvaluatorBase Thyra::StateFuncModelEvaluatorBase< Scalar > Teuchos::Describable Thyra::ModelEvaluatorDefaultBase< Scalar > Teuchos::LabeledObject Thyra::ModelEvaluator< class > Thyra::ModelEvaluatorBase Teuchos::Describable Teuchos::LabeledObject

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. More...
 
virtual ~WrapperModelEvaluatorPairIMEX_StaggeredFSA ()
 Destructor. More...
 
- Public Member Functions inherited from Tempus::SensitivityModelEvaluatorBase< Scalar >
 SensitivityModelEvaluatorBase ()
 Constructor. More...
 
virtual ~SensitivityModelEvaluatorBase ()
 Destructor. More...
 
- 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)
 
- 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. More...
 
virtual ~WrapperModelEvaluatorPairIMEX_Basic ()
 Destructor. More...
 
virtual void initialize ()
 Initialize after setting member data. More...
 
virtual void setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
 Set the underlying application ModelEvaluator. More...
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getAppModel () const
 Get the underlying application ModelEvaluator. More...
 
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. More...
 
virtual Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_x_space () const
 Get the x-solution space. More...
 
virtual Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_g_space (int i) const
 Get the g space. More...
 
virtual Teuchos::RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_p_space (int i) const
 Get the p space. More...
 
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
 
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
 
- Public Member Functions inherited from Tempus::WrapperModelEvaluatorPairIMEX< Scalar >
- Public Member Functions inherited from Tempus::WrapperModelEvaluator< Scalar >
- 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)
 

Protected Types

typedef
WrapperModelEvaluatorPairIMEX_Basic
< Scalar > 
Base
 
typedef
StaggeredForwardSensitivityModelEvaluator
< Scalar > 
FSAME
 

Protected Attributes

Teuchos::RCP< const
WrapperModelEvaluatorPairIMEX_Basic
< Scalar > > 
forwardModel_
 
Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
appExplicitModel_
 
Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
appImplicitModel_
 
Teuchos::RCP< FSAMEfsaExplicitModel_
 
Teuchos::RCP< FSAMEfsaImplicitModel_
 
- 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_
 

Private Member Functions

 WrapperModelEvaluatorPairIMEX_StaggeredFSA ()
 Default constructor - not allowed. More...
 

Overridden from Tempus::SensitivityModelEvaluatorBase

virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 
getForwardModel () const
 Get the underlying forward model. More...
 
virtual void setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
 Set solution history from forward state evaluation (for interpolation) More...
 
virtual void setForwardSolutionState (const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &s)
 Set solution state from forward state evaluation (for frozen state) More...
 
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. More...
 

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
 
- Protected Member Functions inherited from Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >
 WrapperModelEvaluatorPairIMEX_Basic ()
 Default constructor – only allowed for derived classes. More...
 
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. More...
 

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

template<typename Scalar >
typedef WrapperModelEvaluatorPairIMEX_Basic<Scalar> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::Base
protected
template<typename Scalar >
typedef StaggeredForwardSensitivityModelEvaluator<Scalar> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::FSAME
protected

Constructor & Destructor Documentation

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.

template<typename Scalar >
virtual Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::~WrapperModelEvaluatorPairIMEX_StaggeredFSA ( )
inlinevirtual

Destructor.

Definition at line 51 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Default constructor - not allowed.

Definition at line 91 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Member Function Documentation

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.

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.

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.

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

Set the solver of the underlying model if you want to reuse it.

Reimplemented from Tempus::SensitivityModelEvaluatorBase< Scalar >.

Definition at line 80 of file Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.hpp.

Member Data Documentation

template<typename Scalar >
Teuchos::RCP<const WrapperModelEvaluatorPairIMEX_Basic<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::forwardModel_
protected
template<typename Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::appExplicitModel_
protected
template<typename Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::appImplicitModel_
protected
template<typename Scalar >
Teuchos::RCP<FSAME> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::fsaExplicitModel_
protected
template<typename Scalar >
Teuchos::RCP<FSAME> Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >::fsaImplicitModel_
protected

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