StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategyIntegralController.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyIntegralController< Scalar >:

Public Member Functions
	TimeStepControlStrategyIntegralController ()
	Default Constructor.

	TimeStepControlStrategyIntegralController (std::string controller, Scalar KI, Scalar KP, Scalar KD, Scalar safetyFactor, Scalar safetyFactorAfterReject, Scalar facMax, Scalar facMin, std::string name="Integral Controller")
	Full Constructor.

virtual	~TimeStepControlStrategyIntegralController ()
	Destructor.

virtual void	setNextTimeStep (const TimeStepControl< Scalar > &tsc, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Status &) override
	Set the time step size.

Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
	TimeStepControlStrategy ()
	Constructor.

virtual	~TimeStepControlStrategy ()
	Destructor.

virtual bool	isInitialized ()

virtual void	checkInitialized ()

virtual void	setName (std::string s)

virtual std::string	getStrategyType () const

virtual std::string	getStepType () const

virtual std::string	getName () const

Overridden from Teuchos::Describable
std::string	controller_
	Control type ['I', 'PI', 'PID'].

Scalar	KI_
	Integral gain.

Scalar	KP_
	Proportional gain.

Scalar	KD_
	Derivative gain.

Scalar	safetyFactor_
	Safety Factor.

Scalar	safetyFactorAfterReject_
	Safety Factor Following Step Rejection.

Scalar	facMaxINPUT_
	Maximum Safety Factor from input.

Scalar	facMax_
	Maximum Safety Factor.

Scalar	facMin_
	Minimum Safety Factor.

bool	firstSuccessfulStep_ = false

bool	lastStepRejected_ = false

std::string	description () const override

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override

virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const override
	Return ParameterList with current values.

virtual void	initialize () const override

virtual std::string	getController () const

virtual Scalar	getKI () const

virtual Scalar	getKP () const

virtual Scalar	getKD () const

virtual Scalar	getSafetyFactor () const

virtual Scalar	getSafetyFactorAfterReject () const

virtual Scalar	getFacMax () const

virtual Scalar	getFacMin () const

virtual void	setController (std::string c)

virtual void	setKI (Scalar k)

virtual void	setKP (Scalar k)

virtual void	setKD (Scalar k)

virtual void	setSafetyFactor (Scalar f)

virtual void	setSafetyFactorAfterReject (Scalar f)

virtual void	setFacMax (Scalar f)

virtual void	setFacMin (Scalar f)

Additional Inherited Members
Protected Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
virtual void	setStrategyType (std::string s)

virtual void	setStepType (std::string s)

Protected Attributes inherited from Tempus::TimeStepControlStrategy< Scalar >
std::string	strategyType_
	Strategy type.

std::string	stepType_
	Step Type - "Constant" or "Variable".

std::string	name_
	Name of strategy.

bool	isInitialized_
	Bool if strategy is initialized.

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategyIntegralController< Scalar >

StepControlStrategy class for TimeStepControl.

Gustaf Soderlind. Automatic control and adaptive time-stepping. Numerical Algorithms, 31(1):281–310, Dec 2002.

The step size is chosen based on "Controller Type":

PID = Proportional-Integral-Derivative Controller

$(\Delta t)_{n+1} = (\Delta t)_n \left( \epsilon_n ^{-k_I / p} \epsilon_{n-1}^{k_P / p} \epsilon_{n-2}^{-k_D / p} \right)$

PI = Proportional-Integral Controller

$(\Delta t)_{n+1} = (\Delta t)_n \left( \epsilon_n ^{-k_I / p} \epsilon_{n-1}^{k_P / p} \right)$

I = Integral Controller

$(\Delta t)_{n+1} = (\Delta t)_n \left( \epsilon_n ^{-k_I / p} \right)$

where $\epsilon_n$ is the error at time step and is the order of the embedded solution, which is assumed to be the low order solution (i.e., the time step order minus one).

Appropriate for Explicit Methods

Definition at line 59 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

Constructor & Destructor Documentation

◆ TimeStepControlStrategyIntegralController() [1/2]

template<class Scalar >

Tempus::TimeStepControlStrategyIntegralController< Scalar >::TimeStepControlStrategyIntegralController ( )

inline

Default Constructor.

Definition at line 63 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ TimeStepControlStrategyIntegralController() [2/2]

template<class Scalar >

Tempus::TimeStepControlStrategyIntegralController< Scalar >::TimeStepControlStrategyIntegralController	(	std::string	controller,
		Scalar	KI,
		Scalar	KP,
		Scalar	KD,
		Scalar	safetyFactor,
		Scalar	safetyFactorAfterReject,
		Scalar	facMax,
		Scalar	facMin,
		std::string	name = `"Integral Controller"`
	)

inline

Full Constructor.

Definition at line 82 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ ~TimeStepControlStrategyIntegralController()

template<class Scalar >

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

inlinevirtual

Destructor.

Definition at line 104 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

Member Function Documentation

◆ setNextTimeStep()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setNextTimeStep	(	const TimeStepControl< Scalar > &	tsc,
		Teuchos::RCP< SolutionHistory< Scalar > >	solutionHistory,
		Status &
	)

inlineoverridevirtual

Set the time step size.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 107 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ description()

template<class Scalar >

std::string Tempus::TimeStepControlStrategyIntegralController< Scalar >::description ( ) const

inlineoverride

Definition at line 182 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ describe()

template<class Scalar >

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

inlineoverride

Definition at line 187 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getValidParameters()

template<class Scalar >

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

inlineoverridevirtual

Return ParameterList with current values.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 225 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ initialize()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::initialize ( ) const

inlineoverridevirtual

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 249 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getController()

template<class Scalar >

virtual std::string Tempus::TimeStepControlStrategyIntegralController< Scalar >::getController ( ) const

inlinevirtual

Definition at line 278 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getKI()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getKI ( ) const

inlinevirtual

Definition at line 279 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getKP()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getKP ( ) const

inlinevirtual

Definition at line 280 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getKD()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getKD ( ) const

inlinevirtual

Definition at line 281 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getSafetyFactor()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getSafetyFactor ( ) const

inlinevirtual

Definition at line 282 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getSafetyFactorAfterReject()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getSafetyFactorAfterReject ( ) const

inlinevirtual

Definition at line 283 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getFacMax()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getFacMax ( ) const

inlinevirtual

Definition at line 287 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ getFacMin()

template<class Scalar >

virtual Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::getFacMin ( ) const

inlinevirtual

Definition at line 288 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setController()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setController ( std::string c )

inlinevirtual

Definition at line 290 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setKI()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setKI ( Scalar k )

inlinevirtual

Definition at line 295 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setKP()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setKP ( Scalar k )

inlinevirtual

Definition at line 300 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setKD()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setKD ( Scalar k )

inlinevirtual

Definition at line 305 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setSafetyFactor()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setSafetyFactor ( Scalar f )

inlinevirtual

Definition at line 310 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setSafetyFactorAfterReject()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setSafetyFactorAfterReject ( Scalar f )

inlinevirtual

Definition at line 315 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setFacMax()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setFacMax ( Scalar f )

inlinevirtual

Definition at line 320 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ setFacMin()

template<class Scalar >

virtual void Tempus::TimeStepControlStrategyIntegralController< Scalar >::setFacMin ( Scalar f )

inlinevirtual

Definition at line 326 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

Member Data Documentation

◆ controller_

template<class Scalar >

std::string Tempus::TimeStepControlStrategyIntegralController< Scalar >::controller_

private

Control type ['I', 'PI', 'PID'].

Definition at line 333 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ KI_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::KI_

private

Integral gain.

Definition at line 334 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ KP_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::KP_

private

Proportional gain.

Definition at line 335 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ KD_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::KD_

private

Derivative gain.

Definition at line 336 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ safetyFactor_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::safetyFactor_

private

Safety Factor.

Definition at line 337 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ safetyFactorAfterReject_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::safetyFactorAfterReject_

private

Safety Factor Following Step Rejection.

Definition at line 338 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ facMaxINPUT_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::facMaxINPUT_

private

Maximum Safety Factor from input.

Definition at line 339 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ facMax_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::facMax_

private

Maximum Safety Factor.

Definition at line 340 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ facMin_

template<class Scalar >

Scalar Tempus::TimeStepControlStrategyIntegralController< Scalar >::facMin_

private

Minimum Safety Factor.

Definition at line 341 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ firstSuccessfulStep_

template<class Scalar >

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

private

Definition at line 342 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

◆ lastStepRejected_

template<class Scalar >

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

private

Definition at line 343 of file Tempus_TimeStepControlStrategyIntegralController.hpp.

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

Tempus_TimeStepControlStrategyIntegralController.hpp

Public Member Functions

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeStepControlStrategyIntegralController() [1/2]

◆ TimeStepControlStrategyIntegralController() [2/2]

◆ ~TimeStepControlStrategyIntegralController()

Member Function Documentation

◆ setNextTimeStep()

◆ description()

◆ describe()

◆ getValidParameters()

◆ initialize()

◆ getController()

◆ getKI()

◆ getKP()

◆ getKD()

◆ getSafetyFactor()

◆ getSafetyFactorAfterReject()

◆ getFacMax()

◆ getFacMin()

◆ setController()

◆ setKI()

◆ setKP()

◆ setKD()

◆ setSafetyFactor()

◆ setSafetyFactorAfterReject()

◆ setFacMax()

◆ setFacMin()

Member Data Documentation

◆ controller_

◆ KI_

◆ KP_

◆ KD_

◆ safetyFactor_

◆ safetyFactorAfterReject_

◆ facMaxINPUT_

◆ facMax_

◆ facMin_

◆ firstSuccessfulStep_

◆ lastStepRejected_