docs/api/log_8h_source.html

#ifndef LOG_H

#define LOG_H


#include <cstdint>

#include <string>

#include <string_view>

#include <utility>

#include <vector>


#if defined(__GNUC__) || defined(__clang__)

#define MALLARD_PRINTF(fmt, args) __attribute__((format(printf, fmt, args)))

#else

#define MALLARD_PRINTF(fmt, args)

#endif


namespace logging {


using Items = std::vector<std::pair<std::string, std::string>>;


constexpr int WIDTH = 92;

constexpr int KEY_WIDTH = 18;


enum class Style { BOLD, DIM, RED, YELLOW, GREEN, CYAN };


std::string format(const char * fmt, ...) MALLARD_PRINTF(1, 2);


std::string style(std::string_view text, Style s);


bool color_stdout();

bool color_stderr();


void line(std::string_view text = "");


void section(std::string_view title, std::string_view right = "");


void item(std::string_view key, std::string_view value);

void items(const Items & list);


void begin_phase(std::string_view name);

void end_phase(double seconds);


void event(uint64_t step, double t, std::string_view kind, std::string_view text);


void warning(std::string_view message);


void error(std::string_view message);


std::string count(uint64_t n);

std::string duration(double seconds);

std::string si(double value);

std::string real(double value);


} // namespace logging


#endif // LOG_H

dot
KOKKOS_INLINE_FUNCTION rtype dot(const rtype *a, const rtype *b)
Compute the dot product of two arrays.
Definition common_math.h:32

MALLARD_PRINTF
#define MALLARD_PRINTF(fmt, args)
Definition log.h:21

logging
Definition log.cpp:20

logging::real
std::string real(double v)
Compact real: "%.6g".
Definition log.cpp:200

logging::event
void event(uint64_t step, double t, std::string_view kind, std::string_view text)
One-line event during the run (e.g. a file written), led by the step and time so it lines up with the...
Definition log.cpp:145

logging::count
std::string count(uint64_t n)
1234567 -> "1,234,567".
Definition log.cpp:167

logging::Items
std::vector< std::pair< std::string, std::string > > Items
Key-value lines of a setup section, in display order.
Definition log.h:27

logging::format
std::string format(const char *fmt,...)
printf-style formatting into a std::string.
Definition log.cpp:74

logging::error
void error(std::string_view message)
Error on stderr from the calling rank, prefixed with the rank in parallel runs.
Definition log.cpp:160

logging::color_stdout
bool color_stdout()
Whether to color stdout (stderr): a terminal, NO_COLOR unset and not under an MPI launcher,...
Definition log.cpp:87

logging::line
void line(std::string_view text)
Prints a line on stdout from rank 0.
Definition log.cpp:101

logging::items
void items(const Items &list)
Definition log.cpp:124

logging::begin_phase
void begin_phase(std::string_view name)
Starts a line naming a setup phase; end_phase() completes it with the elapsed time....
Definition log.cpp:128

logging::end_phase
void end_phase(double seconds)
Definition log.cpp:137

logging::WIDTH
constexpr int WIDTH
Width of section rules and the target maximum line width.
Definition log.h:30

logging::Style
Style
Definition log.h:34

logging::Style::BOLD
@ BOLD

logging::Style::CYAN
@ CYAN

logging::Style::YELLOW
@ YELLOW

logging::Style::GREEN
@ GREEN

logging::Style::RED
@ RED

logging::Style::DIM
@ DIM

logging::color_stderr
bool color_stderr()
Definition log.cpp:92

logging::warning
void warning(std::string_view message)
Warning on stderr from rank 0, for conditions every rank sees alike.
Definition log.cpp:153

logging::section
void section(std::string_view title, std::string_view right)
Section heading, e.g. "== Mesh ===...=== 0.12 s".
Definition log.cpp:107

logging::KEY_WIDTH
constexpr int KEY_WIDTH
Column at which the values of key-value lines start.
Definition log.h:32

logging::si
std::string si(double v)
Value with an SI suffix and 3 significant digits: "16.3M", "1.20k".
Definition log.cpp:189

logging::duration
std::string duration(double s)
Wall-clock duration: "850 us", "12.3 ms", "4.56 s", "12m 03s", "2h 05m".
Definition log.cpp:178

logging::style
std::string style(std::string_view text, Style s)
Wraps text in an ANSI style when stdout gets color, else returns it unchanged.
Definition log.cpp:97

logging::item
void item(std::string_view key, std::string_view value)
Aligned "  key   value" line under a section.
Definition log.cpp:117