NumLib::TimeStep Class Reference

Detailed Description

Time step object.

TimeStep class contains previous time( \(t_{n}\)), current time ( \(t_{n+1}\)), time step length ( \(\Delta t_{n+1}\)), and the number of time steps ( \(n+1\)).

Definition at line 32 of file TimeStep.h.

#include <TimeStep.h>

Collaboration diagram for NumLib::TimeStep:

Public Member Functions
	TimeStep (Time const &current_time)
	TimeStep (Time const &previous_time, Time const &current_time, std::size_t n)
	TimeStep (const TimeStep &src)=default
	copy a time step
TimeStep &	operator= (const TimeStep &src)=default
	copy a time step
TimeStep &	operator+= (const double dt)
	increment time step
Time	previous () const
	return previous time step
Time	current () const
	return current time step
double	dt () const
	time step size from _previous
std::size_t	timeStepNumber () const
	the time step number
void	setAccepted (bool const accepted)
bool	isAccepted () const

Private Attributes
Time	_previous
	previous time step
Time	_current
	current time step
double	_dt
	time step size
std::size_t	_time_step_number
	the number of time steps
bool	_is_accepted = true
	is the timestep accepted

Friends
std::ostream &	operator<< (std::ostream &os, TimeStep const &ts)

Constructor & Destructor Documentation

TimeStep() [1/3]

NumLib::TimeStep::TimeStep ( Time const & current_time )

inlineexplicit

Initialize a time step

Parameters

current_time

current time

Definition at line 39 of file TimeStep.h.

        : _previous(current_time),
          _current(current_time),
          _dt(0.0),
          _time_step_number(0)
    {
    }

References _current, _dt, _previous, and _time_step_number.

Referenced by TimeStep(), operator+=(), operator<<, and operator=().

TimeStep() [2/3]

NumLib::TimeStep::TimeStep ( Time const & previous_time, Time const & current_time, std::size_t n )

inline

Initialize a time step

Parameters

previous_time	previous time
current_time	current time
n	the number of time steps

Definition at line 53 of file TimeStep.h.

        : _previous(previous_time),
          _current(current_time),
          _dt(_current() - _previous()),
          _time_step_number(n)
    {
    }

References _current, _dt, _previous, and _time_step_number.

TimeStep() [3/3]

NumLib::TimeStep::TimeStep ( const TimeStep & src )

default

copy a time step

References TimeStep().

Member Function Documentation

current()

Time NumLib::TimeStep::current ( ) const

inline

return current time step

Definition at line 80 of file TimeStep.h.

{ return _current; }

References _current.

Referenced by NumLib::IterationNumberBasedTimeStepping::getNextTimeStepSize(), NumLib::EvolutionaryPIDcontroller::limitStepSize(), NumLib::FixedTimeStepping::next(), and operator<<.

dt()

double NumLib::TimeStep::dt ( ) const

inline

time step size from _previous

Definition at line 82 of file TimeStep.h.

{ return _dt; }

References _dt.

Referenced by NumLib::canReduceTimestepSize(), NumLib::IterationNumberBasedTimeStepping::getNextTimeStepSize(), NumLib::EvolutionaryPIDcontroller::limitStepSize(), NumLib::EvolutionaryPIDcontroller::next(), NumLib::IterationNumberBasedTimeStepping::next(), operator+=(), and operator<<.

isAccepted()

bool NumLib::TimeStep::isAccepted ( ) const

inline

Definition at line 87 of file TimeStep.h.

{ return _is_accepted; }

References _is_accepted.

Referenced by NumLib::IterationNumberBasedTimeStepping::getNextTimeStepSize(), NumLib::EvolutionaryPIDcontroller::next(), NumLib::IterationNumberBasedTimeStepping::next(), and operator<<.

operator+=()

TimeStep & NumLib::TimeStep::operator+= ( const double dt )

inline

increment time step

Definition at line 68 of file TimeStep.h.

    {
        _previous = _current;
        _current += dt;
        _dt = dt;
        _time_step_number++;
        return *this;
    }

References TimeStep(), _current, _dt, _previous, _time_step_number, and dt().

operator=()

TimeStep & NumLib::TimeStep::operator= ( const TimeStep & src )

default

copy a time step

References TimeStep().

previous()

Time NumLib::TimeStep::previous ( ) const

inline

return previous time step

Definition at line 78 of file TimeStep.h.

{ return _previous; }

References _previous.

Referenced by NumLib::IterationNumberBasedTimeStepping::next(), and operator<<.

setAccepted()

void NumLib::TimeStep::setAccepted ( bool const accepted )

inline

Definition at line 86 of file TimeStep.h.

{ _is_accepted = accepted; }

References _is_accepted.

Referenced by NumLib::EvolutionaryPIDcontroller::next(), and NumLib::IterationNumberBasedTimeStepping::next().

timeStepNumber()

std::size_t NumLib::TimeStep::timeStepNumber ( ) const

inline

the time step number

Definition at line 84 of file TimeStep.h.

{ return _time_step_number; }

References _time_step_number.

Referenced by NumLib::IterationNumberBasedTimeStepping::getNextTimeStepSize(), NumLib::EvolutionaryPIDcontroller::next(), NumLib::FixedTimeStepping::next(), NumLib::IterationNumberBasedTimeStepping::next(), and operator<<.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, TimeStep const & ts )

friend

Definition at line 89 of file TimeStep.h.

    {
        return os << "previous: " << ts.previous()
                  << " | current: " << ts.current() << " | dt: " << ts.dt()
                  << " | timestep number: " << ts.timeStepNumber()
                  << " | is_accepted: " << ts.isAccepted();
    }

References TimeStep(), current(), dt(), isAccepted(), previous(), and timeStepNumber().

Member Data Documentation

_current

Time NumLib::TimeStep::_current

private

current time step

Definition at line 101 of file TimeStep.h.

Referenced by TimeStep(), TimeStep(), current(), and operator+=().

_dt

double NumLib::TimeStep::_dt

private

time step size

Definition at line 103 of file TimeStep.h.

Referenced by TimeStep(), TimeStep(), dt(), and operator+=().

_is_accepted

bool NumLib::TimeStep::_is_accepted = true

private

is the timestep accepted

Definition at line 107 of file TimeStep.h.

Referenced by isAccepted(), and setAccepted().

_previous

Time NumLib::TimeStep::_previous

private

previous time step

Definition at line 99 of file TimeStep.h.

Referenced by TimeStep(), TimeStep(), operator+=(), and previous().

_time_step_number

std::size_t NumLib::TimeStep::_time_step_number

private

the number of time steps

Definition at line 105 of file TimeStep.h.

Referenced by TimeStep(), TimeStep(), operator+=(), and timeStepNumber().

---

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

• NumLib/TimeStepping/TimeStep.h