preCICE v3.3.0
Loading...
Searching...
No Matches
precice::profiling Namespace Reference

contains profiling utilities. More...

Classes

struct  DataEntry
class  Event
class  EventRegistry
struct  NameEntry
class  ProfilingConfiguration
 Configuration class for exports. More...
struct  StartEntry
struct  StopEntry
struct  SynchronizeTag
 Tag to annotate synchronized events. More...
struct  TimedEntry
 An event that has been recorded and it waiting to be written to file. More...

Typedefs

using sys_clk = std::chrono::system_clock
using stdy_clk = std::chrono::steady_clock
using PendingEntry = std::variant<StartEntry, StopEntry, DataEntry, NameEntry>

Enumerations

enum struct  Group { Default , Fundamental , API }
 Tag to annotate event group. More...
enum struct  Mode { All , API , Fundamental , Off }
 The Mode of the Event utility. More...
enum struct  EventClass : bool { Normal = false , Fundamental = true }

Functions

void applyDefaults ()
std::string timepoint_to_string (sys_clk::time_point c)
 Converts the time_point into a string like "2019-01-10T18:30:46.834".

Variables

constexpr int DEFAULT_SYNC_EVERY = 50
constexpr const char * DEFAULT_MODE = "fundamental"
constexpr const char * DEFAULT_DIRECTORY = "."
constexpr const char * MODE_OFF = "off"
constexpr const char * MODE_FUNDAMENTAL = "fundamental"
constexpr const char * MODE_API = "api"
constexpr const char * MODE_ALL = "all"
static constexpr Group Fundamental = Group::Fundamental
 Convenience instance of the Cat::Fundamental.
static constexpr Group API = Group::API
 Convenience instance of the Cat::API.
static constexpr SynchronizeTag Synchronize {}
 Convenience instance of the SynchronizeTag.
template<typename T>
static constexpr bool isOptionsTag = std::is_same_v<T, Group> || std::is_same_v<T, SynchronizeTag>
constexpr int file_version {2}
 The version of the Events file. Increase on changes.

Detailed Description

contains profiling utilities.

Typedef Documentation

◆ PendingEntry

◆ stdy_clk

◆ sys_clk

Enumeration Type Documentation

◆ EventClass

enum struct precice::profiling::EventClass : bool
strong
Enumerator
Normal 
Fundamental 

Definition at line 32 of file EventUtils.hpp.

◆ Group

enum struct precice::profiling::Group
strong

Tag to annotate event group.

Enumerator
Default 
Fundamental 
API 

Definition at line 15 of file Event.hpp.

◆ Mode

enum struct precice::profiling::Mode
strong

The Mode of the Event utility.

Enumerator
All 
API 
Fundamental 
Off 

Definition at line 25 of file EventUtils.hpp.

Function Documentation

◆ applyDefaults()

void precice::profiling::applyDefaults ( )

Definition at line 91 of file ProfilingConfiguration.cpp.

Here is the call graph for this function:

◆ timepoint_to_string()

std::string precice::profiling::timepoint_to_string ( sys_clk::time_point c)

Converts the time_point into a string like "2019-01-10T18:30:46.834".

Definition at line 39 of file EventUtils.cpp.

Here is the call graph for this function:

Variable Documentation

◆ API

Group precice::profiling::API = Group::API
staticconstexpr

Convenience instance of the Cat::API.

Definition at line 25 of file Event.hpp.

◆ DEFAULT_DIRECTORY

const char* precice::profiling::DEFAULT_DIRECTORY = "."
constexpr

Definition at line 16 of file ProfilingConfiguration.hpp.

◆ DEFAULT_MODE

const char* precice::profiling::DEFAULT_MODE = "fundamental"
constexpr

Definition at line 15 of file ProfilingConfiguration.hpp.

◆ DEFAULT_SYNC_EVERY

int precice::profiling::DEFAULT_SYNC_EVERY = 50
constexpr

Definition at line 14 of file ProfilingConfiguration.hpp.

◆ file_version

int precice::profiling::file_version {2}
constexpr

The version of the Events file. Increase on changes.

Definition at line 33 of file EventUtils.cpp.

◆ Fundamental

Group precice::profiling::Fundamental = Group::Fundamental
staticconstexpr

Convenience instance of the Cat::Fundamental.

Definition at line 22 of file Event.hpp.

◆ isOptionsTag

template<typename T>
bool precice::profiling::isOptionsTag = std::is_same_v<T, Group> || std::is_same_v<T, SynchronizeTag>
staticconstexpr

Definition at line 32 of file Event.hpp.

◆ MODE_ALL

const char* precice::profiling::MODE_ALL = "all"
constexpr

Definition at line 20 of file ProfilingConfiguration.hpp.

◆ MODE_API

const char* precice::profiling::MODE_API = "api"
constexpr

Definition at line 19 of file ProfilingConfiguration.hpp.

◆ MODE_FUNDAMENTAL

const char* precice::profiling::MODE_FUNDAMENTAL = "fundamental"
constexpr

Definition at line 18 of file ProfilingConfiguration.hpp.

◆ MODE_OFF

const char* precice::profiling::MODE_OFF = "off"
constexpr

Definition at line 17 of file ProfilingConfiguration.hpp.

◆ Synchronize

SynchronizeTag precice::profiling::Synchronize {}
staticconstexpr

Convenience instance of the SynchronizeTag.

Definition at line 28 of file Event.hpp.