Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus::TimeStepControlStrategyPID< Scalar > Class Template Reference

StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategyPID.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyPID< Scalar >:
Tempus::TimeStepControlStrategy< Scalar >

Public Member Functions

 TimeStepControlStrategyPID (Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
 Constructor. More...
 
virtual ~TimeStepControlStrategyPID ()
 Destructor. More...
 
virtual void getNextTimeStep (const TimeStepControl< Scalar > tsc, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Status &integratorStatus) override
 Determine the time step size. More...
 
Overridden from Teuchos::ParameterListAcceptor
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pList)
 
Teuchos::RCP< const
Teuchos::ParameterList > 
getValidParameters () const
 
Teuchos::RCP
< Teuchos::ParameterList > 
getNonconstParameterList ()
 
Teuchos::RCP
< Teuchos::ParameterList > 
unsetParameterList ()
 
- Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
 TimeStepControlStrategy ()
 Constructor. More...
 
virtual ~TimeStepControlStrategy ()
 Destructor. More...
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &)
 
Teuchos::RCP< const
Teuchos::ParameterList > 
getValidParameters () const
 
Teuchos::RCP
< Teuchos::ParameterList > 
getNonconstParameterList ()
 
Teuchos::RCP
< Teuchos::ParameterList > 
unsetParameterList ()
 

Private Attributes

Teuchos::RCP
< Teuchos::ParameterList > 
tscsPL_
 
Scalar k1_
 
Scalar k2_
 
Scalar k3_
 
Scalar errN_
 
Scalar errNm1_
 
Scalar errNm2_
 
Scalar safetyFactor_
 
Scalar facMax_
 
Scalar facMin_
 
bool firstSuccessfulStep_ = false
 
bool lastStepRejected_ = false
 

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategyPID< Scalar >

StepControlStrategy class for TimeStepControl.

Definition at line 25 of file Tempus_TimeStepControlStrategyPID.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::TimeStepControlStrategyPID< Scalar >::TimeStepControlStrategyPID ( Teuchos::RCP< Teuchos::ParameterList >  pList = Teuchos::null)
inline

Constructor.

Definition at line 31 of file Tempus_TimeStepControlStrategyPID.hpp.

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

Destructor.

Definition at line 36 of file Tempus_TimeStepControlStrategyPID.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyPID< Scalar >::getNextTimeStep ( const TimeStepControl< Scalar >  tsc,
Teuchos::RCP< SolutionHistory< Scalar > >  solutionHistory,
Status integratorStatus 
)
inlineoverridevirtual

Determine the time step size.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 39 of file Tempus_TimeStepControlStrategyPID.hpp.

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

Definition at line 160 of file Tempus_TimeStepControlStrategyPID.hpp.

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

Definition at line 147 of file Tempus_TimeStepControlStrategyPID.hpp.

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

Definition at line 110 of file Tempus_TimeStepControlStrategyPID.hpp.

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

Definition at line 164 of file Tempus_TimeStepControlStrategyPID.hpp.

Member Data Documentation

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errN_
private

Definition at line 176 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errNm1_
private

Definition at line 177 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errNm2_
private

Definition at line 178 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::facMax_
private

Definition at line 180 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::facMin_
private

Definition at line 181 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
bool Tempus::TimeStepControlStrategyPID< Scalar >::firstSuccessfulStep_ = false
private

Definition at line 182 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k1_
private

Definition at line 173 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k2_
private

Definition at line 174 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k3_
private

Definition at line 175 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
bool Tempus::TimeStepControlStrategyPID< Scalar >::lastStepRejected_ = false
private

Definition at line 183 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyPID< Scalar >::safetyFactor_
private

Definition at line 179 of file Tempus_TimeStepControlStrategyPID.hpp.

template<class Scalar >
Teuchos::RCP<Teuchos::ParameterList> Tempus::TimeStepControlStrategyPID< Scalar >::tscsPL_
private

Definition at line 172 of file Tempus_TimeStepControlStrategyPID.hpp.


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