Rythmos::SimpleIntegrator

Rythmos::SimpleIntegrator< Scalar > Class Template Reference

A very simple concrete subclass for IntegratorBase that allows just for simple fixed steps or variable steps. More...

#include <Rythmos_SimpleIntegrator.hpp>

Inheritance diagram for Rythmos::SimpleIntegrator< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors, Initializers, Misc

 SimpleIntegrator ()
 
void setIntegrationControlStrategy (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy)
 
void setIntegrationObserver (const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterList > getValidParameters () const
 

Overridden from IntegratorBase

RCP< IntegratorBase< Scalar > > cloneIntegrator () const
 
void setStepper (const RCP< StepperBase< Scalar > > &stepper, const Scalar &finalTime, const bool landOnFinalTime)
 
RCP< StepperBase< Scalar > > unSetStepper ()
 
Teuchos::RCP< const StepperBase<
Scalar > > 		getStepper () const
 
void getFwdPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec)
 
TimeRange< Scalar > getFwdTimeRange () const
 

Overridden from InterpolationBufferBase

RCP< const Thyra::VectorSpaceBase<
Scalar > > 		get_x_space () const
 
void addPoints (const Array< Scalar > &time_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
 
void getPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec) const
 
TimeRange< Scalar > getTimeRange () const
 
void getNodes (Array< Scalar > *time_vec) const
 
void removeNodes (Array< Scalar > &time_vec)
 
int getOrder () const
 

Public Types

typedef ScalarTraits< Scalar
>::magnitudeType 		ScalarMag
 

Related Functions

(Note that these are not member functions.)

RCP< SimpleIntegrator< Scalar > > simpleIntegrator ()
 
RCP< SimpleIntegrator< Scalar > > controlledSimpleIntegrator (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy)
 
RCP< SimpleIntegrator< Scalar > > observedSimpleIntegrator (const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 
RCP< SimpleIntegrator< Scalar > > simpleIntegrator (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy, const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 

Detailed Description

template<class Scalar>
class Rythmos::SimpleIntegrator< Scalar >

A very simple concrete subclass for IntegratorBase that allows just for simple fixed steps or variable steps.

Definition at line 51 of file Rythmos_SimpleIntegrator.hpp.

Member Typedef Documentation

template<class Scalar>
typedef ScalarTraits<Scalar>::magnitudeType Rythmos::SimpleIntegrator< Scalar >::ScalarMag

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 58 of file Rythmos_SimpleIntegrator.hpp.

Constructor & Destructor Documentation

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

Definition at line 276 of file Rythmos_SimpleIntegrator.hpp.

Member Function Documentation

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::setIntegrationControlStrategy ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy  ) 

Definition at line 284 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::setIntegrationObserver ( const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver  ) 

Definition at line 296 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList  )  [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 311 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< const ParameterList > Rythmos::SimpleIntegrator< Scalar >::getValidParameters (  )  const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 326 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< IntegratorBase< Scalar > > Rythmos::SimpleIntegrator< Scalar >::cloneIntegrator (  )  const [virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 346 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::setStepper ( const RCP< StepperBase< Scalar > > &  stepper,
const Scalar &  finalTime,
const bool  landOnFinalTime 
) [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 366 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< StepperBase< Scalar > > Rythmos::SimpleIntegrator< Scalar >::unSetStepper (  )  [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 393 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
Teuchos::RCP< const StepperBase< Scalar > > Rythmos::SimpleIntegrator< Scalar >::getStepper (  )  const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 401 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::getFwdPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  x_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
)

Definition at line 407 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
TimeRange< Scalar > Rythmos::SimpleIntegrator< Scalar >::getFwdTimeRange (  )  const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 513 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::SimpleIntegrator< Scalar >::get_x_space (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 525 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::addPoints ( const Array< Scalar > &  time_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  x_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  xdot_vec 
) [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 536 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::getPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  x_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
) const

Definition at line 547 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
TimeRange< Scalar > Rythmos::SimpleIntegrator< Scalar >::getTimeRange (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 559 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::getNodes ( Array< Scalar > *  time_vec  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 566 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
void Rythmos::SimpleIntegrator< Scalar >::removeNodes ( Array< Scalar > &  time_vec  )  [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 573 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
int Rythmos::SimpleIntegrator< Scalar >::getOrder (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 580 of file Rythmos_SimpleIntegrator.hpp.

Friends And Related Function Documentation

template<class Scalar>
RCP< SimpleIntegrator< Scalar > > simpleIntegrator (  )  [related]

Definition at line 189 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< SimpleIntegrator< Scalar > > controlledSimpleIntegrator ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy  )  [related]

Definition at line 203 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< SimpleIntegrator< Scalar > > observedSimpleIntegrator ( const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver  )  [related]

Definition at line 220 of file Rythmos_SimpleIntegrator.hpp.

template<class Scalar>
RCP< SimpleIntegrator< Scalar > > simpleIntegrator ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy,
const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver 
) [related]

Definition at line 237 of file Rythmos_SimpleIntegrator.hpp.

The documentation for this class was generated from the following file:
Generated on Tue Oct 20 12:46:10 2009 for Rythmos - Transient Integration for Differential Equations by doxygen 1.4.7