#include <Rythmos_ImplicitRKStepper_decl.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 ()
	Nonmember constructor. More...

template<class Scalar >
RCP< ImplicitRKStepper< Scalar > >	implicitRKStepper ()
	Nonmember constructor. More...

Related Functions inherited from Rythmos::StepperBase< Scalar >
template<class Scalar >
bool	isInitialized (const StepperBase< Scalar > &stepper)

template<class Scalar >
bool	isInitialized (const StepperBase< Scalar > &stepper)

Constructors, intializers, Misc.
	ImplicitRKStepper ()

void	set_W_factory (const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &irk_W_factory)

RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > >	get_W_factory () const

Overridden from RKButcherTableauAcceptingStepperBase
void	setRKButcherTableau (const RCP< const RKButcherTableauBase< Scalar > > &rkButcherTableau)

RCP< const RKButcherTableauBase< Scalar > >	getRKButcherTableau () const

void	setDirk (bool isDirk)

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	isImplicit () const
	Returns true. More...

bool	supportsCloning () const
	Returns true. More...

RCP< StepperBase< Scalar > >	cloneStepperAlgorithm () const

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

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

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

RCP< Thyra::ModelEvaluator< Scalar > >	getNonconstModel ()

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

Thyra::ModelEvaluatorBase::InArgs< Scalar >	getInitialCondition () const

Scalar	takeStep (Scalar dt, StepSizeType flag)

const StepStatus< Scalar >	getStepStatus () const

Overridden from StepControlStrategyAcceptingStepperBase
void	setStepControlStrategy (const RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)

RCP< StepControlStrategyBase< Scalar > >	getNonconstStepControlStrategy ()

RCP< const StepControlStrategyBase< Scalar > >	getStepControlStrategy () 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
bool	isEmbeddedRK_ = false

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

Additional Inherited Members
Public Member Functions inherited from Rythmos::SolverAcceptingStepperBase< Scalar >
virtual void	setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)=0

Public Member Functions inherited from Rythmos::StepperBase< Scalar >
virtual bool	acceptsModel () const
	Return if this stepper accepts a model. More...

virtual bool	modelIsConst () const
	Return of the model is only const or can be returned as a non-const object. More...

virtual void	setStepControlData (const StepperBase &stepper)
	Set step control data from another stepper. More...

Public Member Functions inherited from Rythmos::RKButcherTableauAcceptingStepperBase< Scalar >
virtual void	setRKButcherTableau (const Teuchos::RCP< const RKButcherTableauBase< Scalar > > &rkbt)=0

Public Member Functions inherited from Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >
virtual void	setStepControlStrategy (const Teuchos::RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)=0

Detailed Description

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

Definition at line 50 of file Rythmos_ImplicitRKStepper_decl.hpp.

Member Typedef Documentation

◆ ScalarMag

template<class Scalar >

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

Definition at line 58 of file Rythmos_ImplicitRKStepper_decl.hpp.

Constructor & Destructor Documentation

◆ ImplicitRKStepper()

template<class Scalar >

Rythmos::ImplicitRKStepper< Scalar >::ImplicitRKStepper

Definition at line 91 of file Rythmos_ImplicitRKStepper_def.hpp.

Member Function Documentation

◆ get_W_factory()

template<class Scalar >

RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::get_W_factory

Definition at line 129 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setRKButcherTableau()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setRKButcherTableau ( const RCP< const RKButcherTableauBase< Scalar > > & rkButcherTableau )

Definition at line 871 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getRKButcherTableau()

template<class Scalar >

RCP< const RKButcherTableauBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getRKButcherTableau

virtual

Implements Rythmos::RKButcherTableauAcceptingStepperBase< Scalar >.

Definition at line 891 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setDirk()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setDirk ( bool isDirk )

Definition at line 897 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setSolver()

template<class Scalar >

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

Definition at line 138 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getNonconstSolver()

template<class Scalar >

RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getNonconstSolver

virtual

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 149 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getSolver()

template<class Scalar >

RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getSolver

virtual

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 157 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ isImplicit()

template<class Scalar >

bool Rythmos::ImplicitRKStepper< Scalar >::isImplicit

virtual

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 167 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ supportsCloning()

template<class Scalar >

bool Rythmos::ImplicitRKStepper< Scalar >::supportsCloning

virtual

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 173 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ cloneStepperAlgorithm()

template<class Scalar >

RCP< StepperBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::cloneStepperAlgorithm

virtual

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 181 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setModel()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 233 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setNonconstModel()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > & model )

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 244 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getModel()

template<class Scalar >

RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getModel

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 254 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getNonconstModel()

template<class Scalar >

RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getNonconstModel

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 262 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setInitialCondition()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 269 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getInitialCondition()

template<class Scalar >

Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getInitialCondition

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 330 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ takeStep()

template<class Scalar >

Scalar Rythmos::ImplicitRKStepper< Scalar >::takeStep	(	Scalar	dt,
		StepSizeType	flag
	)

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 337 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getStepStatus()

template<class Scalar >

const StepStatus< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getStepStatus

virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 617 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setStepControlStrategy()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setStepControlStrategy ( const RCP< StepControlStrategyBase< Scalar > > & stepControlStrategy )

Definition at line 226 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getNonconstStepControlStrategy()

template<class Scalar >

RCP< StepControlStrategyBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getNonconstStepControlStrategy

virtual

Implements Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >.

Definition at line 214 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getStepControlStrategy()

template<class Scalar >

RCP< const StepControlStrategyBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getStepControlStrategy

virtual

Implements Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >.

Definition at line 220 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ get_x_space()

template<class Scalar >

RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::get_x_space

Definition at line 649 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ addPoints()

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
	)

Definition at line 656 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getTimeRange()

template<class Scalar >

TimeRange< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getTimeRange

Definition at line 667 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getPoints()

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

Definition at line 674 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getNodes()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::getNodes ( Array< Scalar > * time_vec ) const

Definition at line 697 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ removeNodes()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::removeNodes ( Array< Scalar > & time_vec )

Definition at line 712 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getOrder()

template<class Scalar >

int Rythmos::ImplicitRKStepper< Scalar >::getOrder

Definition at line 719 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ setParameterList()

template<class Scalar >

void Rythmos::ImplicitRKStepper< Scalar >::setParameterList ( RCP< ParameterList > const & paramList )

Definition at line 729 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getNonconstParameterList()

template<class Scalar >

RCP< ParameterList > Rythmos::ImplicitRKStepper< Scalar >::getNonconstParameterList

Definition at line 742 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ unsetParameterList()

template<class Scalar >

RCP< ParameterList > Rythmos::ImplicitRKStepper< Scalar >::unsetParameterList

Definition at line 750 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ getValidParameters()

template<class Scalar >

RCP< const ParameterList > Rythmos::ImplicitRKStepper< Scalar >::getValidParameters

Definition at line 761 of file Rythmos_ImplicitRKStepper_def.hpp.

◆ describe()

template<class Scalar >

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

Definition at line 780 of file Rythmos_ImplicitRKStepper_def.hpp.

Friends And Related Function Documentation

◆ implicitRKStepper() [1/2]

template<class Scalar >

RCP< ImplicitRKStepper< Scalar > > implicitRKStepper ( )

◆ implicitRKStepper() [2/2]

template<class Scalar >

RCP< ImplicitRKStepper< Scalar > > implicitRKStepper ( )

Definition at line 58 of file Rythmos_ImplicitRKStepper_def.hpp.

Member Data Documentation

◆ isEmbeddedRK_

template<class Scalar >

bool Rythmos::ImplicitRKStepper< Scalar >::isEmbeddedRK_ = false

Definition at line 233 of file Rythmos_ImplicitRKStepper_decl.hpp.

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

Public Types

Related Functions

Constructors, intializers, Misc.

Overridden from RKButcherTableauAcceptingStepperBase

Overridden from SolverAcceptingStepperBase

Overridden from StepperBase

Overridden from StepControlStrategyAcceptingStepperBase

Overridden from InterpolationBufferBase

Overridden from Teuchos::ParameterListAcceptor

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ScalarMag

Constructor & Destructor Documentation

◆ ImplicitRKStepper()

Member Function Documentation

◆ get_W_factory()

◆ setRKButcherTableau()

◆ getRKButcherTableau()

◆ setDirk()

◆ setSolver()

◆ getNonconstSolver()

◆ getSolver()

◆ isImplicit()

◆ supportsCloning()

◆ cloneStepperAlgorithm()

◆ setModel()

◆ setNonconstModel()

◆ getModel()

◆ getNonconstModel()

◆ setInitialCondition()

◆ getInitialCondition()

◆ takeStep()

◆ getStepStatus()

◆ setStepControlStrategy()

◆ getNonconstStepControlStrategy()

◆ getStepControlStrategy()

◆ get_x_space()

◆ addPoints()

◆ getTimeRange()

◆ getPoints()

◆ getNodes()

◆ removeNodes()

◆ getOrder()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getValidParameters()

◆ describe()

Friends And Related Function Documentation

◆ implicitRKStepper() [1/2]

◆ implicitRKStepper() [2/2]

Member Data Documentation

◆ isEmbeddedRK_

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