TimestepStatus Class Reference

Manages information about dt tried first, dt actually taken, and dt suggested for the next timestep, along with the explanation (TimestepDecision) for each. More...

#include <timestep_status.h>

Detailed Description

Manages information about dt tried first, dt actually taken, and dt suggested for the next timestep, along with the explanation (TimestepDecision) for each.

Not to be confused with the WxStepperStatus class! The WxStepperStatus is operated on by the host actions and only contains information on step success and an instance of TimestepConstraint. The TimestepStatus, on the other hand, is operated on and used by the WmSolver only, and contains information on the actual values of dt tried and taken.

Public Member Functions
	TimestepStatus ()
	Create a new dt status object.
void	updateForNextStep ()
	Prepare for next time step.
void	setTdToTry (TimestepDecision new_td)
	Set TimestepDecision to try this time step.
void	setTdTaken (TimestepDecision new_td)
	Set td taken to be new value.
void	bumpTdTaken ()
	For time step with a retryable failure, set _td_taken to _td_next.
void	setTdNext (TimestepDecision new_td)
	Set suggeted td for next time step.
void	incrementTrys ()
	Increment number of trys.
real	getDtToTry () const
	Get dt to try.
std::string *	getTryExplanation () const
	Get explanation of dt taken.
real	getDtTaken () const
	Get dt taken.
TimestepDecision	getTdTaken () const
	Get TimestepDecision of time step taken.
std::string *	getTakenExplanation () const
	Get explanation of dt taken.
real	getDtNext () const
	Get dt suggested for next time step.
TimestepConstraint *	getConstraint () const
	Get TimestepConstraint for dt taken.
std::string *	getNextExplanation () const
	Get explanation of dt suggested for next time step.
int	getNumTrys ()
	Get number of attempts this timestep.

Constructor & Destructor Documentation

TimestepStatus()

TimestepStatus::TimestepStatus ( )

inline

Create a new dt status object.

Member Function Documentation

bumpTdTaken()

void TimestepStatus::bumpTdTaken ( )

inline

For time step with a retryable failure, set _td_taken to _td_next.

Parameters

new_td

TimestepDecision to assign to _td_next.

getConstraint()

TimestepConstraint * TimestepStatus::getConstraint ( ) const

inline

Get TimestepConstraint for dt taken.

getDtNext()

real TimestepStatus::getDtNext ( ) const

inline

Get dt suggested for next time step.

getDtTaken()

real TimestepStatus::getDtTaken ( ) const

inline

Get dt taken.

getDtToTry()

real TimestepStatus::getDtToTry ( ) const

inline

Get dt to try.

getNextExplanation()

std::string * TimestepStatus::getNextExplanation ( ) const

inline

Get explanation of dt suggested for next time step.

getNumTrys()

int TimestepStatus::getNumTrys ( )

inline

Get number of attempts this timestep.

getTakenExplanation()

std::string * TimestepStatus::getTakenExplanation ( ) const

inline

Get explanation of dt taken.

getTdTaken()

TimestepDecision TimestepStatus::getTdTaken ( ) const

inline

Get TimestepDecision of time step taken.

getTryExplanation()

std::string * TimestepStatus::getTryExplanation ( ) const

inline

Get explanation of dt taken.

incrementTrys()

void TimestepStatus::incrementTrys ( )

inline

Increment number of trys.

setTdNext()

void TimestepStatus::setTdNext ( TimestepDecision  new_td )

inline

Set suggeted td for next time step.

Parameters

new_td

TimestepDecision to be tried on the next time step.

setTdTaken()

void TimestepStatus::setTdTaken ( TimestepDecision  new_td )

inline

Set td taken to be new value.

Parameters

new_td

TimestepDecision currently being taken.

setTdToTry()

void TimestepStatus::setTdToTry ( TimestepDecision  new_td )

inline

Set TimestepDecision to try this time step.

Only used when setting up a simulation or if not using the suggested dt from a previous time step.

Parameters

new_td

TimestepDecision to be tried this time step.

updateForNextStep()

void TimestepStatus::updateForNextStep ( )

inline

Prepare for next time step.

1. Point _td_taken and _td_try to value of _td_next.
2. Reset number of iterations.

---

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

• src/solver/timestep_status.h