Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
Teuchos::StackedTimer::OutputOptions Struct Reference

#include <Teuchos_StackedTimer.hpp>

Public Member Functions

 OutputOptions ()

Public Attributes

bool output_fraction
bool output_total_updates
bool output_histogram
bool output_minmax
bool output_proc_minmax
int num_histogram
int max_levels
bool print_warnings
bool align_columns
bool print_names_before_values
double drop_time

Detailed Description

Struct for controlling output options like histograms

output_fractionPrint the timer fractions within a level.
output_total_updatesPrint the updates counter.
output_historgramPrint the histogram.
output_minmaxPrint the min max and standard deviation across MPI processes.
num_histogramThe number of equally size bickets to use in the histogram.
max_levelThe number of levels in the stacked timer to print (default prints all levels).
print_warningsPrint any relevant warnings on stacked timer use.
align_columnsOutput will align the columsn of stacked timer data.
print_names_before_valuesIf set to true, writes the timer names before values.
drop_timeIf a timer has a total time less that this value, the timer will not be printed and the total time of that timer will be added to the Remainder. Useful for ignoring negligible timers. Default is -1.0 to force printing of all timers even if they have zero accumulated time.

Definition at line 673 of file Teuchos_StackedTimer.hpp.

Constructor & Destructor Documentation

Teuchos::StackedTimer::OutputOptions::OutputOptions ( )

Definition at line 674 of file Teuchos_StackedTimer.hpp.

Member Data Documentation

bool Teuchos::StackedTimer::OutputOptions::output_fraction

Definition at line 678 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::output_total_updates

Definition at line 679 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::output_histogram

Definition at line 680 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::output_minmax

Definition at line 681 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::output_proc_minmax

Definition at line 682 of file Teuchos_StackedTimer.hpp.

int Teuchos::StackedTimer::OutputOptions::num_histogram

Definition at line 683 of file Teuchos_StackedTimer.hpp.

int Teuchos::StackedTimer::OutputOptions::max_levels

Definition at line 684 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::print_warnings

Definition at line 685 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::align_columns

Definition at line 686 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::OutputOptions::print_names_before_values

Definition at line 687 of file Teuchos_StackedTimer.hpp.

double Teuchos::StackedTimer::OutputOptions::drop_time

Definition at line 688 of file Teuchos_StackedTimer.hpp.

The documentation for this struct was generated from the following file: