precice::profiling Namespace Reference

contains profiling utilities. More...

Classes
struct	DataEntry
class	Event
class	EventRegistry
struct	FundamentalTag
	Tag to annotate fundamental events. More...
struct	NameEntry
class	ProfilingConfiguration
	Configuration class for exports. More...
class	ScopedEventPrefix
	Class that changes the prefix in its scope. 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	Mode { All , 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".
EventClass	toEventClass (bool isFundamental)

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_ALL = "all"
static constexpr FundamentalTag	Fundamental {}
	Convenience instance of the FundamentalTag.
static constexpr SynchronizeTag	Synchronize {}
	Convenience instance of the SynchronizeTag.
template<typename T >
static constexpr bool	isOptionsTag = std::is_same_v<T, FundamentalTag> || std::is_same_v<T, SynchronizeTag>

Detailed Description

contains profiling utilities.

Typedef Documentation

PendingEntry

using precice::profiling::PendingEntry = std::variant<StartEntry, StopEntry, DataEntry, NameEntry>

Definition at line 71 of file EventUtils.hpp.

stdy_clk

using precice::profiling::stdy_clk = std::chrono::steady_clock

Definition at line 28 of file EventUtils.cpp.

sys_clk

using precice::profiling::sys_clk = std::chrono::system_clock

Definition at line 27 of file EventUtils.cpp.

Enumeration Type Documentation

EventClass

enum struct precice::profiling::EventClass : bool

strong

Enumerator
Normal
Fundamental

Definition at line 27 of file EventUtils.hpp.

Mode

enum struct precice::profiling::Mode

strong

The Mode of the Event utility.

Enumerator
All
Fundamental
Off

Definition at line 21 of file EventUtils.hpp.

Function Documentation

applyDefaults()

void precice::profiling::applyDefaults

(

)

Definition at line 88 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 31 of file EventUtils.cpp.

Here is the call graph for this function:

toEventClass()

EventClass precice::profiling::toEventClass ( bool isFundamental )

inline

Definition at line 32 of file EventUtils.hpp.

Variable Documentation

DEFAULT_DIRECTORY

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

constexpr

Definition at line 16 of file ProfilingConfiguration.hpp.

DEFAULT_MODE

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

constexpr

Definition at line 15 of file ProfilingConfiguration.hpp.

DEFAULT_SYNC_EVERY

constexpr int precice::profiling::DEFAULT_SYNC_EVERY = 50

constexpr

Definition at line 14 of file ProfilingConfiguration.hpp.

Fundamental

constexpr FundamentalTag precice::profiling::Fundamental {}

staticconstexpr

Convenience instance of the FundamentalTag.

Definition at line 19 of file Event.hpp.

isOptionsTag

template<typename T >

constexpr bool precice::profiling::isOptionsTag = std::is_same_v<T, FundamentalTag> || std::is_same_v<T, SynchronizeTag>

staticconstexpr

Definition at line 25 of file Event.hpp.

MODE_ALL

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

constexpr

Definition at line 19 of file ProfilingConfiguration.hpp.

MODE_FUNDAMENTAL

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

constexpr

Definition at line 18 of file ProfilingConfiguration.hpp.

MODE_OFF

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

constexpr

Definition at line 17 of file ProfilingConfiguration.hpp.

Synchronize

constexpr SynchronizeTag precice::profiling::Synchronize {}

staticconstexpr

Convenience instance of the SynchronizeTag.

Definition at line 21 of file Event.hpp.