SpECTRE  v2024.06.18
Logging

Functions for logging progress of running code. More...

Namespaces

namespace  logging
 Items related to logging.
 

Classes

class  Informer
 The Informer manages textual output regarding the status of a simulation. More...
 
struct  logging::OptionTags::Verbosity< OptionsGroup >
 
struct  logging::Tags::Verbosity< OptionsGroup >
 Tag for putting Verbosity in a DataBox. More...
 

Enumerations

enum class  Verbosity { Silent , Quiet , Verbose , Debug }
 Indicates how much informative output a class should output.
 

Functions

std::string info_from_build ()
 Information about the version, date, host, git commit, and link time. More...
 
std::string copyright_and_license_info ()
 Returns a string containing the copyright and license info for SpECTRE and its dependencies.
 
std::string link_date ()
 The time and date the executable was linked.
 
std::string executable_name ()
 Name of the linked executable.
 
std::string git_description ()
 The git description at the time the executable was linked.
 
std::string git_branch ()
 The git branch at the time the executable was linked.
 
std::string spectre_version ()
 Retrieve a string containing the current version of SpECTRE.
 
std::string unit_test_src_path ()
 Returns the path to the Unit test directory.
 
std::string unit_test_build_path ()
 Returns the path to the Unit test directory in the build directory.
 

Detailed Description

Functions for logging progress of running code.

Function Documentation

◆ info_from_build()

std::string info_from_build ( )

Information about the version, date, host, git commit, and link time.

The information returned by this function is invaluable for identifying the version of the code used in a simulation, as well as which host, the date the code was compiled, and the time of linkage.