Detailed Description

Interface of time stepping algorithms.

Definition at line 27 of file TimeStepAlgorithm.h.

#include <TimeStepAlgorithm.h>

Inheritance diagram for NumLib::TimeStepAlgorithm:

Collaboration diagram for NumLib::TimeStepAlgorithm:

Public Member Functions
	TimeStepAlgorithm (const double t0, const double t_end)

	TimeStepAlgorithm (const double t0, const double t_end, const double dt)

	TimeStepAlgorithm (const double t0, const double t_end, const std::vector< double > &all_step_sizes)

virtual	~TimeStepAlgorithm ()=default

double	begin () const
	return the beginning of time steps More...

double	end () const
	return the end of time steps More...

const TimeStep	getTimeStep () const
	return current time step More...

void	resetCurrentTimeStep (const double dt)
	reset the current step size from the previous time More...

virtual std::tuple< bool, double >	next (const double solution_error, int number_iterations)=0

virtual bool	accepted () const =0
	return if current time step is accepted or not More...

virtual void	setAcceptedOrNot (const bool accepted)

const std::vector< double > &	getTimeStepSizeHistory () const
	return a history of time step sizes More...

virtual bool	isSolutionErrorComputationNeeded () const

virtual bool	canReduceTimestepSize () const
	Query the timestepper if further time step size reduction is possible. More...

Protected Attributes
const double	_t_initial
	initial time More...

const double	_t_end
	end time More...

TimeStep	_ts_prev
	previous time step information More...

TimeStep	_ts_current
	current time step information More...

std::vector< double >	_dt_vector
	a vector of time step sizes More...

Constructor & Destructor Documentation

◆ TimeStepAlgorithm() [1/3]

NumLib::TimeStepAlgorithm::TimeStepAlgorithm	(	const double	t0,
		const double	t_end
	)

inline

Definition at line 30 of file TimeStepAlgorithm.h.

         : _t_initial(t0), _t_end(t_end), _ts_prev(t0), _ts_current(t0)
     {
     }

◆ TimeStepAlgorithm() [2/3]

NumLib::TimeStepAlgorithm::TimeStepAlgorithm	(	const double	t0,
		const double	t_end,
		const double	dt
	)

inline

Definition at line 35 of file TimeStepAlgorithm.h.

         : _t_initial(t0), _t_end(t_end), _ts_prev(t0), _ts_current(t0)
     {
         auto const new_size =
             static_cast<std::size_t>(std::ceil((t_end - t0) / dt));
         try
         {
             _dt_vector = std::vector<double>(new_size, dt);
         }
         catch (std::length_error const& e)
         {
             OGS_FATAL(
                 "Resize of the time steps vector failed for the requested new "
                 "size {:d}. Probably there is not enough memory ({:g} GiB "
                 "requested).\n"
                 "Thrown exception: {:s}",
                 new_size, new_size * sizeof(double) / 1024. / 1024. / 1024.,
                 e.what());
         }
         catch (std::bad_alloc const& e)
         {
             OGS_FATAL(
                 "Allocation of the time steps vector failed for the requested "
                 "size {:d}. Probably there is not enough memory ({:d} GiB "
                 "requested).\n"
                 "Thrown exception: {:s}",
                 new_size,
                 new_size * sizeof(double) / 1024. / 1024. / 1024.,
                 e.what());
         }
     }

References _dt_vector, and OGS_FATAL.

◆ TimeStepAlgorithm() [3/3]

NumLib::TimeStepAlgorithm::TimeStepAlgorithm	(	const double	t0,
		const double	t_end,
		const std::vector< double > &	all_step_sizes
	)

inline

Definition at line 67 of file TimeStepAlgorithm.h.

         : _t_initial(t0),
           _t_end(t_end),
           _ts_prev(t0),
           _ts_current(t0),
           _dt_vector(all_step_sizes)
     {
     }

◆ ~TimeStepAlgorithm()

virtual NumLib::TimeStepAlgorithm::~TimeStepAlgorithm ( )

virtualdefault

Member Function Documentation

◆ accepted()

virtual bool NumLib::TimeStepAlgorithm::accepted ( ) const

pure virtual

return if current time step is accepted or not

Implemented in NumLib::IterationNumberBasedTimeStepping, NumLib::FixedTimeStepping, and NumLib::EvolutionaryPIDcontroller.

Referenced by setAcceptedOrNot().

◆ begin()

double NumLib::TimeStepAlgorithm::begin ( ) const

inline

return the beginning of time steps

Definition at line 80 of file TimeStepAlgorithm.h.

80 { return _t_initial; }

References _t_initial.

◆ canReduceTimestepSize()

virtual bool NumLib::TimeStepAlgorithm::canReduceTimestepSize ( ) const

inlinevirtual

Query the timestepper if further time step size reduction is possible.

Reimplemented in NumLib::IterationNumberBasedTimeStepping, and NumLib::EvolutionaryPIDcontroller.

Definition at line 120 of file TimeStepAlgorithm.h.

120 { return false; }

◆ end()

double NumLib::TimeStepAlgorithm::end ( ) const

inline

return the end of time steps

Definition at line 82 of file TimeStepAlgorithm.h.

82 { return _t_end; }

References _t_end.

◆ getTimeStep()

const TimeStep NumLib::TimeStepAlgorithm::getTimeStep ( ) const

inline

return current time step

Definition at line 84 of file TimeStepAlgorithm.h.

84 { return _ts_current; }

References _ts_current.

◆ getTimeStepSizeHistory()

const std::vector<double>& NumLib::TimeStepAlgorithm::getTimeStepSizeHistory ( ) const

inline

return a history of time step sizes

Definition at line 110 of file TimeStepAlgorithm.h.

     {
         return _dt_vector;
     }

References _dt_vector.

◆ isSolutionErrorComputationNeeded()

virtual bool NumLib::TimeStepAlgorithm::isSolutionErrorComputationNeeded ( ) const

inlinevirtual

Get a flag to indicate whether this algorithm needs to compute solution error. The default return value is false.

Reimplemented in NumLib::IterationNumberBasedTimeStepping, and NumLib::EvolutionaryPIDcontroller.

Definition at line 117 of file TimeStepAlgorithm.h.

117 { return false; }

◆ next()

virtual std::tuple<bool, double> NumLib::TimeStepAlgorithm::next	(	const double	solution_error,
		int	number_iterations
	)

pure virtual

Move to the next time step

Parameters

solution_error	Solution error \(e_n\) between two successive time steps.
number_iterations	Number of non-linear iterations used.

Returns: A step acceptance flag and the computed step size.

Implemented in NumLib::IterationNumberBasedTimeStepping, NumLib::FixedTimeStepping, and NumLib::EvolutionaryPIDcontroller.

◆ resetCurrentTimeStep()

void NumLib::TimeStepAlgorithm::resetCurrentTimeStep ( const double dt )

inline

reset the current step size from the previous time

Definition at line 86 of file TimeStepAlgorithm.h.

     {
         _ts_prev = _ts_current;
         _ts_current += dt;
         _dt_vector.push_back(dt);
     }

References _dt_vector, _ts_current, and _ts_prev.

◆ setAcceptedOrNot()

virtual void NumLib::TimeStepAlgorithm::setAcceptedOrNot ( const bool accepted )

inlinevirtual

Set the status of the step.

Parameters

accepted A boolean parameter is needed to indicated whether the step is accepted or not.

Reimplemented in NumLib::EvolutionaryPIDcontroller, and NumLib::IterationNumberBasedTimeStepping.

Definition at line 107 of file TimeStepAlgorithm.h.

107 { (void)accepted; };

NumLib::TimeStepAlgorithm::accepted

virtual bool accepted() const =0

return if current time step is accepted or not

References accepted().

Member Data Documentation

◆ _dt_vector

std::vector<double> NumLib::TimeStepAlgorithm::_dt_vector

protected

a vector of time step sizes

Definition at line 134 of file TimeStepAlgorithm.h.

Referenced by TimeStepAlgorithm(), getTimeStepSizeHistory(), NumLib::FixedTimeStepping::next(), and resetCurrentTimeStep().

◆ _t_end

const double NumLib::TimeStepAlgorithm::_t_end

protected

end time

Definition at line 126 of file TimeStepAlgorithm.h.

Referenced by end(), and NumLib::FixedTimeStepping::next().

◆ _t_initial

const double NumLib::TimeStepAlgorithm::_t_initial

protected

initial time

Definition at line 124 of file TimeStepAlgorithm.h.

Referenced by begin().

◆ _ts_current

TimeStep NumLib::TimeStepAlgorithm::_ts_current

protected

current time step information

Definition at line 131 of file TimeStepAlgorithm.h.

Referenced by NumLib::EvolutionaryPIDcontroller::canReduceTimestepSize(), NumLib::IterationNumberBasedTimeStepping::canReduceTimestepSize(), getTimeStep(), NumLib::EvolutionaryPIDcontroller::limitStepSize(), NumLib::EvolutionaryPIDcontroller::next(), NumLib::FixedTimeStepping::next(), NumLib::IterationNumberBasedTimeStepping::next(), and resetCurrentTimeStep().

◆ _ts_prev

TimeStep NumLib::TimeStepAlgorithm::_ts_prev

protected

previous time step information

Definition at line 129 of file TimeStepAlgorithm.h.

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

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

NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ TimeStepAlgorithm() [1/3]

◆ TimeStepAlgorithm() [2/3]

◆ TimeStepAlgorithm() [3/3]

◆ ~TimeStepAlgorithm()

Member Function Documentation

◆ accepted()

◆ begin()

◆ canReduceTimestepSize()

◆ end()

◆ getTimeStep()

◆ getTimeStepSizeHistory()

◆ isSolutionErrorComputationNeeded()

◆ next()

◆ resetCurrentTimeStep()

◆ setAcceptedOrNot()

Member Data Documentation

◆ _dt_vector

◆ _t_end

◆ _t_initial

◆ _ts_current

◆ _ts_prev