Rythmos - Transient Integration for Differential Equations  Version of the Day
 All Classes Functions Variables Typedefs Pages
Public Member Functions | List of all members
Rythmos::StepperValidator< Scalar > Class Template Reference

Class for validating steppers. More...

#include <Rythmos_StepperValidator.hpp>

Inherits Describable, ParameterListAcceptor, and VerboseObject< StepperValidator< Scalar > >.

Public Member Functions

void setIntegratorBuilder (const RCP< IntegratorBuilder< Scalar > > &integratorBuilder)
 Set a Integrator Builder object. More...
 
void validateStepper () const
 Validate the stepper by the StepperBuilder. More...
 

Overridden from Teuchos::ParameterListAcceptor

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

Overridden from Teuchos::Describable

std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Detailed Description

template<class Scalar>
class Rythmos::StepperValidator< Scalar >

Class for validating steppers.

There are a variety of requirements placed on the steppers by the higher level objects like the integrator. These requirements are documented and tested in this class.

Definition at line 63 of file Rythmos_StepperValidator.hpp.

Member Function Documentation

template<class Scalar >
void Rythmos::StepperValidator< Scalar >::setIntegratorBuilder ( const RCP< IntegratorBuilder< Scalar > > &  integratorBuilder)

Set a Integrator Builder object.

Definition at line 547 of file Rythmos_StepperValidator.hpp.

template<class Scalar >
void Rythmos::StepperValidator< Scalar >::validateStepper ( ) const

Validate the stepper by the StepperBuilder.

Definition at line 556 of file Rythmos_StepperValidator.hpp.

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

Definition at line 631 of file Rythmos_StepperValidator.hpp.

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::StepperValidator< Scalar >::getNonconstParameterList ( )

Definition at line 637 of file Rythmos_StepperValidator.hpp.

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::StepperValidator< Scalar >::unsetParameterList ( )

Definition at line 644 of file Rythmos_StepperValidator.hpp.

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

Definition at line 651 of file Rythmos_StepperValidator.hpp.

template<class Scalar >
std::string Rythmos::StepperValidator< Scalar >::description ( ) const

Definition at line 658 of file Rythmos_StepperValidator.hpp.

template<class Scalar >
void Rythmos::StepperValidator< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const

Definition at line 665 of file Rythmos_StepperValidator.hpp.


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