petsc-3.12.4 2020-02-04
Report Typos and Errors

# PetscPreLoadBegin

Begin a segment of code that may be preloaded (run twice) to get accurate timings

### Synopsis

    #include <petsclog.h>
    void PetscPreLoadBegin(PetscBool  flag,char *name);

Not Collective

### Input Parameter

| flag | - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden with command line option -preload true or -preload false
| name | - name of first stage (lines of code timed separately with -log_view) to be preloaded

### Usage

         PetscPreLoadBegin(PETSC_TRUE,"first stage);
           lines of code
           PetscPreLoadStage("second stage");
           lines of code
         PetscPreLoadEnd();

### Notes

Only works in C/C++, not Fortran

Flags available within the macro.

| PetscPreLoadingUsed | - true if we are or have done preloading
| PetscPreLoadingOn | - true if it is CURRENTLY doing preload
| PetscPreLoadIt | - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
| PetscPreLoadMax | - number of times it will do the computation, only one when preloading is turned on The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() and PetscPreLoadEnd()

### See Also

PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()

### Level

intermediate

### Location

src/sys/logging/plog.c

### Examples

src/ksp/ksp/examples/tutorials/ex10.c.html
src/ksp/ksp/examples/tutorials/ex27.c.html
src/ksp/ksp/examples/tutorials/ex72.c.html
Index of all Profiling routines
Table of Contents for all manual pages
Index of all manual pages