ShapeFunction supplemented by getPrimaryName()

PKua007 · Sep 19, 2023 · b6e7baf · b6e7baf
1 parent 9ccf854
commit b6e7baf
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 18 deletions.
diff --git a/src/core/observables/BinAveragedFunction.h b/src/core/observables/BinAveragedFunction.h
@@ -48,7 +48,9 @@ class BinAveragedFunction : public BulkObservable {
     /**
      * @brief Returns "rho_xyz" as the signature name.
      */
-    [[nodiscard]] std::string getSignatureName() const override { return "temp_xyz"; };
+    [[nodiscard]] std::string getSignatureName() const override {
+        return this->shapeFunction->getPrimaryName() + "_xyz";
+    }
 
     /**
      * @brief Dumps a flat list of HistogramBuilder3D::BinValue -s averaged over snapshots.

diff --git a/src/core/observables/ShapeFunction.h b/src/core/observables/ShapeFunction.h
@@ -24,6 +24,8 @@ class ShapeFunction {
      */
     virtual void calculate(const Shape &shape, const ShapeTraits &traits) = 0;
 
+    [[nodiscard]] virtual std::string getPrimaryName() const = 0;
+
     [[nodiscard]] virtual std::vector<std::string> getNames() const = 0;
 
     [[nodiscard]] virtual std::vector<double> getValues() const = 0;

diff --git a/src/core/observables/shape_functions/ConstantShapeFunction.h b/src/core/observables/shape_functions/ConstantShapeFunction.h
@@ -20,6 +20,7 @@ class ConstantShapeFunction : public ShapeFunction {
 
     void calculate([[maybe_unused]] const Shape &shape, [[maybe_unused]] const ShapeTraits &traits) override { }
 
+    [[nodiscard]] std::string getPrimaryName() const override { return "const"; }
     [[nodiscard]] std::vector<std::string> getNames() const override { return {"const"}; }
     [[nodiscard]] std::vector<double> getValues() const override { return {this->value}; }
 };

diff --git a/src/core/observables/shape_functions/ShapeAxisCoordinate.h b/src/core/observables/shape_functions/ShapeAxisCoordinate.h
@@ -28,8 +28,9 @@ class ShapeAxisCoordinate : public ShapeFunction {
 
     void calculate(const Shape &shape, const ShapeTraits &traits) override;
 
-    [[nodiscard]] std::vector<double> getValues() const override { return {this->value}; }
+    [[nodiscard]] std::string getPrimaryName() const override { return this->name; }
     [[nodiscard]] std::vector<std::string> getNames() const override { return {this->name}; }
+    [[nodiscard]] std::vector<double> getValues() const override { return {this->value}; }
 };
 
 

diff --git a/test/mocks/MockShapeFunction.h b/test/mocks/MockShapeFunction.h
@@ -15,6 +15,7 @@ class MockShapeFunction : public trompeloeil::mock_interface<ShapeFunction> {
     IMPLEMENT_MOCK2(calculate);
     IMPLEMENT_CONST_MOCK0(getValues);
     IMPLEMENT_CONST_MOCK0(getNames);
+    IMPLEMENT_CONST_MOCK0(getPrimaryName);
 };
 
 

diff --git a/test/unit_tests/core/observables/BinAveragedFunctionTest.cpp b/test/unit_tests/core/observables/BinAveragedFunctionTest.cpp
@@ -41,31 +41,38 @@ TEST_CASE("BinAveragedFunction") {
     ALLOW_CALL(*mockShapeFunction, calculate(std::ref(packing[2]), _)).LR_SIDE_EFFECT(functionValue = 4);
     ALLOW_CALL(*mockShapeFunction, calculate(std::ref(packing[3]), _)).LR_SIDE_EFFECT(functionValue = 5);
     ALLOW_CALL(*mockShapeFunction, getValues()).LR_RETURN(std::vector<double>{functionValue});
+    ALLOW_CALL(*mockShapeFunction, getPrimaryName()).RETURN("func");
 
     auto densityFunction = std::make_shared<ConstantShapeFunction>();
     auto tracker = std::make_unique<FourierTracker>(std::array<std::size_t, 3>{1, 0, 0}, densityFunction);
     BinAveragedFunction binAveragedFunction({10, 0, 0}, std::move(mockShapeFunction), std::move(tracker));
 
-    // We do Fourier tracking on the density - in each snapshot we move a bit in the x direction
-    for (std::size_t i{}; i < 10; i++) {
-        binAveragedFunction.addSnapshot(packing, 1, 1, traits);
-        for (std::size_t j{}; j < packing.size(); j++) {
-            packing.tryTranslation(j, {0.3, 0, 0}, traits.getInteraction());
-            packing.acceptTranslation();
+    SECTION("the histogram") {
+        // We do Fourier tracking on the density - in each snapshot we move a bit in the x direction
+        for (std::size_t i{}; i < 10; i++) {
+            binAveragedFunction.addSnapshot(packing, 1, 1, traits);
+            for (std::size_t j{}; j < packing.size(); j++) {
+                packing.tryTranslation(j, {0.3, 0, 0}, traits.getInteraction());
+                packing.acceptTranslation();
+            }
         }
-    }
 
-    auto histogram = binAveragedFunction.dumpValues();
-    using BinValue = decltype(histogram)::value_type;
-    auto nanRemover = [](const BinValue &binValue) { return std::isnan(binValue.value[0]); };
-    histogram.erase(std::remove_if(histogram.begin(), histogram.end(), nanRemover), histogram.end());
-    std::vector<BinValue> expected = {
+        auto histogram = binAveragedFunction.dumpValues();
+        using BinValue = decltype(histogram)::value_type;
+        auto nanRemover = [](const BinValue &binValue) { return std::isnan(binValue.value[0]); };
+        histogram.erase(std::remove_if(histogram.begin(), histogram.end(), nanRemover), histogram.end());
+        std::vector<BinValue> expected = {
             {{0.45, 0.5, 0.5}, {1}},
             {{0.55, 0.5, 0.5}, {3}},
             {{0.65, 0.5, 0.5}, {5}}
-    };
-    for (auto[expectedItem, actualItem] : Zip(expected, histogram)) {
-        CHECK_THAT(actualItem.binMiddle, IsApproxEqual(expectedItem.binMiddle, 1e-12));
-        CHECK(actualItem.value[0] == Approx(expectedItem.value[0]));
+        };
+        for (auto [expectedItem, actualItem]: Zip(expected, histogram)) {
+            CHECK_THAT(actualItem.binMiddle, IsApproxEqual(expectedItem.binMiddle, 1e-12));
+            CHECK(actualItem.value[0] == Approx(expectedItem.value[0]));
+        }
+    }
+
+    SECTION("signature name") {
+        CHECK(binAveragedFunction.getSignatureName() == "func_xyz");
     }
 }
diff --git a/test/unit_tests/core/observables/trackers/FourierTrackerTest.cpp b/test/unit_tests/core/observables/trackers/FourierTrackerTest.cpp
@@ -31,6 +31,7 @@ namespace {
             this->value = this->function(shape, traits);
         }
 
+        [[nodiscard]] std::string getPrimaryName() const override { return this->name; }
         [[nodiscard]] std::vector<std::string> getNames() const override { return {this->name}; }
         [[nodiscard]] std::vector<double> getValues() const override { return {this->value}; }
     };