timer_obj – LEAP

type, public :: timer_obj

Time management utility

Inherits

Help

Inherited by

Help

Components

Type	Visibility	Attributes		Name		Initial
real(kind=wp),	public		::	dt			Timestep
logical,	public		::	finish	=	.false.	Instructs simulation to end
real(kind=wp),	public		::	freq_output	=	huge(1.0_wp)
real(kind=wp),	public		::	freq_write	=	huge(1.0_wp)	Frequency of restart writes
integer,	public		::	iter	=	0	Current iteration
integer,	public		::	iter_max	=	huge(1)	Maximum iterations
real(kind=wp),	public		::	itertime			Wall clock time at beginning of iteration (in seconds)
real(kind=wp),	public		::	lasttime			Wall clock time at last update (in seconds)
type(parallel_obj),	public,	pointer	::	parallel			Parallel object
type(parser_obj),	public,	pointer	::	parser			Parser object
real(kind=wp),	public		::	starttime			Wall clock time at initialization (in seconds)
real(kind=wp),	public		::	time	=	0.0_wp	Time at the n-th timestep
real(kind=wp),	public		::	time_max	=	huge(1.0_wp)	Maximum simulation time
real(kind=wp),	public		::	time_wall	=	huge(1.0_wp)	Wall time (in hours)
real(kind=wp),	public,	allocatable	::	timing(:)			Timing array
type(hashtbl_obj),	private		::	tbl			Hash table for timing info

Type-Bound Procedures

procedure, public :: AddTiming => timer_obj_AddTiming

private pure subroutine timer_obj_AddTiming(this, name)

Adds timing info.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer
character(len=*),	intent(in)			::	name	Name of timing data

procedure, public :: Done => timer_obj_Done

private impure function timer_obj_Done(this) result(res)

Determines whether simulation is over.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer

Return Value logical

Result

procedure, public :: EndRun => timer_obj_EndRun

private pure subroutine timer_obj_EndRun(this)

Changes run status to finished.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer

procedure, public :: Finalize => timer_obj_Final

private pure subroutine timer_obj_Final(this)

Finalizes and frees memomry.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer

procedure, public :: GetTiming => timer_obj_GetTiming

private pure function timer_obj_GetTiming(this, name) result(res)

Returns timing information for data given by name.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(in)			::	this	Timer
character(len=*),	intent(in)			::	name	Name of timing data

Return Value real(kind=wp)

Timing

procedure, public :: Initialize => timer_obj_Init

private impure subroutine timer_obj_Init(this, parallel, parser)

Initializes the timer.

Arguments

Type	Intent	Attributes		Name
class(timer_obj),	intent(inout)		::	this	Timer
type(parallel_obj),	intent(in),	target	::	parallel	Parallel structure to link with
type(parser_obj),	intent(in),	target	::	parser	Input file parsing tool

procedure, public :: StepForward => timer_obj_StepForward

private impure subroutine timer_obj_StepForward(this)

Moves timer from n to n+1

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer

procedure, public :: TimeToWriteOutputData => timer_obj_TimeToWriteOutputData

private pure function timer_obj_TimeToWriteOutputData(this) result(res)

Determine whether it is time to write visualization files.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(in)			::	this	Timer

Return Value logical

Result

procedure, public :: TimeToWriteRestartData => timer_obj_TimeToWriteRestartData

private pure function timer_obj_TimeToWriteRestartData(this) result(res)

Determine whether it is time to write restart files.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(in)			::	this	Timer

Return Value logical

Result

procedure, public :: UpdateTiming => timer_obj_UpdateTiming

private impure subroutine timer_obj_UpdateTiming(this, name)

Updates timing info with elapsed time since beginning of current iteration.

Arguments

Type	Intent	Optional	Attributes		Name
class(timer_obj),	intent(inout)			::	this	Timer
character(len=*),	intent(in)			::	name	Name of timing data

Source Code

  type :: timer_obj
    !> Time management utility
    type(parallel_obj),pointer :: parallel                                     !! Parallel object
    type(parser_obj),  pointer :: parser                                       !! Parser object
    real(wp)                   :: starttime                                    !! Wall clock time at initialization (in seconds)
    real(wp)                   :: itertime                                     !! Wall clock time at beginning of iteration (in seconds)
    real(wp)                   :: lasttime                                     !! Wall clock time at last update (in seconds)
    real(wp)                   :: dt                                           !! Timestep
    real(wp)                   :: time         = 0.0_wp                        !! Time at the n-th timestep
    real(wp)                   :: time_max     = huge(1.0_wp)                  !! Maximum simulation time
    real(wp)                   :: time_wall    = huge(1.0_wp)                  !! Wall time (in hours)
    real(wp)                   :: freq_write   = huge(1.0_wp)                  !! Frequency of restart writes
    real(wp)                   :: freq_output  = huge(1.0_wp)
    integer                    :: iter         = 0                             !! Current iteration
    integer                    :: iter_max     = huge(1)                       !! Maximum iterations
    logical                    :: finish       = .false.                       !! Instructs simulation to end
    real(wp),      allocatable :: timing(:)                                    !! Timing array
    type(hashtbl_obj), private :: tbl                                          !! Hash table for timing info
    contains
      procedure :: Initialize              => timer_obj_Init
      procedure :: Finalize                => timer_obj_Final
      procedure :: StepForward             => timer_obj_StepForward
      procedure :: Done                    => timer_obj_Done
      procedure :: EndRun                  => timer_obj_EndRun
      procedure :: TimeToWriteRestartData  => timer_obj_TimeToWriteRestartData
      procedure :: TimeToWriteOutputData   => timer_obj_TimeToWriteOutputData
      procedure :: AddTiming               => timer_obj_AddTiming
      procedure :: UpdateTiming            => timer_obj_UpdateTiming
      procedure :: GetTiming               => timer_obj_GetTiming
  end type timer_obj

timer_obj Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public :: timer_obj

Inherits

Inherited by

Components

Type-Bound Procedures

procedure, public :: AddTiming => timer_obj_AddTiming

private pure subroutine timer_obj_AddTiming(this, name)

Arguments

procedure, public :: Done => timer_obj_Done

private impure function timer_obj_Done(this) result(res)

Arguments

Return Value logical

procedure, public :: EndRun => timer_obj_EndRun

private pure subroutine timer_obj_EndRun(this)

Arguments

procedure, public :: Finalize => timer_obj_Final

private pure subroutine timer_obj_Final(this)

Arguments

procedure, public :: GetTiming => timer_obj_GetTiming

private pure function timer_obj_GetTiming(this, name) result(res)

Arguments

Return Value real(kind=wp)

procedure, public :: Initialize => timer_obj_Init

private impure subroutine timer_obj_Init(this, parallel, parser)

Arguments

procedure, public :: StepForward => timer_obj_StepForward

private impure subroutine timer_obj_StepForward(this)

Arguments

procedure, public :: TimeToWriteOutputData => timer_obj_TimeToWriteOutputData

private pure function timer_obj_TimeToWriteOutputData(this) result(res)

Arguments

Return Value logical

procedure, public :: TimeToWriteRestartData => timer_obj_TimeToWriteRestartData

private pure function timer_obj_TimeToWriteRestartData(this) result(res)

Arguments

Return Value logical

procedure, public :: UpdateTiming => timer_obj_UpdateTiming

private impure subroutine timer_obj_UpdateTiming(this, name)

Arguments

Source Code