time_state Module Reference

Module with things related to the simulation time.

Data Types
type	time_state_t
	A struct that contains all info about the time, expand as needed. More...

Functions/Subroutines
subroutine	time_state_init_from_json (this, params)
	Initialize time state from JSON.
subroutine	time_state_init_from_components (this, start_time, end_time, dt)
	Initialize time state.
subroutine	time_state_reset (this)
	Reset time state.
subroutine	time_state_status (this)
	Write status banner.
pure logical function	time_state_is_done (this)
	Check if the simulation is done.

Function/Subroutine Documentation

time_state_init_from_components()

subroutine time_state::time_state_init_from_components ( class(time_state_t), intent(inout)  this, real(kind=dp), intent(in)  start_time, real(kind=dp), intent(in)  end_time, real(kind=dp), intent(in)  dt  )

private

Definition at line 90 of file time_state.f90.

time_state_init_from_json()

subroutine time_state::time_state_init_from_json	(	class(time_state_t), intent(inout)	this,
		type(json_file), intent(inout)	params
	)

Definition at line 66 of file time_state.f90.

time_state_is_done()

pure logical function time_state::time_state_is_done ( class(time_state_t), intent(in)  this )

private

Note

The comparison is made on the progress from the start time in the direction of the simulation, so that it also holds for a simulation marching backwards in time. The tolerance keeps a time a few ulps short of the end time from adding one more time step, which would overshoot the end time by almost dt and produce an output past it.

Definition at line 156 of file time_state.f90.

time_state_reset()

subroutine time_state::time_state_reset ( class(time_state_t), intent(inout)  this )

private

Definition at line 113 of file time_state.f90.

time_state_status()

subroutine time_state::time_state_status ( class(time_state_t), intent(in)  this )

private

Definition at line 124 of file time_state.f90.