Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
Tempus::TimeStepControlStrategy< Scalar > Class Template Reference

StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategy.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategy< Scalar >:
Tempus::TimeStepControlStrategyBasicVS< Scalar > Tempus::TimeStepControlStrategyComposite< Scalar > Tempus::TimeStepControlStrategyConstant< Scalar > Tempus::TimeStepControlStrategyIntegralController< Scalar > Tempus::TimeStepControlStrategyPID< Scalar >

Public Member Functions

 TimeStepControlStrategy ()
 Constructor. More...
 
virtual ~TimeStepControlStrategy ()
 Destructor. More...
 
virtual void getNextTimeStep (const TimeStepControl< Scalar > tsc, Teuchos::RCP< SolutionHistory< Scalar > > sh, Status &integratorStatus)
 Determine the time step size. More...
 
Overridden from Teuchos::ParameterListAcceptor
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList ()
 

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategy< Scalar >

StepControlStrategy class for TimeStepControl.

Definition at line 26 of file Tempus_TimeStepControlStrategy.hpp.

Constructor & Destructor Documentation

◆ TimeStepControlStrategy()

template<class Scalar >
Tempus::TimeStepControlStrategy< Scalar >::TimeStepControlStrategy ( )
inline

Constructor.

Definition at line 32 of file Tempus_TimeStepControlStrategy.hpp.

◆ ~TimeStepControlStrategy()

template<class Scalar >
virtual Tempus::TimeStepControlStrategy< Scalar >::~TimeStepControlStrategy ( )
inlinevirtual

Destructor.

Definition at line 35 of file Tempus_TimeStepControlStrategy.hpp.

Member Function Documentation

◆ getNextTimeStep()

template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::getNextTimeStep ( const TimeStepControl< Scalar >  tsc,
Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Status &  integratorStatus 
)
inlinevirtual

Determine the time step size.

Reimplemented in Tempus::TimeStepControlStrategyBasicVS< Scalar >, Tempus::TimeStepControlStrategyIntegralController< Scalar >, Tempus::TimeStepControlStrategyPID< Scalar >, Tempus::TimeStepControlStrategyConstant< Scalar >, and Tempus::TimeStepControlStrategyComposite< Scalar >.

Definition at line 38 of file Tempus_TimeStepControlStrategy.hpp.

◆ getNonconstParameterList()

template<class Scalar >
Teuchos::RCP<Teuchos::ParameterList> Tempus::TimeStepControlStrategy< Scalar >::getNonconstParameterList ( )
inline

Definition at line 48 of file Tempus_TimeStepControlStrategy.hpp.

◆ getValidParameters()

template<class Scalar >
Teuchos::RCP<const Teuchos::ParameterList> Tempus::TimeStepControlStrategy< Scalar >::getValidParameters ( ) const
inline

Definition at line 46 of file Tempus_TimeStepControlStrategy.hpp.

◆ setParameterList()

template<class Scalar >
void Tempus::TimeStepControlStrategy< Scalar >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > &  pl)
inline

Definition at line 45 of file Tempus_TimeStepControlStrategy.hpp.

◆ unsetParameterList()

template<class Scalar >
Teuchos::RCP<Teuchos::ParameterList> Tempus::TimeStepControlStrategy< Scalar >::unsetParameterList ( )
inline

Definition at line 50 of file Tempus_TimeStepControlStrategy.hpp.

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