FireWeather.h

/* Copyright (c) Queen's Printer for Ontario, 2020. */
/* Copyright (c) His Majesty the King in Right of Canada as represented by the Minister of Natural Resources, 2021-2025. */
 
/* SPDX-License-Identifier: AGPL-3.0-or-later */
 
#pragma once
#include <map>
#include <set>
#include <vector>
#include "FuelLookup.h"
#include "FWI.h"
#ifdef DEBUG_FWI_WEATHER
#include "Log.h"
#endif
namespace fs
{
namespace fuel
{
class FuelType;
}
namespace wx
{
// use an array instead of a map since number of values is so small and access should be faster
using SurvivalMap = array<vector<float>, NUMBER_OF_FUELS>;
class FireWeather
{
public:
  virtual ~FireWeather();
  FireWeather(FireWeather&& rhs) = default;
  FireWeather(const FireWeather& rhs) = delete;
  FireWeather& operator=(FireWeather&& rhs) noexcept = default;
  FireWeather& operator=(const FireWeather& rhs) = delete;
  [[nodiscard]] const FwiWeather* at(const DurationSize time) const
  {
#ifdef DEBUG_FWI_WEATHER
    logging::check_fatal(time < 0 || time >= MAX_DAYS, "Invalid weather time %f", time);
#endif
    return weather_by_hour_by_day_->at(util::time_index(time, min_date_));
  }
  [[nodiscard]] ThresholdSize survivalProbability(const DurationSize time,
                                                  const FuelCodeSize& in_fuel) const
  {
    return survival_probability_->at(in_fuel).at(util::time_index(time, min_date_));
  }
  [[nodiscard]] constexpr Day minDate() const
  {
    return min_date_;
  }
  [[nodiscard]] constexpr Day maxDate() const
  {
    return max_date_;
  }
  [[nodiscard]] constexpr size_t weightedDsr() const noexcept
  {
    return weighted_dsr_;
  }
  [[nodiscard]] const vector<const FwiWeather*>* getWeather()
  {
    return weather_by_hour_by_day_;
  }
 
  FireWeather(const set<const fuel::FuelType*>& used_fuels,
              Day min_date,
              Day max_date,
              vector<const FwiWeather*>* weather_by_hour_by_day);
private:
  const vector<const FwiWeather*>* weather_by_hour_by_day_;
  const SurvivalMap* survival_probability_;
  Day min_date_;
  Day max_date_;
  size_t weighted_dsr_;
};
[[nodiscard]] constexpr bool operator==(const FireWeather& lhs, const FireWeather& rhs)
{
  if (!(lhs.maxDate() == rhs.maxDate() && lhs.minDate() == rhs.minDate()))
  {
    return false;
  }
  // FIX: why is this a warning?
  for (Day day = lhs.minDate() + static_cast<Day>(1); day <= lhs.maxDate(); ++day)
  {
    for (auto hour = 0; hour < DAY_HOURS; ++hour)
    {
      const auto time = static_cast<DurationSize>(day) + hour / 24.0;
      if (lhs.at(time) != rhs.at(time))
      {
        return false;
      }
    }
  }
  return true;
}
[[nodiscard]] constexpr bool operator!=(const FireWeather& lhs, const FireWeather& rhs)
{
  return !(lhs == rhs);
}
}
}