VelocityProfileInterceptor Class Reference

#include <VelocityProfileInterceptor.h>

Inheritance diagram for VelocityProfileInterceptor:

Collaboration diagram for VelocityProfileInterceptor:

Public Member Functions
	VelocityProfileInterceptor (std::pair< std::array< double, 3 >, std::array< double, 3 >> box, size_t num_bins, size_t sample_every_x_percent)
	Construct a new Thermostat Interceptor object. More...
void	onSimulationStart (Simulation &simulation) override
	This function is sets the particle_updates to 0 and initializes the start time of the simulation. More...
void	operator() (size_t iteration, Simulation &simulation) override
	This function is called on every nth iteration. It counts the number of particle updates which have been performed. 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 radial distribution function. 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::pair< std::array< double, 3 >, std::array< double, 3 > >	box
size_t	num_bins
std::array< double, 3 >	bin_width
size_t	sample_every_x_percent
std::unique_ptr< CSVWriter >	csv_writer_x
std::unique_ptr< CSVWriter >	csv_writer_y
std::unique_ptr< CSVWriter >	csv_writer_z

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

Detailed Description

Definition at line 8 of file VelocityProfileInterceptor.h.

Constructor & Destructor Documentation

VelocityProfileInterceptor()

VelocityProfileInterceptor::VelocityProfileInterceptor	(	std::pair< std::array< double, 3 >, std::array< double, 3 >>	box,
		size_t	num_bins,
		size_t	sample_every_x_percent
	)

Construct a new Thermostat Interceptor object.

Definition at line 8 of file VelocityProfileInterceptor.cpp.

    : box(box), num_bins(num_bins), sample_every_x_percent(sample_every_x_percent) {}

Member Function Documentation

logSummary()

void VelocityProfileInterceptor::logSummary ( int  depth ) const

overridevirtual

Logs the summary of the radial distribution function.

Implements SimulationInterceptor.

Definition at line 95 of file VelocityProfileInterceptor.cpp.

                                                           {
    std::string indent = std::string(depth * 2, ' ');
 
    Logger::logger->info("{}╟┤{}VelocityProfile: {}", indent, ansi_orange_bold, ansi_end);
    Logger::logger->info("{}║   ┌Observed box: ({}, {}, {}) - ({}, {}, {})", indent, box.first[0], box.first[1], box.first[2],
                         box.second[0], box.second[1], box.second[2]);
    Logger::logger->info("{}║   ├Number of bins per axis: {}", indent, num_bins);
    Logger::logger->info("{}║   └Sample every x percent: {}", indent, sample_every_x_percent);
}

onSimulationEnd()

void VelocityProfileInterceptor::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 93 of file VelocityProfileInterceptor.cpp.

{}

onSimulationStart()

void VelocityProfileInterceptor::onSimulationStart ( Simulation &  simulation )

overridevirtual

This function is sets the particle_updates to 0 and initializes the start time of the simulation.

Parameters

simulation

The simulation object

Implements SimulationInterceptor.

Definition at line 12 of file VelocityProfileInterceptor.cpp.

                                                                         {
    bool append = simulation.params.start_iteration != 0;
 
    csv_writer_x = std::make_unique<CSVWriter>(simulation.params.output_dir_path / "statistics" / "velocity_profile_x_axis.csv", append);
    csv_writer_y = std::make_unique<CSVWriter>(simulation.params.output_dir_path / "statistics" / "velocity_profile_y_axis.csv", append);
    csv_writer_z = std::make_unique<CSVWriter>(simulation.params.output_dir_path / "statistics" / "velocity_profile_z_axis.csv", append);
 
    bin_width[0] = (box.second[0] - box.first[0]) / num_bins;
    bin_width[1] = (box.second[1] - box.first[1]) / num_bins;
    bin_width[2] = (box.second[2] - box.first[2]) / num_bins;
 
    csv_writer_x->initialize(
        {"iteration", "bin_index (w= " + std::to_string(bin_width[0]) + ")", "avg_velocity_x", "avg_velocity_y", "avg_velocity_z"});
 
    csv_writer_y->initialize(
        {"iteration", "bin_index (w= " + std::to_string(bin_width[1]) + ")", "avg_velocity_x", "avg_velocity_y", "avg_velocity_z"});
 
    csv_writer_z->initialize(
        {"iteration", "bin_index (w= " + std::to_string(bin_width[2]) + ")", "avg_velocity_x", "avg_velocity_y", "avg_velocity_z"});
 
    auto expected_iterations = static_cast<size_t>(std::ceil(simulation.params.end_time / simulation.params.delta_t));
    SimulationInterceptor::every_nth_iteration = std::max(1, static_cast<int>(sample_every_x_percent * expected_iterations / 100));
 
    if (simulation.params.start_iteration == 0) {
        (*this)(0, simulation);
    }
}

operator std::string()

VelocityProfileInterceptor::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 105 of file VelocityProfileInterceptor.cpp.

                                                     {
    return fmt::format("VelocityProfile: num_bins={}, sample_every_x_percent={}", num_bins, sample_every_x_percent);
}

operator()()

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

overridevirtual

This function is called on every nth iteration. It counts the number of particle updates which have been performed.

Parameters

iteration	The current iteration
simulation	The simulation object

Implements SimulationInterceptor.

Definition at line 40 of file VelocityProfileInterceptor.cpp.

                                                                                    {
    std::map<size_t, std::array<double, 3>> avg_velocity_per_bin_index_x;
    std::map<size_t, std::array<double, 3>> avg_velocity_per_bin_index_y;
    std::map<size_t, std::array<double, 3>> avg_velocity_per_bin_index_z;
 
    std::map<size_t, size_t> samples_per_bin_index_x;
    std::map<size_t, size_t> samples_per_bin_index_y;
    std::map<size_t, size_t> samples_per_bin_index_z;
 
    for (auto& particle : *simulation.particle_container) {
        auto& velocity = particle.getV();
        auto& position = particle.getX();
 
        // check if particle is in box
        if (position[0] < box.first[0] || position[0] > box.second[0] || position[1] < box.first[1] || position[1] > box.second[1] ||
            position[2] < box.first[2] || position[2] > box.second[2]) {
            continue;
        }
 
        size_t bin_index_x = std::floor((position[0] - box.first[0]) / bin_width[0]);
        size_t bin_index_y = std::floor((position[1] - box.first[1]) / bin_width[1]);
        size_t bin_index_z = std::floor((position[2] - box.first[2]) / bin_width[2]);
 
        avg_velocity_per_bin_index_x[bin_index_x] =
            (1.0 / (samples_per_bin_index_x[bin_index_x] + 1)) *
            (samples_per_bin_index_x[bin_index_x] * avg_velocity_per_bin_index_x[bin_index_x] + velocity);
 
        avg_velocity_per_bin_index_y[bin_index_y] =
            (1.0 / (samples_per_bin_index_y[bin_index_y] + 1)) *
            (samples_per_bin_index_y[bin_index_y] * avg_velocity_per_bin_index_y[bin_index_y] + velocity);
 
        avg_velocity_per_bin_index_z[bin_index_z] =
            (1.0 / (samples_per_bin_index_z[bin_index_z] + 1)) *
            (samples_per_bin_index_z[bin_index_z] * avg_velocity_per_bin_index_z[bin_index_z] + velocity);
 
        samples_per_bin_index_x[bin_index_x]++;
        samples_per_bin_index_y[bin_index_y]++;
        samples_per_bin_index_z[bin_index_z]++;
    }
 
    for (auto& [bin_index, avg_velocity] : avg_velocity_per_bin_index_x) {
        csv_writer_x->writeRow({iteration, bin_index, avg_velocity[0], avg_velocity[1], avg_velocity[2]});
    }
 
    for (auto& [bin_index, avg_velocity] : avg_velocity_per_bin_index_y) {
        csv_writer_y->writeRow({iteration, bin_index, avg_velocity[0], avg_velocity[1], avg_velocity[2]});
    }
 
    for (auto& [bin_index, avg_velocity] : avg_velocity_per_bin_index_z) {
        csv_writer_z->writeRow({iteration, bin_index, avg_velocity[0], avg_velocity[1], avg_velocity[2]});
    }
}

Member Data Documentation

bin_width

std::array<double, 3> VelocityProfileInterceptor::bin_width

private

Definition at line 59 of file VelocityProfileInterceptor.h.

box

std::pair<std::array<double, 3>, std::array<double, 3> > VelocityProfileInterceptor::box

private

Definition at line 57 of file VelocityProfileInterceptor.h.

csv_writer_x

std::unique_ptr<CSVWriter> VelocityProfileInterceptor::csv_writer_x

private

Definition at line 61 of file VelocityProfileInterceptor.h.

csv_writer_y

std::unique_ptr<CSVWriter> VelocityProfileInterceptor::csv_writer_y

private

Definition at line 62 of file VelocityProfileInterceptor.h.

csv_writer_z

std::unique_ptr<CSVWriter> VelocityProfileInterceptor::csv_writer_z

private

Definition at line 63 of file VelocityProfileInterceptor.h.

num_bins

size_t VelocityProfileInterceptor::num_bins

private

Definition at line 58 of file VelocityProfileInterceptor.h.

sample_every_x_percent

size_t VelocityProfileInterceptor::sample_every_x_percent

private

Definition at line 60 of file VelocityProfileInterceptor.h.

---

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

• VelocityProfileInterceptor.h
• VelocityProfileInterceptor.cpp