KTH Toolbox: monitor

Files
file	mntrlog.f
	Set of module register and logging routines for KTH framework.
file	mntrlog_block.f
	Block data to initialise common blocks in MNTRLOGD.
file	mntrtmr.f
	Set of timer database routines for KTH framework.
file	mntrtmr_block.f
	Block data to initialise common blocks in MNTRTMRD.

Functions/Subroutines
subroutine	mntr_register_mod (log_thr)
	Initialise monitor by registering framework and monitor. More...
subroutine	mntr_register_par
	Register monitor runtime parameters. More...
subroutine	mntr_init
	Initialise monitor module. More...
subroutine	mntr_wclock
	Monitor simulation wall clock. More...
subroutine	mntr_set_step_delay (dstep)
	Set number of steps necessary to write proper checkpointing. More...
subroutine	mntr_get_step_delay (dstep)
	Get step delay. More...
subroutine	mntr_set_conv (ifconv)
	Set convergence flag to shorten simulation. More...
logical function	mntr_is_initialised ()
	Check if module was initialised. More...
integer function	mntr_lp_def_get ()
	Get logging threashold. More...
subroutine	mntr_mod_reg (mid, pmid, mname, mdscr)
	Register new module. More...
subroutine	mntr_mod_is_name_reg (mid, mname)
	Check if module name is registered and return its id. More...
logical function	mntr_mod_is_id_reg (mid)
	Check if module id is registered. This operation is performed locally. More...
subroutine	mntr_mod_get_number (nmod, mmod)
	Get number of registered modules. This operation is performed locally. More...
subroutine	mntr_mod_get_info (mname, pmid, mid)
	Get module name an parent id for given module id. This operation is performed locally. More...
subroutine	mntr_log (mid, priority, logs)
	Write log message. More...
subroutine	mntr_log_local (mid, priority, logs, prid)
	Write log message from given process. More...
subroutine	mntr_logi (mid, priority, logs, ivar)
	Write log message adding single integer. More...
subroutine	mntr_logr (mid, priority, logs, rvar)
	Write log message adding single real. More...
subroutine	mntr_logl (mid, priority, logs, lvar)
	Write log message adding single logical. More...
subroutine	mntr_warn (mid, logs)
	Write warning message. More...
subroutine	mntr_error (mid, logs)
	Write error message. More...
subroutine	mntr_abort (mid, logs)
	Abort simulation. More...
subroutine	mntr_check_abort (mid, ierr, logs)
	Abort simulation. More...
subroutine	mntr_mod_summary_print ()
	Print registered modules showing tree structure. More...
subroutine	mntr_mod_get_olist (olist, ierr)
	Provide ordered list of registered modules for printing. More...
recursive subroutine	mntr_build_ord_list (olist, slist, nlist, npos, parent, level)
	Build ordered list reflecting graph structure. More...
subroutine	mntr_tmr_reg (mid, pmid, modid, mname, mdscr, ifsum)
	Register new timer. More...
subroutine	mntr_tmr_is_name_reg (mid, mname)
	Check if timer name is registered and return its id. More...
logical function	mntr_tmr_is_id_reg (mid)
	Check if timer id is registered. This operation is performed locally. More...
subroutine	mntr_tmr_add (mid, icount, time)
	Check if timer id is registered. This operation is performed locally. More...
subroutine	mntr_tmr_summary_print ()
	Print registered timers showing tree structure. More...
subroutine	mntr_tmr_get_olist (olist, ierr)
	Provide ordered list of registered timers for printing. More...

Detailed Description

Function/Subroutine Documentation

mntr_abort()

subroutine mntr_abort	(	integer	mid,
		character*(*)	logs
	)

Abort simulation.

Parameters

[in]	mid	module id
[in]	logs	log body

mntr_build_ord_list()

recursive subroutine mntr_build_ord_list	(	integer, dimension(2,nlist)	olist,
		integer, dimension(2,nlist)	slist,
		integer	nlist,
		integer	npos,
		integer	parent,
		integer	level
	)

Build ordered list reflecting graph structure.

Parameters

[out]	olist	ordered list
[in,out]	slist	list sorted with respect to parent
[in]	nlist	lists length
[in,out]	npos	position in olist array
[in]	parent	parent id
[in]	level	parent level

mntr_check_abort()

subroutine mntr_check_abort	(	integer	mid,
		integer	ierr,
		character*(*)	logs
	)

Abort simulation.

Parameters

[in]	mid	module id
[in]	ierr	error flag
[in]	logs	log body

mntr_error()

subroutine mntr_error	(	integer	mid,
		character*(*)	logs
	)

Write error message.

Parameters

[in]	mid	module id
[in]	logs	log body

mntr_get_step_delay()

subroutine mntr_get_step_delay

(

integer

dstep

)

Get step delay.

Parameters

[out]

dstep

step delay

mntr_init()

subroutine mntr_init

Initialise monitor module.

mntr_is_initialised()

logical function mntr_is_initialised

Check if module was initialised.

Returns

mntr_is_initialised

mntr_log()

subroutine mntr_log	(	integer	mid,
		integer	priority,
		character*(*)	logs
	)

Write log message.

Parameters

[in]	mid	module id
[in]	priority	log priority
[in]	logs	log body

mntr_log_local()

subroutine mntr_log_local	(	integer	mid,
		integer	priority,
		character*(*)	logs,
		integer	prid
	)

Write log message from given process.

Parameters

[in]	mid	module id
[in]	priority	log priority
[in]	logs	log body
[in]	prid	process id

mntr_logi()

subroutine mntr_logi	(	integer	mid,
		integer	priority,
		character*(*)	logs,
		integer	ivar
	)

Write log message adding single integer.

Parameters

[in]	mid	module id
[in]	priority	log priority
[in]	logs	log body
[in]	ivar	integer variable

mntr_logl()

subroutine mntr_logl	(	integer	mid,
		integer	priority,
		character*(*)	logs,
		logical	lvar
	)

Write log message adding single logical.

Parameters

[in]	mid	module id
[in]	priority	log priority
[in]	logs	log body
[in]	lvar	logical variable

mntr_logr()

subroutine mntr_logr	(	integer	mid,
		integer	priority,
		character*(*)	logs,
		real	rvar
	)

Write log message adding single real.

Parameters

[in]	mid	module id
[in]	priority	log priority
[in]	logs	log body
[in]	rvar	real variable

mntr_lp_def_get()

integer function mntr_lp_def_get

Get logging threashold.

Returns

mntr_lp_def_get

mntr_mod_get_info()

subroutine mntr_mod_get_info	(	character*10	mname,
		integer	pmid,
		integer	mid
	)

Get module name an parent id for given module id. This operation is performed locally.

Parameters

[out]	pmid	parent module id
[out]	mname	module name
[in,out]	mid	module id

mntr_mod_get_number()

subroutine mntr_mod_get_number	(	integer	nmod,
		integer	mmod
	)

Get number of registered modules. This operation is performed locally.

Parameters

[out]	nmod	module number
[out]	mmod	max module id

mntr_mod_get_olist()

subroutine mntr_mod_get_olist	(	integer, dimension(2,mntr_id_max)	olist,
		integer	ierr
	)

Provide ordered list of registered modules for printing.

Parameters

[out]	olist	ordered list
[out]	ierr	error flag

mntr_mod_is_id_reg()

logical function mntr_mod_is_id_reg

(

integer

mid

)

Check if module id is registered. This operation is performed locally.

Parameters

[in]

mid

module id

Returns

mntr_mod_is_id_reg

mntr_mod_is_name_reg()

subroutine mntr_mod_is_name_reg	(	integer	mid,
		character*(*)	mname
	)

Check if module name is registered and return its id.

Parameters

[out]	mid	module id
[in]	mname	module name

mntr_mod_reg()

subroutine mntr_mod_reg	(	integer	mid,
		integer	pmid,
		character*(*)	mname,
		character*(*)	mdscr
	)

Register new module.

Parameters

[out]	mid	current module id
[in]	pmid	parent module id
[in]	mname	module name
[in]	mdscr	module description

mntr_mod_summary_print()

subroutine mntr_mod_summary_print

Print registered modules showing tree structure.

mntr_register_mod()

subroutine mntr_register_mod

(

integer

log_thr

)

Initialise monitor by registering framework and monitor.

Parameters

[in]

log_thr

initial log threshold

mntr_register_par()

subroutine mntr_register_par

Register monitor runtime parameters.

mntr_set_conv()

subroutine mntr_set_conv

(

logical

ifconv

)

Set convergence flag to shorten simulation.

mntr_set_step_delay()

subroutine mntr_set_step_delay

(

integer

dstep

)

Set number of steps necessary to write proper checkpointing.

Parameters

[in]

dstep

step delay

mntr_tmr_add()

subroutine mntr_tmr_add	(	integer	mid,
		integer	icount,
		real	time
	)

Check if timer id is registered. This operation is performed locally.

Parameters

[in]	mid	timer id
[in]	icount	count increase
[in]	time	time increase

mntr_tmr_get_olist()

subroutine mntr_tmr_get_olist	(	integer, dimension(2,mntr_tmr_id_max)	olist,
		integer	ierr
	)

Provide ordered list of registered timers for printing.

Parameters

[out]	olist	ordered list
[out]	ierr	error flag

mntr_tmr_is_id_reg()

logical function mntr_tmr_is_id_reg

(

integer

mid

)

Check if timer id is registered. This operation is performed locally.

Parameters

[in]

mid

timer id

Returns

mntr_tmr_is_id_reg

mntr_tmr_is_name_reg()

subroutine mntr_tmr_is_name_reg	(	integer	mid,
		character*(*)	mname
	)

Check if timer name is registered and return its id.

Parameters

[out]	mid	timer id
[in]	mname	timer name

mntr_tmr_reg()

subroutine mntr_tmr_reg	(	integer	mid,
		integer	pmid,
		integer	modid,
		character*(*)	mname,
		character*(*)	mdscr,
		logical	ifsum
	)

Register new timer.

Parameters

[out]	mid	new timer id
[in]	pmid	parent timer id
[in]	modid	registerring module id
[in]	mname	timer name
[in]	mdscr	timer description
[in]	ifsum	add timer to parent

mntr_tmr_summary_print()

subroutine mntr_tmr_summary_print

Print registered timers showing tree structure.

mntr_warn()

subroutine mntr_warn	(	integer	mid,
		character*(*)	logs
	)

Write warning message.

Parameters

[in]	mid	module id
[in]	logs	log body

mntr_wclock()

subroutine mntr_wclock

Monitor simulation wall clock.