h5md_specification.cpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2026 The ESPResSo project
 * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009,2010
 *   Max-Planck-Institute for Polymer Research, Theory Group
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ESPResSo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "hdf5_patches.hpp" // must appear first
 
#include "h5md_core.hpp"
#include "h5md_dataset.hpp"
#include "h5md_specification.hpp"
 
#include <highfive/highfive.hpp>
 
#include <hdf5.h>
 
#include <algorithm>
#include <filesystem>
#include <string>
#include <utility>
 
namespace Writer {
namespace H5md {
 
Specification::Specification(unsigned int fields) {
  auto const add_time_series = [this](Dataset &&dataset, bool link = true) {
    auto const group = dataset.group;
    m_datasets.push_back(std::move(dataset));
    m_datasets.push_back(Dataset{group, "step", 1, H5T_NATIVE_INT, 1, link});
    m_datasets.push_back(Dataset{group, "time", 1, H5T_NATIVE_DOUBLE, 1, link});
  };
 
  if (fields & H5MD_OUT_BOX_L) {
    add_time_series(Dataset{"/particles/atoms/box/edges", "value", 2,
                            H5T_NATIVE_DOUBLE, 3, false});
  }
  if (fields & H5MD_OUT_LE_OFF) {
    add_time_series(Dataset{"/particles/atoms/lees_edwards/offset", "value", 2,
                            H5T_NATIVE_DOUBLE, 1, false});
  }
  if (fields & H5MD_OUT_LE_DIR) {
    add_time_series(Dataset{"/particles/atoms/lees_edwards/direction", "value",
                            2, H5T_NATIVE_INT, 1, false});
  }
  if (fields & H5MD_OUT_LE_NORMAL) {
    add_time_series(Dataset{"/particles/atoms/lees_edwards/normal", "value", 2,
                            H5T_NATIVE_INT, 1, false});
  }
  if (fields & H5MD_OUT_MASS) {
    add_time_series(Dataset{"/particles/atoms/mass", "value", 2,
                            H5T_NATIVE_DOUBLE, 1, false});
  }
  if (fields & H5MD_OUT_CHARGE) {
    add_time_series(Dataset{"/particles/atoms/charge", "value", 2,
                            H5T_NATIVE_DOUBLE, 1, false});
  }
  add_time_series(
      Dataset{"/particles/atoms/id", "value", 2, H5T_NATIVE_INT, 1, false},
      false);
  if (fields & H5MD_OUT_TYPE) {
    add_time_series(Dataset{"/particles/atoms/species", "value", 2,
                            H5T_NATIVE_INT, 1, false});
  }
  if (fields & H5MD_OUT_POS) {
    add_time_series(Dataset{"/particles/atoms/position", "value", 3,
                            H5T_NATIVE_DOUBLE, 3, false});
  }
  if (fields & H5MD_OUT_VEL) {
    add_time_series(Dataset{"/particles/atoms/velocity", "value", 3,
                            H5T_NATIVE_DOUBLE, 3, false});
  }
  if (fields & H5MD_OUT_FORCE) {
    add_time_series(Dataset{"/particles/atoms/force", "value", 3,
                            H5T_NATIVE_DOUBLE, 3, false});
  }
  if (fields & H5MD_OUT_IMG) {
    add_time_series(Dataset{"/particles/atoms/image", "value", 3,
                            H5T_NATIVE_INT, 3, false});
  }
  if (fields & H5MD_OUT_BONDS) {
    add_time_series(
        Dataset{"/connectivity/atoms", "value", 3, H5T_NATIVE_INT, 2, false});
  }
}
 
bool Specification::is_compliant(std::filesystem::path const &file) const {
  HighFive::File h5md_file(file.string(), HighFive::File::ReadOnly);
 
  auto const all_groups_exist =
      std::ranges::all_of(m_datasets, [&h5md_file](auto const &d) {
        return h5md_file.exist(d.group);
      });
  auto const all_datasets_exist =
      std::ranges::all_of(m_datasets, [&h5md_file](auto const &d) {
        return h5md_file.exist(d.path());
      });
  return all_groups_exist and all_datasets_exist;
}
 
} // namespace H5md
} // namespace Writer