FireSpread.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 "Cell.h"
#include "FWI.h"
#include "Point.h"
#include "Settings.h"
#include "Util.h"
#include "InnerPos.h"
namespace fs::sim
{
 
static constexpr int MAX_SPREAD_ANGLE = 5.0;
static constexpr MathSize INVALID_ROS = -1.0;
static constexpr MathSize INVALID_INTENSITY = -1.0;
 
class Scenario;
int calculate_nd_ref_for_point(const int elevation, const topo::Point& point) noexcept;
int calculate_nd_for_point(const Day day, const int elevation, const topo::Point& point);
class SpreadInfo
{
public:
  static const SlopeTableArray SlopeTable;
  ~SpreadInfo() = default;
  SpreadInfo(const Scenario& scenario,
             DurationSize time,
             const topo::SpreadKey& key,
             int nd,
             const wx::FwiWeather* weather);
  SpreadInfo(const Scenario& scenario,
             DurationSize time,
             const topo::SpreadKey& key,
             int nd,
             const wx::FwiWeather* weather,
             const wx::FwiWeather* weather_daily);
  CONSTEXPR SpreadInfo(SpreadInfo&& rhs) noexcept = default;
  SpreadInfo(const SpreadInfo& rhs) noexcept = default;
  CONSTEXPR SpreadInfo& operator=(SpreadInfo&& rhs) noexcept = default;
  SpreadInfo& operator=(const SpreadInfo& rhs) noexcept = default;
  // static MathSize calculateSpreadProbability(MathSize ros);
  [[nodiscard]] static constexpr MathSize calculateRosFromThreshold(const ThresholdSize threshold)
  {
    // for some reason it returns -nan instead of nan if it's 1, so return this instead
    if (1.0 == threshold)
    {
      return std::numeric_limits<ThresholdSize>::infinity();
    }
    if (0.0 == threshold)
    {
      return 0.0;
    }
    // NOTE: based off spread event probability from wotton
    // should be the inverse of calculateSpreadProbability()
    return 25.0 / 4.0 * log(-(exp(41.0 / 25.0) * threshold) / (threshold - 1));
  }
  [[nodiscard]] MathSize maxIntensity() const noexcept
  {
    return max_intensity_;
  }
  [[nodiscard]] const OffsetSet& offsets() const
  {
    return offsets_;
  }
  [[nodiscard]] constexpr bool isNotSpreading() const
  {
    return isInvalid();
  }
  [[nodiscard]] constexpr int nd() const
  {
    return nd_;
  }
  [[nodiscard]] constexpr const wx::FwiWeather* weather() const
  {
    return weather_;
  }
  [[nodiscard]] constexpr const wx::Wind& wind() const
  {
    return weather()->wind();
  }
  [[nodiscard]] constexpr const wx::Ffmc& ffmc() const
  {
    return weather()->ffmc();
  }
  [[nodiscard]] constexpr const wx::Bui& bui() const
  {
    return weather()->bui();
  }
  [[nodiscard]] constexpr const wx::Dmc& dmc() const
  {
    return weather()->dmc();
  }
  [[nodiscard]] constexpr const wx::Dc& dc() const
  {
    return weather()->dc();
  }
  [[nodiscard]] constexpr MathSize ffmcEffect() const
  {
    return weather()->ffmcEffect();
  }
  [[nodiscard]] constexpr DurationSize time() const
  {
    return time_;
  }
  [[nodiscard]] constexpr MathSize lengthToBreadth() const
  {
    return l_b_;
  }
  [[nodiscard]] constexpr SlopeSize percentSlope() const
  {
    return topo::Cell::slope(key_);
  }
  [[nodiscard]] constexpr AspectSize slopeAzimuth() const
  {
    return topo::Cell::aspect(key_);
  }
  [[nodiscard]] constexpr MathSize headRos() const
  {
    return head_ros_;
  }
  [[nodiscard]] constexpr fs::wx::Direction headDirection() const
  {
    return raz_;
  }
  [[nodiscard]] constexpr MathSize slopeFactor() const
  {
    // HACK: slope can be infinite, but anything > 60 is the same as 60
    // we already capped the percent slope when making the Cells
    return SlopeTable.at(percentSlope());
  }
  [[nodiscard]] constexpr MathSize foliarMoisture() const
  {
    const auto nd = abs(nd_);
    // don't need to check  `&& nd_ < 50` in second part because of reordering
    return nd >= 50
           ? 120.0
         : nd >= 30
           ? 32.9 + 3.17 * nd - 0.0288 * nd * nd
           : 85.0 + 0.0189 * nd * nd;
  }
  [[nodiscard]] constexpr bool isInvalid() const
  {
    return -1 == head_ros_;
  }
  // required for making a map of SpreadInfo objects
  SpreadInfo() noexcept
    : offsets_({}),
      max_intensity_(INVALID_INTENSITY),
      key_(0),
      weather_(nullptr),
      time_(-1),
      l_b_(-1),
      head_ros_(INVALID_ROS),
      cfb_(-1),
      cfc_(-1),
      tfc_(-1),
      sfc_(-1),
      is_crown_(false),
      raz_(fs::wx::Direction::Invalid),
      nd_(-1) {
      };
  SpreadInfo(
    const int year,
    const int month,
    const int day,
    const int hour,
    const int minute,
    const MathSize latitude,
    const MathSize longitude,
    const ElevationSize elevation,
    const SlopeSize slope,
    const AspectSize aspect,
    const char* fuel_name,
    const wx::FwiWeather* weather);
  SpreadInfo(
    const tm& start_date,
    const MathSize latitude,
    const MathSize longitude,
    const ElevationSize elevation,
    const SlopeSize slope,
    const AspectSize aspect,
    const char* fuel_name,
    const wx::FwiWeather* weather);
  MathSize crownFractionBurned() const
  {
    return cfb_;
  }
  MathSize crownFuelConsumption() const
  {
    return cfc_;
  }
  char fireDescription() const
  {
    return cfb_ >= 0.9 ? 'C' : (cfb_ < 0.1 ? 'S' : 'I');
  }
  MathSize surfaceFuelConsumption() const
  {
    return sfc_;
  }
  MathSize totalFuelConsumption() const
  {
    return tfc_;
  }
private:
  SpreadInfo(DurationSize time,
             MathSize min_ros,
             MathSize cell_size,
             const SlopeSize slope,
             const AspectSize aspect,
             const char* fuel_name,
             int nd,
             const wx::FwiWeather* weather);
  SpreadInfo(DurationSize time,
             MathSize min_ros,
             MathSize cell_size,
             const topo::SpreadKey& key,
             int nd,
             const wx::FwiWeather* weather);
  SpreadInfo(DurationSize time,
             MathSize min_ros,
             MathSize cell_size,
             const topo::SpreadKey& key,
             int nd,
             const wx::FwiWeather* weather,
             const wx::FwiWeather* weather_daily);
  static MathSize initial(SpreadInfo& spread,
                          const wx::FwiWeather& weather,
                          MathSize& ffmc_effect,
                          MathSize& wsv,
                          MathSize& rsoi,
                          const fuel::FuelType* const fuel,
                          bool has_no_slope,
                          MathSize heading_sin,
                          MathSize heading_cos,
                          MathSize bui_eff,
                          MathSize min_ros,
                          MathSize critical_surface_intensity);
  OffsetSet offsets_{};
  MathSize max_intensity_;
  topo::SpreadKey key_;
  wx::FwiWeather const* weather_;
  DurationSize time_;
  MathSize l_b_;
  MathSize head_ros_;
  MathSize cfb_;
  MathSize cfc_;
  MathSize tfc_;
  MathSize sfc_;
  bool is_crown_;
  fs::wx::Direction raz_;
  int nd_;
};
}