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

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

#include <Rythmos_ThetaStepper_decl.hpp>

Inheritance diagram for Rythmos::ThetaStepper< Scalar >:
Inheritance graph
[legend]

Public Types

typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
ScalarMag
 
- Public Types inherited from Rythmos::InterpolationBufferBase< Scalar >
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...
 

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

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

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

Member Function Documentation

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

template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setInterpolator ( const RCP< InterpolatorBase< Scalar > > &  interpolator)
virtual
template<class Scalar >
RCP<InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getNonconstInterpolator ( )
virtual
template<class Scalar >
RCP<const InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getInterpolator ( ) const
virtual
template<class Scalar >
RCP<InterpolatorBase<Scalar> > Rythmos::ThetaStepper< Scalar >::unSetInterpolator ( )
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver)

template<class Scalar >
RCP<Thyra::NonlinearSolverBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getNonconstSolver ( )
virtual
template<class Scalar >
RCP<const Thyra::NonlinearSolverBase<Scalar> > Rythmos::ThetaStepper< Scalar >::getSolver ( ) const
virtual
template<class Scalar >
bool Rythmos::ThetaStepper< Scalar >::supportsCloning ( ) const
virtual

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

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

template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model)
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model)
virtual
template<class Scalar >
RCP<const Thyra::ModelEvaluator<Scalar> > Rythmos::ThetaStepper< Scalar >::getModel ( ) const
virtual
template<class Scalar >
RCP<Thyra::ModelEvaluator<Scalar> > Rythmos::ThetaStepper< Scalar >::getNonconstModel ( )
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  initialCondition)
virtual
template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs<Scalar> Rythmos::ThetaStepper< Scalar >::getInitialCondition ( ) const
virtual
template<class Scalar >
Scalar Rythmos::ThetaStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  flag 
)
virtual
template<class Scalar >
const StepStatus<Scalar> Rythmos::ThetaStepper< Scalar >::getStepStatus ( ) const
virtual
template<class Scalar >
RCP<const Thyra::VectorSpaceBase<Scalar> > Rythmos::ThetaStepper< Scalar >::get_x_space ( ) const
virtual
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 
)
virtual
template<class Scalar >
TimeRange<Scalar> Rythmos::ThetaStepper< Scalar >::getTimeRange ( ) const
virtual
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
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::getNodes ( Array< Scalar > *  time_vec) const
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::removeNodes ( Array< Scalar > &  time_vec)
virtual
template<class Scalar >
int Rythmos::ThetaStepper< Scalar >::getOrder ( ) const
virtual
template<class Scalar >
void Rythmos::ThetaStepper< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const &  paramList)

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

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

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

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

Friends And Related Function Documentation

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

Nonmember constructor.


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