Rythmos::StackedStepper< Scalar > Class Template Reference

Inheritance diagram for Rythmos::StackedStepper< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors, Intializers, Misc.

 StackedStepper ()
 Constructs to uninitialized.
void addStepper (const RCP< StepperBase< Scalar > > &stepper)
 Add a stepper to the stack.
ArrayView< const RCP< StepperBase<
Scalar > > > 
getNonconstSteppers () const
 Return the steppers that were passed into addStepper.
void setStackedStepperStepControlStrategy (const RCP< StackedStepperStepStrategyBase< Scalar > > &stepControl)
 Add a Step Control Strategy.
RCP< const StackedStepperStepStrategyBase<
Scalar > > 
getStackedStepperStepCongrolStrategy () const
 Get the Step Control Strategy.

Overridden from Teuchos::ParameterListAcceptor

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

Overridden from StepperBase

bool acceptsModel () const
 Returns false.
void setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)
 Throws exception.
void setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model)
 Throws exception.
RCP< const Thyra::ModelEvaluator<
Scalar > > 
getModel () const
 Returns getStateAndFwdSensModel().
RCP< Thyra::ModelEvaluator<
Scalar > > 
getNonconstModel ()
 
void setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &stacked_ic)
 Sets the full initial condition for x_bar = [ x^{N} ]_{N=0..numSteppers} .
Thyra::ModelEvaluatorBase::InArgs<
Scalar > 
getInitialCondition () const
 Get the currently set initial condtion.
Scalar takeStep (Scalar dt, StepSizeType stepType)
 
const StepStatus< Scalar > getStepStatus () const
 

Overridden from InterpolationBufferBase

RCP< const Thyra::VectorSpaceBase<
Scalar > > 
get_x_space () const
 Returns the space for x_bar and x_bar_dot.
void addPoints (const Array< Scalar > &time_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
 
TimeRange< Scalar > getTimeRange () const
 
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
 
void getNodes (Array< Scalar > *time_vec) const
 
void removeNodes (Array< Scalar > &time_vec)
 
int getOrder () const
 

Public Types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
ScalarMag
 

Related Functions

(Note that these are not member functions.)

RCP< StackedStepper< Scalar > > stackedStepper ()
 Nonmember constructor.

Detailed Description

template<class Scalar>
class Rythmos::StackedStepper< Scalar >

Definition at line 250 of file Rythmos_StackedStepper.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Rythmos::StackedStepper< Scalar >::ScalarMag

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 257 of file Rythmos_StackedStepper.hpp.


Constructor & Destructor Documentation

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

Constructs to uninitialized.

Definition at line 431 of file Rythmos_StackedStepper.hpp.


Member Function Documentation

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::addStepper ( const RCP< StepperBase< Scalar > > &  stepper  ) 

Add a stepper to the stack.

Definition at line 453 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
ArrayView< const RCP< StepperBase< Scalar > > > Rythmos::StackedStepper< Scalar >::getNonconstSteppers (  )  const

Return the steppers that were passed into addStepper.

Definition at line 466 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::setStackedStepperStepControlStrategy ( const RCP< StackedStepperStepStrategyBase< Scalar > > &  stepControl  ) 

Add a Step Control Strategy.

Definition at line 473 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
RCP< const StackedStepperStepStrategyBase< Scalar > > Rythmos::StackedStepper< Scalar >::getStackedStepperStepCongrolStrategy (  )  const

Get the Step Control Strategy.

Definition at line 484 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const &  paramList  ) 

Definition at line 491 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
RCP< const Teuchos::ParameterList > Rythmos::StackedStepper< Scalar >::getValidParameters (  )  const

Definition at line 504 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
bool Rythmos::StackedStepper< Scalar >::acceptsModel (  )  const [virtual]

Returns false.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 519 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model  )  [virtual]

Throws exception.

Implements Rythmos::StepperBase< Scalar >.

Definition at line 525 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model  )  [virtual]

Throws exception.

Implements Rythmos::StepperBase< Scalar >.

Definition at line 536 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::StackedStepper< Scalar >::getModel (  )  const [virtual]

Returns getStateAndFwdSensModel().

Warning, currently the returned model does not implement evalModel(...) or define a W object. It is just used for getting the spaces and for creating an InArgs object for setting the initial condition.

Implements Rythmos::StepperBase< Scalar >.

Definition at line 548 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::StackedStepper< Scalar >::getNonconstModel (  )  [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 557 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  stacked_ic  )  [virtual]

Sets the full initial condition for x_bar = [ x^{N} ]_{N=0..numSteppers} .

The InArgs object must be created using this->getModel()->createInArgs() and then populated with the initial values. The product vectors for x_bar and x_bar_dot can be created using this->getModel()->create_x_bar_vec(...). All of the input objects in state_ic will be cloned and therefore no memory of the objects in state_ic will be retained after calling this function.

Implements Rythmos::StepperBase< Scalar >.

Definition at line 565 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::StackedStepper< Scalar >::getInitialCondition (  )  const [virtual]

Get the currently set initial condtion.

Preconditions:

Implements Rythmos::StepperBase< Scalar >.

Definition at line 575 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
Scalar Rythmos::StackedStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  stepType 
) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 585 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
const StepStatus< Scalar > Rythmos::StackedStepper< Scalar >::getStepStatus (  )  const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 633 of file Rythmos_StackedStepper.hpp.

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

Returns the space for x_bar and x_bar_dot.

This space is a nested product vector space as described above. Dynamic casting is required to get at the ProductVectorSpaceBase and ProductVectorBase intefaces.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 647 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< Scalar >::addPoints ( const Array< Scalar > &  time_vec,
const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &  x_vec,
const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &  xdot_vec 
)

Definition at line 659 of file Rythmos_StackedStepper.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 673 of file Rythmos_StackedStepper.hpp.

template<class Scalar>
void Rythmos::StackedStepper< 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 [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 682 of file Rythmos_StackedStepper.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 769 of file Rythmos_StackedStepper.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 778 of file Rythmos_StackedStepper.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 787 of file Rythmos_StackedStepper.hpp.


Friends And Related Function Documentation

template<class Scalar>
RCP< StackedStepper< Scalar > > stackedStepper (  )  [related]

Nonmember constructor.

Definition at line 421 of file Rythmos_StackedStepper.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