A struct that contains all info about the time, expand as needed. More...

Public Member Functions
generic	init (this, start_time, end_time, dt)
	Initialize time state.

generic	init (this, params)
	Initialize time state from JSON.

procedure, pass(this)	init_from_components (this, start_time, end_time, dt)
	Initialize time state.

procedure, pass(this)	init_from_json (this, params)
	Initialize time state from JSON.

procedure, pass(this)	reset (this)
	Reset time state.

procedure, pass(this)	status (this)
	Write status banner.

procedure, pass(this)	is_done (this)
	Check if the simulation is done.

Public Attributes
real(kind=dp), dimension(10)	tlag = 0.0_dp
	Old times.

real(kind=dp), dimension(10)	dtlag = 0.0_dp
	Old dts.

real(kind=dp)	t = 0.0_dp
	Current time.

real(kind=dp)	dt = 0.0_dp
	Current dt.

real(kind=dp)	start_time = 0.0_dp
	Start time.

real(kind=dp)	end_time = 0.0_dp
	End time.

integer	tstep = 0
	Current timestep.

Detailed Description

Definition at line 44 of file time_state.f90.

Member Function/Subroutine Documentation

◆ init() [1/2]

generic time_state::time_state_t::init	(	class(time_state_t), intent(inout)	this,
		type(json_file), intent(inout)	params
	)

Definition at line 54 of file time_state.f90.

◆ init() [2/2]

generic time_state::time_state_t::init	(	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
	)

Definition at line 54 of file time_state.f90.

◆ init_from_components()

procedure, pass(this) time_state::time_state_t::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
	)

Definition at line 55 of file time_state.f90.

◆ init_from_json()

procedure, pass(this) time_state::time_state_t::init_from_json	(	class(time_state_t), intent(inout)	this,
		type(json_file), intent(inout)	params
	)

Definition at line 57 of file time_state.f90.

◆ is_done()

procedure, pass(this) time_state::time_state_t::is_done ( class(time_state_t), intent(in) this )

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 60 of file time_state.f90.

◆ reset()

procedure, pass(this) time_state::time_state_t::reset ( class(time_state_t), intent(inout) this )

Definition at line 58 of file time_state.f90.

◆ status()

procedure, pass(this) time_state::time_state_t::status ( class(time_state_t), intent(in) this )

Definition at line 59 of file time_state.f90.

Member Data Documentation

◆ dt

real(kind=dp) time_state::time_state_t::dt = 0.0_dp

Definition at line 48 of file time_state.f90.

◆ dtlag

real(kind=dp), dimension(10) time_state::time_state_t::dtlag = 0.0_dp

Definition at line 46 of file time_state.f90.

◆ end_time

real(kind=dp) time_state::time_state_t::end_time = 0.0_dp

Definition at line 50 of file time_state.f90.

◆ start_time

real(kind=dp) time_state::time_state_t::start_time = 0.0_dp

Definition at line 49 of file time_state.f90.

◆ t

real(kind=dp) time_state::time_state_t::t = 0.0_dp

Definition at line 47 of file time_state.f90.

◆ tlag

real(kind=dp), dimension(10) time_state::time_state_t::tlag = 0.0_dp

Definition at line 45 of file time_state.f90.

◆ tstep

integer time_state::time_state_t::tstep = 0

Definition at line 51 of file time_state.f90.

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

/home/runner/work/neko/neko/src/common/time_state.f90

Public Member Functions

Public Attributes