Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::Timer Struct Reference

#include <parameters.h>

Public Types

enum class  Type : std::int8_t { none , iteration , end }

Public Member Functions

void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

Type type = Type::none
bool write_time_in_error_table = false

Detailed Description

Timer - Defines the parameters that control the timing of the simulation. Lethe supports advanced timing features which supports the monitoring of specific subsections of the software to evaluate the relative workload.

Definition at line 1043 of file parameters.h.

Member Enumeration Documentation

◆ Type

enum class Parameters::Timer::Type : std::int8_t
strong
Enumerator
none 
iteration 
end 

Definition at line 1047 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

void Parameters::Timer::declare_parameters ( ParameterHandler & prm)
static

Declare the parameters.

Parameters
[in,out]prmParameterHandler object.

Definition at line 397 of file parameters.cc.

References declare_enum_entry(), type, and write_time_in_error_table.

◆ parse_parameters()

void Parameters::Timer::parse_parameters ( ParameterHandler & prm)

Parse the parameters.

Parameters
[in]prmThe ParameterHandler.

Definition at line 417 of file parameters.cc.

References string_to_enum(), type, and write_time_in_error_table.

Member Data Documentation

◆ type

Type Parameters::Timer::type = Type::none

Definition at line 1054 of file parameters.h.

◆ write_time_in_error_table

bool Parameters::Timer::write_time_in_error_table = false

Definition at line 1056 of file parameters.h.


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