Stepper class for theta integration scheme common in SNL thermal/fluids codes. More...

#include <Rythmos_ThetaStepper_decl.hpp>

Inheritance diagram for Rythmos::ThetaStepper< Scalar >:

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

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< ThetaStepper< Scalar > >	thetaStepper (const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, RCP< Teuchos::ParameterList > &parameterList)
	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.
	ThetaStepper ()

bool	isImplicit () const
	Return if this stepper is an implicit stepper. More...

void	setInterpolator (const RCP< InterpolatorBase< Scalar > > &interpolator)
	Redefined from InterpolatorAcceptingObjectBase. More...

RCP< InterpolatorBase< Scalar > >	getNonconstInterpolator ()

RCP< const InterpolatorBase< Scalar > >	getInterpolator () const

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. More...

RCP< StepperBase< Scalar > >	cloneStepperAlgorithm () const
	Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless. More...

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 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< Teuchos::ParameterList > const &paramList)

RCP< Teuchos::ParameterList >	getNonconstParameterList ()

RCP< Teuchos::ParameterList >	unsetParameterList ()

RCP< const Teuchos::ParameterList >	getValidParameters () const

Overridden from Teuchos::Describable
void	describe (Teuchos::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::InterpolatorAcceptingObjectBase< Scalar >
virtual	~InterpolatorAcceptingObjectBase ()

Detailed Description

template<class Scalar>
class Rythmos::ThetaStepper< Scalar >

Stepper class for theta integration scheme common in SNL thermal/fluids codes.

Definition at line 79 of file Rythmos_ThetaStepper_decl.hpp.

Member Typedef Documentation

◆ ScalarMag

template<class Scalar >

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

Definition at line 86 of file Rythmos_ThetaStepper_decl.hpp.

Constructor & Destructor Documentation

◆ ThetaStepper()

template<class Scalar >

Rythmos::ThetaStepper< Scalar >::ThetaStepper ( )

Member Function Documentation

◆ isImplicit()

template<class Scalar >

bool Rythmos::ThetaStepper< Scalar >::isImplicit ( ) const

virtual

Return if this stepper is an implicit stepper.

The default implemntation returns false and therefore, by default, a stepper is considered to be an excplicit stepper.

Reimplemented from Rythmos::StepperBase< Scalar >.

◆ setInterpolator()

template<class Scalar >

void Rythmos::ThetaStepper< Scalar >::setInterpolator ( const RCP< InterpolatorBase< Scalar > > & interpolator )

virtual

Redefined from InterpolatorAcceptingObjectBase.

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

◆ getNonconstInterpolator()

template<class Scalar >

RCP<InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getNonconstInterpolator ( )

virtual

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

◆ getInterpolator()

template<class Scalar >

RCP<const InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getInterpolator ( ) const

virtual

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

◆ unSetInterpolator()

template<class Scalar >

RCP<InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::unSetInterpolator ( )

virtual

Implements Rythmos::InterpolatorAcceptingObjectBase< Scalar >.

◆ setSolver()

template<class Scalar >

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

◆ getNonconstSolver()

template<class Scalar >

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

virtual

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

◆ getSolver()

template<class Scalar >

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

virtual

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

◆ supportsCloning()

template<class Scalar >

bool Rythmos::ThetaStepper< Scalar >::supportsCloning ( ) const

virtual

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

◆ cloneStepperAlgorithm()

template<class Scalar >

RCP<StepperBase<Scalar> > Rythmos::ThetaStepper< Scalar >::cloneStepperAlgorithm ( ) const

virtual

Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.

If a shallow copy of the model is not appropirate for some reasone, then the client can simply reset the model using returnVal->setModel().

Reimplemented from Rythmos::StepperBase< Scalar >.

◆ setModel()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ setNonconstModel()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ getModel()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ getNonconstModel()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ setInitialCondition()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ getInitialCondition()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ takeStep()

template<class Scalar >

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

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ getStepStatus()

template<class Scalar >

const StepStatus<Scalar> Rythmos::ThetaStepper< Scalar >::getStepStatus ( ) const

virtual

Implements Rythmos::StepperBase< Scalar >.

◆ get_x_space()

template<class Scalar >

RCP<const Thyra::VectorSpaceBase<Scalar> > Rythmos::ThetaStepper< Scalar >::get_x_space ( ) const

◆ addPoints()

template<class Scalar >

void Rythmos::ThetaStepper< 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
	)

◆ getTimeRange()

template<class Scalar >

TimeRange<Scalar> Rythmos::ThetaStepper< Scalar >::getTimeRange ( ) const

◆ getPoints()

template<class Scalar >

void Rythmos::ThetaStepper< 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

◆ getNodes()

template<class Scalar >

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

◆ removeNodes()

template<class Scalar >

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

◆ getOrder()

template<class Scalar >

int Rythmos::ThetaStepper< Scalar >::getOrder ( ) const

◆ setParameterList()

template<class Scalar >

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

◆ getNonconstParameterList()

template<class Scalar >

RCP<Teuchos::ParameterList> Rythmos::ThetaStepper< Scalar >::getNonconstParameterList ( )

◆ unsetParameterList()

template<class Scalar >

RCP<Teuchos::ParameterList> Rythmos::ThetaStepper< Scalar >::unsetParameterList ( )

◆ getValidParameters()

template<class Scalar >

RCP<const Teuchos::ParameterList> Rythmos::ThetaStepper< Scalar >::getValidParameters ( ) const

◆ describe()

template<class Scalar >

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

Friends And Related Function Documentation

◆ thetaStepper()

template<class Scalar >

RCP< ThetaStepper< Scalar > > thetaStepper	(	const RCP< Thyra::ModelEvaluator< Scalar > > &	model,
		const RCP< Thyra::NonlinearSolverBase< Scalar > > &	solver,
		RCP< Teuchos::ParameterList > &	parameterList
	)

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

Rythmos_ThetaStepper_decl.hpp

Public Types

Related Functions

Constructors, intializers, Misc.

Overridden from SolverAcceptingStepperBase

Overridden from StepperBase

Overridden from InterpolationBufferBase

Overridden from Teuchos::ParameterListAcceptor

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class Scalar> class Rythmos::ThetaStepper< Scalar >

Member Typedef Documentation

◆ ScalarMag

Constructor & Destructor Documentation

◆ ThetaStepper()

Member Function Documentation

◆ isImplicit()

◆ setInterpolator()

◆ getNonconstInterpolator()

◆ getInterpolator()

◆ unSetInterpolator()

◆ setSolver()

◆ getNonconstSolver()

◆ getSolver()

◆ supportsCloning()

◆ cloneStepperAlgorithm()

◆ setModel()

◆ setNonconstModel()

◆ getModel()

◆ getNonconstModel()

◆ setInitialCondition()

◆ getInitialCondition()

◆ takeStep()

◆ getStepStatus()

◆ get_x_space()

◆ addPoints()

◆ getTimeRange()

◆ getPoints()

◆ getNodes()

◆ removeNodes()

◆ getOrder()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getValidParameters()

◆ describe()

Friends And Related Function Documentation

◆ thetaStepper()

template<class Scalar>
class Rythmos::ThetaStepper< Scalar >