Merge pull request computationalgeography#943 from kordejong/gh936

Add `accu_trigger`

Author: kordejong

document/doc/pcraster/status.md

@@ -34,7 +34,7 @@ these differences as much as possible.
     - LUE supports this PCRaster operation, or an operation like it. It may be that the LUE operation is named
       differently, that it supports different parameters, or that it accepts parameters in a different order.
 *   - ❌
-    - This PCRaster operations is not considered yet. It may be in the future.
+    - This PCRaster operation is not considered yet. It may be in the future.
 *   - 🗑
     - This PCRaster operation is considered, but skipped. See notes for reason.
 *   - 1, 2, 3
@@ -85,8 +85,8 @@ these differences as much as possible.
     - accu_threshold
 *   - accutriggerflux \
       accutriggerstate
-    - ❌
-    - 1
+    - ✅
+    - accu_trigger
 *   - accutraveltimestate \
       accutraveltimeflux \
       accutraveltimeremoved

source/framework/algorithm/CMakeLists.txt

@@ -1754,6 +1754,19 @@ block()
             )
             list(APPEND generated_source_files "${output_pathname}")
 
+            # Instantiate accu_trigger
+            set(output_pathname "${CMAKE_CURRENT_BINARY_DIR}/${offset}/accu_trigger-${Policies}_${element}.cpp")
+
+            generate_template_instantiation(
+                INPUT_PATHNAME
+                    "${CMAKE_CURRENT_SOURCE_DIR}/${offset}/accu_trigger.cpp.in"
+                OUTPUT_PATHNAME
+                    "${output_pathname}"
+                DICTIONARY
+                    '{"name":"${element}","Policies":"${Policies}","FlowDirectionElement":"${LUE_FRAMEWORK_FLOW_DIRECTION_ELEMENT}","Element":"${Element}"}'
+            )
+            list(APPEND generated_source_files "${output_pathname}")
+
             # Instantiate d8_flow_direction
             set(output_pathname "${CMAKE_CURRENT_BINARY_DIR}/${offset}/d8_flow_direction-${Policies}_${element}.cpp")
 

source/framework/algorithm/include/lue/framework/algorithm/accu_trigger.hpp

@@ -0,0 +1,52 @@
+#pragma once
+#include "lue/framework/algorithm/policy.hpp"
+#include "lue/framework/algorithm/scalar.hpp"
+#include "lue/framework/partitioned_array.hpp"
+
+
+namespace lue {
+
+    template<typename Policies>
+    auto accu_trigger(
+        Policies const& policies,
+        PartitionedArray<policy::InputElementT<Policies, 0>, 2> const& flow_direction,
+        PartitionedArray<policy::InputElementT<Policies, 1>, 2> const& inflow,
+        PartitionedArray<policy::InputElementT<Policies, 2>, 2> const& trigger)
+        -> std::tuple<
+            PartitionedArray<policy::OutputElementT<Policies, 0>, 2>,
+            PartitionedArray<policy::OutputElementT<Policies, 1>, 2>>;
+
+
+    template<typename Policies>
+    auto accu_trigger(
+        Policies const& policies,
+        PartitionedArray<policy::InputElementT<Policies, 0>, 2> const& flow_direction,
+        PartitionedArray<policy::InputElementT<Policies, 1>, 2> const& inflow,
+        Scalar<policy::InputElementT<Policies, 2>> const& trigger)
+        -> std::tuple<
+            PartitionedArray<policy::OutputElementT<Policies, 0>, 2>,
+            PartitionedArray<policy::OutputElementT<Policies, 1>, 2>>;
+
+
+    template<typename Policies>
+    auto accu_trigger(
+        Policies const& policies,
+        PartitionedArray<policy::InputElementT<Policies, 0>, 2> const& flow_direction,
+        Scalar<policy::InputElementT<Policies, 1>> const& inflow,
+        Scalar<policy::InputElementT<Policies, 2>> const& trigger)
+        -> std::tuple<
+            PartitionedArray<policy::OutputElementT<Policies, 0>, 2>,
+            PartitionedArray<policy::OutputElementT<Policies, 1>, 2>>;
+
+
+    template<typename Policies>
+    auto accu_trigger(
+        Policies const& policies,
+        PartitionedArray<policy::InputElementT<Policies, 0>, 2> const& flow_direction,
+        Scalar<policy::InputElementT<Policies, 1>> const& inflow,
+        PartitionedArray<policy::InputElementT<Policies, 2>, 2> const& trigger)
+        -> std::tuple<
+            PartitionedArray<policy::OutputElementT<Policies, 0>, 2>,
+            PartitionedArray<policy::OutputElementT<Policies, 1>, 2>>;
+
+}  // namespace lue

source/framework/algorithm/include/lue/framework/algorithm/default_policies/accu_trigger.hpp

@@ -0,0 +1,62 @@
+#pragma once
+#include "lue/framework/algorithm/accu_trigger.hpp"
+#include <concepts>
+
+
+namespace lue {
+    namespace policy::accu_trigger {
+
+        template<std::integral FlowDirectionElement, std::floating_point FloatingPointElement>
+        using DefaultPolicies = policy::DefaultPolicies<
+            AllValuesWithinDomain<FloatingPointElement, FloatingPointElement>,
+            OutputElements<FloatingPointElement, FloatingPointElement>,
+            InputElements<FlowDirectionElement, FloatingPointElement, FloatingPointElement>>;
+
+    }  // namespace policy::accu_trigger
+
+
+    namespace default_policies {
+
+        template<std::integral FlowDirectionElement, std::floating_point FloatingPointElement>
+        auto accu_trigger(
+            PartitionedArray<FlowDirectionElement, 2> const& flow_direction,
+            PartitionedArray<FloatingPointElement, 2> const& inflow,
+            Scalar<FloatingPointElement> const& trigger) -> std::
+            tuple<PartitionedArray<FloatingPointElement, 2>, PartitionedArray<FloatingPointElement, 2>>
+        {
+            using Policies =
+                policy::accu_trigger::DefaultPolicies<FlowDirectionElement, FloatingPointElement>;
+
+            return accu_trigger(Policies{}, flow_direction, inflow, trigger);
+        }
+
+
+        template<std::integral FlowDirectionElement, std::floating_point FloatingPointElement>
+        auto accu_trigger(
+            PartitionedArray<FlowDirectionElement, 2> const& flow_direction,
+            Scalar<FloatingPointElement> const& inflow,
+            Scalar<FloatingPointElement> const& trigger) -> std::
+            tuple<PartitionedArray<FloatingPointElement, 2>, PartitionedArray<FloatingPointElement, 2>>
+        {
+            using Policies =
+                policy::accu_trigger::DefaultPolicies<FlowDirectionElement, FloatingPointElement>;
+
+            return accu_trigger(Policies{}, flow_direction, inflow, trigger);
+        }
+
+
+        template<std::integral FlowDirectionElement, std::floating_point FloatingPointElement>
+        auto accu_trigger(
+            PartitionedArray<FlowDirectionElement, 2> const& flow_direction,
+            Scalar<FloatingPointElement> const& inflow,
+            PartitionedArray<FloatingPointElement, 2> const& trigger) -> std::
+            tuple<PartitionedArray<FloatingPointElement, 2>, PartitionedArray<FloatingPointElement, 2>>
+        {
+            using Policies =
+                policy::accu_trigger::DefaultPolicies<FlowDirectionElement, FloatingPointElement>;
+
+            return accu_trigger(Policies{}, flow_direction, inflow, trigger);
+        }
+
+    }  // namespace default_policies
+}  // namespace lue