Timers

Erik Schnetter <schnetter@gmail.com>

August 07 2013

Abstract

1 Introduction

2 Physical System

3 Numerical Implementation

4 Using This Thorn

4.1 Obtaining This Thorn

4.2 Basic Usage

4.3 Special Behaviour

4.4 Interaction With Other Thorns

4.5 Examples

4.6 Support and Feedback

5 History

5.1 Thorn Source Code

5.2 Thorn Documentation

5.3 Acknowledgements

References

6 Parameters


disable_cactus_timer_set	Scope: private	BOOLEAN

Description: Disable Cactus timer set

		Default: no


disable_timer_trees	Scope: private	BOOLEAN

Description: Disable timer trees

		Default: no


output_precision	Scope: private	INT

Description: Number of decimal places to use in standard output for timer tree

Range		Default: 1
1:*	number of decimal places


threshold_percentage	Scope: private	REAL

Description: The percentage of the root timer below which timers are omitted

Range		Default: 1.0
0:*


verbose	Scope: private	BOOLEAN

Description: Output (debug) messages when a timer is started or stopped

		Default: no


xml_clock	Scope: private	STRING

Description: Which clock to use in the XML timer output file

Range		Default: gettimeofday
.*	must be a legal clock name


out_dir	Scope: shared from IO	STRING

7 Interfaces

General

Implements:

timers

Adds header:

CactusTimer.hh

CactusTimerSet.hh

Timer.hh

TimerTree.hh

8 Schedule

This section lists all the variables which are assigned storage by thorn Carpet/Timers. Storage can either last for the duration of the run (Always means that if this thorn is activated storage will be assigned, Conditional means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.

Storage

NONE

Scheduled Functions

CCTK_STARTUP

timer_startup

prepare hierarchical timers

	Before:	driver_startup
	Language:	c
	Type:	function

CCTK_SHUTDOWN

timer_shutdown

prepare hierarchical timers

	After:	driver_shutdown
	Language:	c
	Type:	function