specfem::runtime_configuration::header

class header

Header class to store and print the title and description of the simulation.

Public Functions

inline header(std::string title, std::string description)

Construct a new header object.

Parameters:

• title – Title of simulation

• description – Description of the simulation

header(const YAML::Node &Node)

Construct a new header object using YAML node.

Parameters:

Node – YAML node as read from a YAML file

inline std::string get_title() const

Get the title.

Returns:

std::string title of the simulation

inline std::string get_description() const

Get the description.

Returns:

std::string description of the simulation

Private Members

std::string title

Title of the simulation.

std::string description

Description of the simulation.