types.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 VTT Technical Research Centre of Finland Ltd
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#pragma once
 
#include <array>
#include <stdexcept>
 
namespace pfc {
 
namespace types {
 
using Int3 = std::array<int, 3>;
using Real3 = std::array<double, 3>;
using Bool3 = std::array<bool, 3>;
 
// Forward declarations
struct Size3;
struct Periodic3;
struct LowerBounds3;
struct UpperBounds3;
struct Spacing3;
 
namespace utils {
const Real3 compute_upper_bounds(const Size3 &size, const LowerBounds3 &lower,
                                 const Spacing3 &spacing, const Periodic3 &periodic);
 
Real3 compute_spacing(const Size3 &size, const LowerBounds3 &lower,
                      const UpperBounds3 &upper, const Periodic3 &periodic);
 
} // namespace utils
 
struct Size3 {
 
  const std::array<int, 3> value;
 
  explicit Size3(const std::array<int, 3> &v) : value(v) {
    for (int dim : v) {
      if (dim <= 0) {
        throw std::invalid_argument("Size values must be positive.");
      }
    }
  };
};
 
struct Periodic3 {
 
  const std::array<bool, 3> value;
 
  explicit Periodic3(const std::array<bool, 3> &v) : value(v) {}
};
 
struct LowerBounds3 {
 
  const std::array<double, 3> value;
 
  explicit LowerBounds3(const std::array<double, 3> &v) : value(v) {}
};
 
struct UpperBounds3 {
 
  const std::array<double, 3> value;
 
  explicit UpperBounds3(const std::array<double, 3> &v) : value(v) {}
 
  UpperBounds3(const Size3 &size, const LowerBounds3 &lower, const Spacing3 &spacing,
               const Periodic3 &periodic)
      : UpperBounds3(utils::compute_upper_bounds(size, lower, spacing, periodic)) {}
};
 
struct Spacing3 {
 
  const std::array<double, 3> value;
 
  explicit Spacing3(const std::array<double, 3> &v) : value(v) {
    for (double dim : v) {
      if (dim <= 0.0) {
        throw std::invalid_argument("Spacing values must be positive.");
      }
    }
  };
 
  Spacing3(const Size3 &size, const LowerBounds3 &lower, const UpperBounds3 &upper,
           const Periodic3 &periodic)
      : Spacing3(utils::compute_spacing(size, lower, upper, periodic)) {}
};
 
} // namespace types
 
using Int3 = types::Int3;
using Real3 = types::Real3;
using Bool3 = types::Bool3;
 
} // namespace pfc