FileOutputHandler Class Reference

Wrapper class to abstract the writing of output files. More...

#include <FileOutputHandler.h>

Collaboration diagram for FileOutputHandler:

Public Member Functions
	FileOutputHandler (const OutputFormat output_format, const SimulationParams &params)
	Construct a new FileOutputHandler object. More...
std::optional< const std::filesystem::path >	writeFile (size_t iteration, const std::unique_ptr< ParticleContainer > &particle_container) const
	Writes the given ParticleContainers particle data to a file. More...
std::optional< const std::filesystem::path >	writeFile (size_t iteration, const std::vector< Particle > &particles) const
	Writes the given ParticleContainers particle data to a file. More...

Private Attributes
const SimulationParams &	params
	SimulationParams object which provides the output directory path. More...
std::unique_ptr< FileWriter >	file_writer
	Pointer to the FileWriter object to use. More...

Detailed Description

Wrapper class to abstract the writing of output files.

Currently there are two supported output formats: VTU and XYZ. Additionally a 'NONE' format is available, which does not write any output.

Definition at line 16 of file FileOutputHandler.h.

Constructor & Destructor Documentation

FileOutputHandler()

FileOutputHandler::FileOutputHandler ( const OutputFormat  output_format, const SimulationParams &  params  )

explicit

Construct a new FileOutputHandler object.

Parameters

output_format	The output format to use
params	SimulationParams object which provides the output directory path

Definition at line 10 of file FileOutputHandler.cpp.

                                                                                                     : params(params) {
    switch (output_format) {
        case OutputFormat::VTU:
            file_writer = std::make_unique<VTUWriter>();
            break;
        case OutputFormat::XYZ:
            file_writer = std::make_unique<XYZWriter>();
            break;
        case OutputFormat::CHKPT:
            file_writer = std::make_unique<CheckPointWriter>();
            break;
        default:
            Logger::logger->error("Output format not implemented.");
            exit(1);
    }
 
    if (std::filesystem::exists(params.output_dir_path)) {
        auto supported = get_supported_output_formats();
 
        auto file_extension = std::find_if(supported.begin(), supported.end(), [&params, &output_format](const auto& pair) {
                                  return pair.second == output_format;
                              })->first;
 
        auto count = 0;
        for (const auto& entry : std::filesystem::directory_iterator(params.output_dir_path)) {
            if (entry.path().extension() == "." + file_extension) {
                std::string filename = entry.path().filename().string();
                std::string iteration_str =
                    filename.substr(filename.find_last_of("_") + 1, filename.find_last_of(".") - filename.find_last_of("_") - 1);
 
                size_t iteration = std::stoul(iteration_str);
 
                if (params.start_iteration == 0 || iteration > params.start_iteration) {
                    std::filesystem::remove(entry.path());
                    count++;
                }
            }
        }
        if (count > 0) {
            Logger::logger->warn("Removed {} {} files from output directory '{}'.", count, file_extension, params.output_dir_path.string());
        }
    } else {
        Logger::logger->info("Creating output directory '{}'.", params.output_dir_path.string());
        std::filesystem::create_directories(params.output_dir_path.string());
    }
}

Member Function Documentation

writeFile() [1/2]

std::optional< const std::filesystem::path > FileOutputHandler::writeFile	(	size_t	iteration,
		const std::unique_ptr< ParticleContainer > &	particle_container
	)		const

Writes the given ParticleContainers particle data to a file.

Parameters

iteration	The current iteration number of the simulation
particle_container	The ParticleContainer to write to the file

Returns

The path to the written file

Definition at line 65 of file FileOutputHandler.cpp.

                                                                                        {
    return writeFile(iteration, particle_container->getParticles());
}

writeFile() [2/2]

std::optional< const std::filesystem::path > FileOutputHandler::writeFile	(	size_t	iteration,
		const std::vector< Particle > &	particles
	)		const

Writes the given ParticleContainers particle data to a file.

Parameters

iteration	The current iteration number of the simulation
particles	A vector of particles to write to the file

Returns

The path to the written file

Definition at line 57 of file FileOutputHandler.cpp.

                                                                                                                              {
    if (!file_writer) {
        Logger::logger->warn("No file writer set. Not writing file.");
        throw std::runtime_error("No file writer set. Not writing file.");
    }
    return file_writer->writeFile(params, iteration, particles);
}

Member Data Documentation

file_writer

std::unique_ptr<FileWriter> FileOutputHandler::file_writer

private

Pointer to the FileWriter object to use.

Definition at line 26 of file FileOutputHandler.h.

params

const SimulationParams& FileOutputHandler::params

private

SimulationParams object which provides the output directory path.

Definition at line 21 of file FileOutputHandler.h.

---

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

• FileOutputHandler.h
• FileOutputHandler.cpp