Tempus::TimeStepControlStrategyPID< Scalar > Class Template Reference

StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategyPID.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyPID< 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...
Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
	TimeStepControlStrategy ()
	Constructor. More...
virtual	~TimeStepControlStrategy ()
	Destructor. More...
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 ()

Overridden from Teuchos::ParameterListAcceptor
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
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 ()

Detailed Description

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

StepControlStrategy class for TimeStepControl.

Definition at line 26 of file Tempus_TimeStepControlStrategyPID.hpp.

Constructor & Destructor Documentation

TimeStepControlStrategyPID()

template<class Scalar >

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

inline

Constructor.

Definition at line 32 of file Tempus_TimeStepControlStrategyPID.hpp.

~TimeStepControlStrategyPID()

template<class Scalar >

virtual Tempus::TimeStepControlStrategyPID< Scalar >::~TimeStepControlStrategyPID ( )

inlinevirtual

Destructor.

Definition at line 37 of file Tempus_TimeStepControlStrategyPID.hpp.

Member Function Documentation

getNextTimeStep()

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 40 of file Tempus_TimeStepControlStrategyPID.hpp.

getNonconstParameterList()

template<class Scalar >

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

inline

Definition at line 163 of file Tempus_TimeStepControlStrategyPID.hpp.

getValidParameters()

template<class Scalar >

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

inline

Definition at line 150 of file Tempus_TimeStepControlStrategyPID.hpp.

setParameterList()

template<class Scalar >

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

inline

Definition at line 113 of file Tempus_TimeStepControlStrategyPID.hpp.

unsetParameterList()

template<class Scalar >

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

inline

Definition at line 167 of file Tempus_TimeStepControlStrategyPID.hpp.

Member Data Documentation

errN_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errN_

private

Definition at line 179 of file Tempus_TimeStepControlStrategyPID.hpp.

errNm1_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errNm1_

private

Definition at line 180 of file Tempus_TimeStepControlStrategyPID.hpp.

errNm2_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::errNm2_

private

Definition at line 181 of file Tempus_TimeStepControlStrategyPID.hpp.

facMax_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::facMax_

private

Definition at line 183 of file Tempus_TimeStepControlStrategyPID.hpp.

facMin_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::facMin_

private

Definition at line 184 of file Tempus_TimeStepControlStrategyPID.hpp.

firstSuccessfulStep_

template<class Scalar >

bool Tempus::TimeStepControlStrategyPID< Scalar >::firstSuccessfulStep_ = false

private

Definition at line 185 of file Tempus_TimeStepControlStrategyPID.hpp.

k1_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k1_

private

Definition at line 176 of file Tempus_TimeStepControlStrategyPID.hpp.

k2_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k2_

private

Definition at line 177 of file Tempus_TimeStepControlStrategyPID.hpp.

k3_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::k3_

private

Definition at line 178 of file Tempus_TimeStepControlStrategyPID.hpp.

lastStepRejected_

template<class Scalar >

bool Tempus::TimeStepControlStrategyPID< Scalar >::lastStepRejected_ = false

private

Definition at line 186 of file Tempus_TimeStepControlStrategyPID.hpp.

safetyFactor_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyPID< Scalar >::safetyFactor_

private

Definition at line 182 of file Tempus_TimeStepControlStrategyPID.hpp.

tscsPL_

template<class Scalar >

Teuchos::RCP<Teuchos::ParameterList> Tempus::TimeStepControlStrategyPID< Scalar >::tscsPL_

private

Definition at line 175 of file Tempus_TimeStepControlStrategyPID.hpp.

---

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

• /home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Tempus_TimeStepControlStrategyPID.hpp