netcdf_file.hpp

Go to the documentation of this file.

#pragma once
 
#include <span>
#include <string>
#include <vector>
 
#include <netcdf.h>
 
namespace kynema_fmb::util {
 
/*
 * @brief Class for managing NetCDF files for writing outputs
 *
 * This class provides a wrapper around the NetCDF library's functions for creating,
 * writing, and reading NetCDF files. It is primarily used to write Kynema output data
 * to a NetCDF file.
 */
class NetCdfFile {
public:
    explicit NetCdfFile(const std::string& file_path, bool create = true);
 
    ~NetCdfFile();
 
    NetCdfFile(const NetCdfFile&) = delete;
    NetCdfFile& operator=(const NetCdfFile&) = delete;
    NetCdfFile(NetCdfFile&&) = delete;
    NetCdfFile& operator=(NetCdfFile&&) = delete;
 
    void Sync() const;
 
    void Close();
 
    void Open();
 
    [[nodiscard]] bool IsOpen() const { return netcdf_id_ != -1; }
 
    //--------------------------------------------------------------------------
    // Setter/Write methods
    //--------------------------------------------------------------------------
 
    [[nodiscard]] int AddDimension(const std::string& name, size_t length) const;
 
    template <typename T>
    [[nodiscard]] int AddVariable(const std::string& name, std::span<const int> dim_ids) const;
 
    void AddAttribute(const std::string& var_name, const std::string& attr_name, float value) const;
    void AddAttribute(const std::string& var_name, const std::string& attr_name, double value) const;
    void AddAttribute(const std::string& var_name, const std::string& attr_name, int value) const;
    void AddAttribute(
        const std::string& var_name, const std::string& attr_name, const std::string& value
    ) const;
 
    void WriteVariable(const std::string& name, std::span<const float> data) const;
    void WriteVariable(const std::string& name, std::span<const double> data) const;
    void WriteVariable(const std::string& name, std::span<const int> data) const;
    void WriteVariable(const std::string& name, std::span<const std::string> data) const;
 
    void WriteVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const float> data
    ) const;
    void WriteVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const double> data
    ) const;
    void WriteVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const int> data
    ) const;
    void WriteVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const std::string> data
    ) const;
 
    void SetChunking(const std::string& var_name, std::span<const size_t> chunk_sizes) const;
 
    //--------------------------------------------------------------------------
    // Getter/Read methods
    //--------------------------------------------------------------------------
 
    [[nodiscard]] int GetNetCDFId() const;
 
    [[nodiscard]] int GetDimensionId(const std::string& name) const;
 
    [[nodiscard]] int GetVariableId(const std::string& name) const;
 
    [[nodiscard]] size_t GetNumberOfDimensions(const std::string& var_name) const;
 
    [[nodiscard]] size_t GetDimensionLength(int dim_id) const;
 
    [[nodiscard]] size_t GetDimensionLength(const std::string& name) const;
 
    [[nodiscard]] std::vector<size_t> GetShape(const std::string& var_name) const;
 
    void ReadVariable(const std::string& name, float* data) const;
    void ReadVariable(const std::string& name, double* data) const;
    void ReadVariable(const std::string& name, int* data) const;
 
    void ReadVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        float* data
    ) const;
    void ReadVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        double* data
    ) const;
    void ReadVariableAt(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        int* data
    ) const;
 
    void ReadVariableWithStride(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const ptrdiff_t> stride, float* data
    ) const;
    void ReadVariableWithStride(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const ptrdiff_t> stride, double* data
    ) const;
    void ReadVariableWithStride(
        const std::string& name, std::span<const size_t> start, std::span<const size_t> count,
        std::span<const ptrdiff_t> stride, int* data
    ) const;
 
private:
    int netcdf_id_{-1};
    std::string file_path_;
};
 
}  // namespace kynema_fmb::util