TemperatureSensorInterceptor Class Reference

#include <TemperatureSensorInterceptor.h>

Inheritance diagram for TemperatureSensorInterceptor:

Collaboration diagram for TemperatureSensorInterceptor:

Public Member Functions
	TemperatureSensorInterceptor (std::shared_ptr< Thermostat > thermostat, double sample_every_x_percent)
	Construct a new TemperatureSensor Interceptor object. More...
void	onSimulationStart (Simulation &simulation) override
	This function is empty as the thermostat doesnt need initialization. More...
void	operator() (size_t iteration, Simulation &simulation) override
	This function is called on every nth iteration. It scales the temperature of the particles in accordance with the thermostat. More...
void	onSimulationEnd (size_t iteration, Simulation &simulation) override
	This function is empty as the thermostat doesnt need to do anything at the end of the simulation. More...
	operator std::string () const override
	The string representation of this interceptor. More...
void	logSummary (int depth) const override
	Logs the summary of the thermostat. More...
Public Member Functions inherited from SimulationInterceptor
virtual	~SimulationInterceptor ()=default
	Destroy the Simulation Interceptor object. More...
void	notify (size_t iteration, Simulation &simulation)
	This function is called by the simulation loop on every iteration. Whenever the iteration is a multiple of every_nth_iteration, the operator() function is called. More...

Private Attributes
std::unique_ptr< CSVWriter >	csv_writer
std::shared_ptr< Thermostat >	thermostat
	The thermostat that is used to scale the temperature. More...
double	sample_every_x_percent

Additional Inherited Members
Protected Attributes inherited from SimulationInterceptor
size_t	every_nth_iteration = 1

Detailed Description

Definition at line 8 of file TemperatureSensorInterceptor.h.

Constructor & Destructor Documentation

TemperatureSensorInterceptor()

TemperatureSensorInterceptor::TemperatureSensorInterceptor ( std::shared_ptr< Thermostat >  thermostat, double  sample_every_x_percent  )

inlineexplicit

Construct a new TemperatureSensor Interceptor object.

Definition at line 13 of file TemperatureSensorInterceptor.h.

        : thermostat(thermostat), sample_every_x_percent(sample_every_x_percent) {}

Member Function Documentation

logSummary()

void TemperatureSensorInterceptor::logSummary ( int  depth ) const

overridevirtual

Logs the summary of the thermostat.

Implements SimulationInterceptor.

Definition at line 34 of file TemperatureSensorInterceptor.cpp.

                                                             {
    std::string indent = std::string(depth * 2, ' ');
 
    Logger::logger->info("{}╟┤{}TemperatureSensor: {}", indent, ansi_orange_bold, ansi_end);
    Logger::logger->info("{}║   ├Sample every x percent: {}", indent, sample_every_x_percent);
}

onSimulationEnd()

void TemperatureSensorInterceptor::onSimulationEnd ( size_t  iteration, Simulation &  simulation  )

overridevirtual

This function is empty as the thermostat doesnt need to do anything at the end of the simulation.

Parameters

iteration	The current iteration
simulation	The simulation object

Implements SimulationInterceptor.

Definition at line 28 of file TemperatureSensorInterceptor.cpp.

                                                                                           {
    const double current_temperature = thermostat->getCurrentContainerTemperature(simulation.particle_container);
 
    csv_writer->writeRow({iteration, current_temperature});
}

onSimulationStart()

void TemperatureSensorInterceptor::onSimulationStart ( Simulation &  simulation )

overridevirtual

This function is empty as the thermostat doesnt need initialization.

Parameters

simulation

The simulation object

Implements SimulationInterceptor.

Definition at line 6 of file TemperatureSensorInterceptor.cpp.

                                                                           {
    bool append = simulation.params.start_iteration != 0;
 
    csv_writer = std::make_unique<CSVWriter>(simulation.params.output_dir_path / "statistics" / "temperature.csv", append);
 
    csv_writer->initialize({"iteration", "temperature"});
 
    auto expected_iterations = static_cast<size_t>(std::ceil(simulation.params.end_time / simulation.params.delta_t) + 1);
    SimulationInterceptor::every_nth_iteration = std::max(1, static_cast<int>(sample_every_x_percent * expected_iterations / 100));
 
    if (simulation.params.start_iteration == 0) {
        auto current_temperature = thermostat->getCurrentContainerTemperature(simulation.particle_container);
        csv_writer->writeRow({simulation.params.start_iteration, current_temperature});
    }
}

operator std::string()

TemperatureSensorInterceptor::operator std::string ( ) const

explicitoverridevirtual

The string representation of this interceptor.

Returns

std::string

This is used to write the final summary of the Interceptors to the console.

Implements SimulationInterceptor.

Definition at line 41 of file TemperatureSensorInterceptor.cpp.

{ return ""; }

operator()()

void TemperatureSensorInterceptor::operator() ( size_t  iteration, Simulation &  simulation  )

overridevirtual

This function is called on every nth iteration. It scales the temperature of the particles in accordance with the thermostat.

Parameters

iteration	The current iteration
simulation	The simulation object

Implements SimulationInterceptor.

Definition at line 22 of file TemperatureSensorInterceptor.cpp.

                                                                                      {
    const double current_temperature = thermostat->getCurrentContainerTemperature(simulation.particle_container);
 
    csv_writer->writeRow({iteration, current_temperature});
}

Member Data Documentation

csv_writer

std::unique_ptr<CSVWriter> TemperatureSensorInterceptor::csv_writer

private

Definition at line 57 of file TemperatureSensorInterceptor.h.

sample_every_x_percent

double TemperatureSensorInterceptor::sample_every_x_percent

private

Definition at line 64 of file TemperatureSensorInterceptor.h.

thermostat

std::shared_ptr<Thermostat> TemperatureSensorInterceptor::thermostat

private

The thermostat that is used to scale the temperature.

Definition at line 62 of file TemperatureSensorInterceptor.h.

---

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

• TemperatureSensorInterceptor.h
• TemperatureSensorInterceptor.cpp