Rythmos::ImplicitRKStepper< Scalar > Class Template Reference

#include <Rythmos_ImplicitRKStepper.hpp>

Inheritance diagram for Rythmos::ImplicitRKStepper< Scalar >:

Public Types
typedef ScalarTraits< Scalar > ::magnitudeType	ScalarMag

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< ImplicitRKStepper< Scalar > >	implicitRKStepper (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &irk_W_factory)
	Nonmember constructor.
Constructors, intializers, Misc.

	ImplicitRKStepper ()

void	initialize (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &irk_W_factory)

void	setInterpolator (RCP< InterpolatorBase< Scalar > > interpolator)

RCP< InterpolatorBase< Scalar > >	unsetInterpolator ()

Overridden from SolverAcceptingStepperBase

void	setSolver (const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)

RCP < Thyra::NonlinearSolverBase < Scalar > >	getNonconstSolver ()

RCP< const Thyra::NonlinearSolverBase < Scalar > >	getSolver () const

Overridden from StepperBase

bool	supportsCloning () const
	Returns true.
RCP< StepperBase< Scalar > >	cloneStepperAlgorithm () const

void	setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)

RCP< const Thyra::ModelEvaluator< Scalar > >	getModel () const

void	setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)

Scalar	takeStep (Scalar dt, StepSizeType flag)

const StepStatus< Scalar >	getStepStatus () 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)

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

Overridden from Teuchos::ParameterListAcceptor

void	setParameterList (RCP< ParameterList > const &paramList)

RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getValidParameters () const

Overridden from Teuchos::Describable

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

Detailed Description

template<class Scalar>
class Rythmos::ImplicitRKStepper< Scalar >

Definition at line 57 of file Rythmos_ImplicitRKStepper.hpp.

Member Typedef Documentation

template<class Scalar >

typedef ScalarTraits<Scalar>::magnitudeType Rythmos::ImplicitRKStepper< Scalar >::ScalarMag

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 62 of file Rythmos_ImplicitRKStepper.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::ImplicitRKStepper< Scalar >::ImplicitRKStepper ( ) [inline]

Definition at line 256 of file Rythmos_ImplicitRKStepper.hpp.

Member Function Documentation

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::initialize	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &	irk_W_factory
	)			`[inline]`

Definition at line 263 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setInterpolator ( RCP< InterpolatorBase< Scalar > > interpolator ) [inline]

Definition at line 280 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< InterpolatorBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::unsetInterpolator ( ) [inline]

Definition at line 290 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > & solver ) [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 301 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getNonconstSolver ( ) [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 311 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getSolver ( ) const [inline, virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 319 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

bool Rythmos::ImplicitRKStepper< Scalar >::supportsCloning ( ) const [inline, virtual]

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 329 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< StepperBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::cloneStepperAlgorithm ( ) const [inline, virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 337 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > & model ) [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 345 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getModel ( ) const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 355 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > & initialCondition ) [inline, virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 362 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

Scalar Rythmos::ImplicitRKStepper< Scalar >::takeStep	(	Scalar	dt,
		StepSizeType	flag
	)			`[inline, virtual]`

Implements Rythmos::StepperBase< Scalar >.

Definition at line 418 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

const StepStatus< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getStepStatus ( ) const [inline, virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 481 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::get_x_space ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 494 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< 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
	)			`[inline, virtual]`

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 501 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

TimeRange< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getTimeRange ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 512 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< 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 `[inline]`

Definition at line 519 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::getNodes ( Array< Scalar > * time_vec ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 549 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::removeNodes ( Array< Scalar > & time_vec ) [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 556 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

int Rythmos::ImplicitRKStepper< Scalar >::getOrder ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 563 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setParameterList ( RCP< ParameterList > const & paramList ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 574 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< ParameterList > Rythmos::ImplicitRKStepper< Scalar >::getNonconstParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 588 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< ParameterList > Rythmos::ImplicitRKStepper< Scalar >::unsetParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 596 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

RCP< const ParameterList > Rythmos::ImplicitRKStepper< Scalar >::getValidParameters ( ) const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 607 of file Rythmos_ImplicitRKStepper.hpp.

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::describe	(	FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)			const `[inline]`

Definition at line 624 of file Rythmos_ImplicitRKStepper.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< ImplicitRKStepper< Scalar > > implicitRKStepper	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &	irk_W_factory
	)			`[related]`

Nonmember constructor.

Definition at line 236 of file Rythmos_ImplicitRKStepper.hpp.

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

Rythmos_ImplicitRKStepper.hpp

Rythmos::ImplicitRKStepper< Scalar > Class Template Reference

Public Types

Related Functions

Constructors, intializers, Misc.

Overridden from SolverAcceptingStepperBase

Overridden from StepperBase

Overridden from InterpolationBufferBase

Overridden from Teuchos::ParameterListAcceptor

Overridden from Teuchos::Describable

Detailed Description

template<class Scalar> class Rythmos::ImplicitRKStepper< Scalar >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class Scalar>
class Rythmos::ImplicitRKStepper< Scalar >