PHASTA/Creating Timers - Revision history

Jrwrigh at 17:23, 18 September 2022

2022-09-18T17:23:57Z

Jrwrigh: /* common/common.h */

2021-09-03T18:04:53Z

‎common/common.h

Jrwrigh at 17:44, 3 September 2021

2021-09-03T17:44:20Z

Jrwrigh: Start documentation of timers

2021-09-03T17:22:42Z

Start documentation of timers

New page

This is a page to document how to create timers in PHASTA. Timers are ways of precisely timing how long a specific part of code takes to execute while having a very low overhead when doing so.

Also see [[PHASTA#Timings]] for information on reading the timers section of the PHASTA output log.

== Code Changes ==

There are several places where code needs to change (all paths relative to <code>[phasta git repository]/phSolver/</code>:
* <code>common/common.h</code>
** Place definitions of variables to be used for Fortran
* <code>common/common_c.h</code>
** Ditto, but for C/C++
* <code>common/new_interface.c</code>
** Where the timer information gets printed out to the log
* <code>{in,}commpressible/itrdrv.f</code>
** Where the variables tracking the timers get reset
* Whatever code you want to time will need to be modified

=== <code>common/common.h</code> ===

Simply need to add a <code>r*</code> and/or <code>i*</code> variable to the <code>mpistats</code>, where the <code>r</code> stands for a ''real'' number and the <code>i</code> is for an ''integer''.

The real numbers are used to track the actual time it takes to run a specific piece of code, while the integer values are used to track how many times a piece of code can be run.

=== <code>common/common_c.h</code> ===

Add the same variables you added to <code>common/common.h</code> to the <code>mpistats</code> struct. Note that capitalization doesn't matter in Fortran, but does in C/C++.

=== <code>common/new_interface.c</code> ===

Add a print statement to the <code>print_mpi_stats</code> function. You can simply copy/paste an example

← Older revision		Revision as of 17:23, 18 September 2022
Line 71:		Line 71:
	rrandomSubRoutine = rrandomSubRoutine + TMRC() - rdelta		rrandomSubRoutine = rrandomSubRoutine + TMRC() - rdelta
	endif		endif
		+
		+	[[Category:PHASTA]]

@@ Line 20: / Line 20: @@
 === <code>common/common.h</code> ===
-Simply need to add a <code>r*</code> and/or <code>i*</code> variable to the <code>mpistats</code>, where the <code>r</code> stands for a ''real'' number and the <code>i</code> is for an ''integer''.
+Simply need to add a <code>r*</code> and/or <code>i*</code> variable to the <code>mpistats</code>, where the <code>r</code> stands for a ''real'' number and the <code>i</code> is for an ''integer'' (taking advantage of Fortran's implicit variable typing).
 The real numbers are used to track the actual time it takes to run a specific piece of code, while the integer values are used to track how many times a piece of code can be run.
 === <code>common/common_c.h</code> ===

@@ Line 3: / Line 3: @@
 Also see [[PHASTA#Timings]] for information on reading the timers section of the PHASTA output log.
 == Code Changes ==
@@ Line 13: / Line 14: @@
 * <code>common/new_interface.c</code>
 ** Where the timer information gets printed out to the log
-* <code>{in,}commpressible/itrdrv.f</code>
+* <code>incommpressible/itrdrv.f</code>
 ** Where the variables tracking the timers get reset
 * Whatever code you want to time will need to be modified
@@ Line 29: / Line 30: @@
 === <code>common/new_interface.c</code> ===
-Add a print statement to the <code>print_mpi_stats</code> function. You can simply copy/paste an example
+Add a print statement to the <code>print_mpi_stats</code> function. You can simply copy/paste a similar set of lines from the file, but it should generally look like this: