Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Tempus::AuxiliaryIntegralModelEvaluator< Scalar > Class Template Reference

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 Member Functions

 AuxiliaryIntegralModelEvaluator (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int g_index)
 Constructor.
 
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel () const
 Get the underlying model 'f'.
 
void setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
 Set solution history from forward evaluation.
 

Public functions overridden from ModelEvaulator.

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_
 
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
 
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl () const
 
void evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
 

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

◆ Vector

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

◆ MultiVector

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

Constructor & Destructor Documentation

◆ AuxiliaryIntegralModelEvaluator()

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

Constructor.

Definition at line 19 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

Member Function Documentation

◆ getModel()

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.

◆ setForwardSolutionHistory()

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 54 of file Tempus_AuxiliaryIntegralModelEvaluator_impl.hpp.

◆ get_p_space()

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

◆ get_p_names()

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

◆ get_x_space()

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

◆ get_f_space()

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

◆ create_W_op()

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

◆ get_W_factory()

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

◆ createInArgs()

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

◆ getNominalValues()

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

◆ createOutArgsImpl()

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

◆ evalModelImpl()

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

Member Data Documentation

◆ prototypeInArgs_

template<typename Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::prototypeInArgs_
private

◆ prototypeOutArgs_

template<typename Scalar >
Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::prototypeOutArgs_
private

◆ model_

template<typename Scalar >
Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::model_
private

◆ space_

template<typename Scalar >
Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::space_
private

◆ sh_

template<typename Scalar >
Teuchos::RCP<const Tempus::SolutionHistory<Scalar> > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::sh_
private

◆ g_index_

template<typename Scalar >
int Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::g_index_
private

◆ forward_state_

template<typename Scalar >
Teuchos::RCP<Tempus::SolutionState<Scalar> > Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::forward_state_
mutableprivate

◆ t_interp_

template<typename Scalar >
Scalar Tempus::AuxiliaryIntegralModelEvaluator< Scalar >::t_interp_
mutableprivate

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