Rythmos::SingleResidualModelEvaluator< Scalar > Class Template Reference

Decorator subclass for a steady-state version of a DAE for single-residual time stepper methods. More...

#include <Rythmos_SingleResidualModelEvaluator.hpp>

Inheritance diagram for Rythmos::SingleResidualModelEvaluator< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

 SingleResidualModelEvaluator ()
 

Overridden from SingleResidualModelEvaluatorBase

void initializeSingleResidualModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &daeModel, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &basePoint, const Scalar &coeff_x_dot, const RCP< const Thyra::VectorBase< Scalar > > &x_dot_base, const Scalar &coeff_x, const RCP< const Thyra::VectorBase< Scalar > > &x_base, const Scalar &t_base, const RCP< const Thyra::VectorBase< Scalar > > &x_bar_init)
 
Scalar get_coeff_x_dot () const
 
RCP< const Thyra::VectorBase<
Scalar > > 
get_x_dot_base () const
 
Scalar get_coeff_x () const
 
RCP< const Thyra::VectorBase<
Scalar > > 
get_x_base () const
 
Scalar get_t_base () const
 

Public functions overridden from ModelEvaluator

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

Detailed Description

template<class Scalar>
class Rythmos::SingleResidualModelEvaluator< Scalar >

Decorator subclass for a steady-state version of a DAE for single-residual time stepper methods.

This class provides a set of nonlinear equations of the form:

 f_bar(x_bar) = f( coeff_x_dot * x_bar + x_dot_base, coeff_x * x_bar + x_base, t_base ) = 0
 

with initial starting guess x_bar_init.

The Jacobian of this model is:

 beta * d(f_bar)/d(x_bar) = (beta*coeff_x_dot) * d(f)/d(x_dot) + (beta*coeff_x) * d(f)/d(x)
 

ToDo: Finish Documentation!

Definition at line 67 of file Rythmos_SingleResidualModelEvaluator.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Rythmos::SingleResidualModelEvaluator< Scalar >::SingleResidualModelEvaluator (  ) 

Definition at line 167 of file Rythmos_SingleResidualModelEvaluator.hpp.


Member Function Documentation

template<class Scalar>
void Rythmos::SingleResidualModelEvaluator< Scalar >::initializeSingleResidualModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  daeModel,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  basePoint,
const Scalar &  coeff_x_dot,
const RCP< const Thyra::VectorBase< Scalar > > &  x_dot_base,
const Scalar &  coeff_x,
const RCP< const Thyra::VectorBase< Scalar > > &  x_base,
const Scalar &  t_base,
const RCP< const Thyra::VectorBase< Scalar > > &  x_bar_init 
) [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 175 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
Scalar Rythmos::SingleResidualModelEvaluator< Scalar >::get_coeff_x_dot (  )  const [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 239 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
RCP< const Thyra::VectorBase< Scalar > > Rythmos::SingleResidualModelEvaluator< Scalar >::get_x_dot_base (  )  const [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 247 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
Scalar Rythmos::SingleResidualModelEvaluator< Scalar >::get_coeff_x (  )  const [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 254 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
RCP< const Thyra::VectorBase< Scalar > > Rythmos::SingleResidualModelEvaluator< Scalar >::get_x_base (  )  const [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 262 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
Scalar Rythmos::SingleResidualModelEvaluator< Scalar >::get_t_base (  )  const [virtual]

Implements Rythmos::SingleResidualModelEvaluatorBase< Scalar >.

Definition at line 269 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::SingleResidualModelEvaluator< Scalar >::getNominalValues (  )  const

.

Definition at line 280 of file Rythmos_SingleResidualModelEvaluator.hpp.

template<class Scalar>
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::SingleResidualModelEvaluator< Scalar >::createInArgs (  )  const

Definition at line 288 of file Rythmos_SingleResidualModelEvaluator.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:23:55 2010 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.4.7