node_state_writer.hpp

Go to the documentation of this file.

#pragma once
 
#include <algorithm>
#include <array>
#include <string>
#include <vector>
 
#include "netcdf_file.hpp"
 
namespace kynema::util {
 
class NodeStateWriter {
public:
    static constexpr size_t kDefaultBufferSize{0};
 
    NodeStateWriter(
        const std::string& file_path, bool create, size_t num_nodes,
        const std::vector<std::string>& enabled_state_prefixes = {"x", "u", "v", "a", "f"},
        size_t buffer_size = kDefaultBufferSize
    );
 
    ~NodeStateWriter();
 
    // Rule of five -> explicitly delete the copy ctor, copy assignment operator,
    // move ctor, and move assignment operator
    NodeStateWriter(const NodeStateWriter&) = delete;
    NodeStateWriter& operator=(const NodeStateWriter&) = delete;
    NodeStateWriter(NodeStateWriter&&) = delete;
    NodeStateWriter& operator=(NodeStateWriter&&) = delete;
 
    void WriteStateDataAtTimestep(
        size_t timestep, const std::string& component_prefix, const std::vector<double>& x,
        const std::vector<double>& y, const std::vector<double>& z, const std::vector<double>& i,
        const std::vector<double>& j, const std::vector<double>& k,
        const std::vector<double>& w = std::vector<double>()
    );
 
    [[nodiscard]] const NetCdfFile& GetFile() const;
 
    [[nodiscard]] size_t GetNumNodes() const;
 
    void Close();
 
    void Open();
 
private:
    NetCdfFile file_;                                  //< NetCDF file object for writing output data
    size_t num_nodes_;                                 //< number of nodes in the simulation
    std::vector<std::string> enabled_state_prefixes_;  //< prefixes for the state components to write
    size_t buffer_size_;  //< number of timesteps to accumulate before auto-flush
 
    void DefineStateVariables(
        const std::string& prefix, const std::vector<int>& dimensions, bool has_w
    );
 
    //-----------------------------------
    // support for buffering
    //-----------------------------------
 
    struct StateTimestepData {
        size_t timestep;
        std::string component_prefix;             //< prefix for the component
        std::vector<double> x, y, z, i, j, k, w;  //< data for the component
    };
 
    std::vector<StateTimestepData>
        state_buffers_[5];  //< buffer for each state component type  -- x, u, v, a, f
 
    [[nodiscard]] static size_t GetComponentIndex(const std::string& prefix);
 
    void FlushStateBuffer(size_t component_index);
 
    void FlushAllBuffers();
};
 
}  // namespace kynema::util