SimulationOverview Class Reference

Class to store some overview data of an executed simulation. More...

#include <SimulationOverview.h>

Collaboration diagram for SimulationOverview:

Public Member Functions
void	logSummary (int depth=0) const
	Prints a summary of the simulation overview to the logger. More...
void	savePerformanceDataCSV () const
	Saves the simulation overview to a csv file. More...
void	savePerformanceDataCSV (const std::string &filename_prefix) const
	Saves the simulation overview to a csv file. More...

Public Attributes
const SimulationParams &	params
	Original simulation parameters bevore the simulation. More...
double	total_time_seconds
	Total time the simulation took to execute in seconds (includes time for writing output files and logging) More...
size_t	total_iterations
	Total number of iterations the simulation ran for (includes an initial force calculation) More...
std::vector< std::string >	interceptor_summaries
	Summary of the interceptors that were used during the simulation. More...
std::vector< Particle >	resulting_particles
	Resulting particles after the simulation. More...

Detailed Description

Class to store some overview data of an executed simulation.

Definition at line 13 of file SimulationOverview.h.

Member Function Documentation

logSummary()

void SimulationOverview::logSummary

(

int

depth = 0

)

const

Prints a summary of the simulation overview to the logger.

Parameters

depth

determines the indentation of the log message

Definition at line 15 of file SimulationOverview.cpp.

                                                   {
    std::string indent = std::string(depth * 2, ' ');
 
    Logger::logger->info("{}╔════════════════════════════════════════", indent);
    Logger::logger->info("{}╟┤{}Simulation overview: {}", indent, ansi_yellow_bold, ansi_end);
    Logger::logger->info("{}║  Input file: {}", indent, params.input_file_path.string());
    Logger::logger->info("{}║  Output directory: {}", indent, params.output_dir_path.string());
    Logger::logger->info("{}║  Simulation time: {}", indent, format_seconds_total(total_time_seconds));
    Logger::logger->info("{}║  Number of iterations: {}", indent, total_iterations);
    Logger::logger->info("{}║  Number of particles left: {}", indent, resulting_particles.size());
    Logger::logger->info("{}╟┤{}Interceptor Logs: {}", indent, ansi_yellow_bold, ansi_end);
 
    if (interceptor_summaries.empty()) {
        Logger::logger->info("{}║   └No interceptors", indent);
    } else {
        for (auto& interceptor_summary : interceptor_summaries) {
            Logger::logger->info("{}║   ├{}", indent, interceptor_summary);
        }
    }
 
    Logger::logger->info("{}╚════════════════════════════════════════", indent);
}

savePerformanceDataCSV() [1/2]

void SimulationOverview::savePerformanceDataCSV

(

)

const

Saves the simulation overview to a csv file.

Definition at line 38 of file SimulationOverview.cpp.

{ savePerformanceDataCSV(""); }

savePerformanceDataCSV() [2/2]

void SimulationOverview::savePerformanceDataCSV

(

const std::string &

filename_prefix

)

const

Saves the simulation overview to a csv file.

Parameters

filename_prefix

Prefix for the outputted filename (<prefix>performance_data<timestamp>.csv)

Definition at line 40 of file SimulationOverview.cpp.

                                                                                      {
    // write the results to the file
    std::time_t now = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
    auto formatted_time = fmt::format("{:%d.%m.%Y-%H:%M:%S}", fmt::localtime(now));
 
    CSVWriter csv_writer(
        params.output_dir_path / "statistics" /
            (filename_prefix + (filename_prefix.empty() ? "" : "_") + "performance_data_" + formatted_time + ".csv"),
        {"num_particles", "particle_container", "delta_t", "total_time[s]", "particle_updates_per_second[1/s]", "total_iterations"}, false);
 
    // find ParticleUpdateCounterInterceptor
    auto particle_update_counter = std::find_if(params.interceptors.begin(), params.interceptors.end(), [](auto& interceptor) {
        return std::dynamic_pointer_cast<ParticleUpdateCounterInterceptor>(interceptor) != nullptr;
    });
 
    auto particle_updates_per_second =
        particle_update_counter != params.interceptors.end()
            ? std::to_string(
                  std::dynamic_pointer_cast<ParticleUpdateCounterInterceptor>(*particle_update_counter)->getParticleUpdatesPerSecond())
            : "N/A";
 
    std::string container_type_string = std::visit([](auto&& arg) { return std::string(arg); }, params.container_type);
 
    csv_writer.writeRow(
        {params.num_particles, container_type_string, params.delta_t, total_time_seconds, particle_updates_per_second, total_iterations});
}

Member Data Documentation

interceptor_summaries

std::vector<std::string> SimulationOverview::interceptor_summaries

Summary of the interceptors that were used during the simulation.

Definition at line 33 of file SimulationOverview.h.

params

const SimulationParams& SimulationOverview::params

Original simulation parameters bevore the simulation.

Definition at line 18 of file SimulationOverview.h.

resulting_particles

std::vector<Particle> SimulationOverview::resulting_particles

Resulting particles after the simulation.

Definition at line 38 of file SimulationOverview.h.

total_iterations

size_t SimulationOverview::total_iterations

Total number of iterations the simulation ran for (includes an initial force calculation)

Definition at line 28 of file SimulationOverview.h.

total_time_seconds

double SimulationOverview::total_time_seconds

Total time the simulation took to execute in seconds (includes time for writing output files and logging)

Definition at line 23 of file SimulationOverview.h.

---

The documentation for this class was generated from the following files:

• SimulationOverview.h
• SimulationOverview.cpp