Allow observing only some blocks in ObserveFields

sxs-collaboration · Sep 25, 2024 · 4cb9b91 · 4cb9b91
1 parent ebb074c
commit 4cb9b91
Show file tree

Hide file tree

Showing 33 changed files with 133 additions and 39 deletions.
diff --git a/src/ParallelAlgorithms/Events/ObserveFields.hpp b/src/ParallelAlgorithms/Events/ObserveFields.hpp
@@ -20,6 +20,7 @@
 #include "DataStructures/DataBox/ValidateSelection.hpp"
 #include "DataStructures/DataVector.hpp"
 #include "DataStructures/FloatingPointType.hpp"
+#include "Domain/Creators/BlockGroups.hpp"
 #include "Domain/Structure/ElementId.hpp"
 #include "Domain/Tags.hpp"
 #include "IO/H5/TensorData.hpp"
@@ -157,9 +158,19 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
     using type = FloatingPointType;
   };
 
+  /// \brief A list of block or group names on which to observe.
+  ///
+  /// Set to `All` to observer everywhere.
+  struct BlocksToObserve {
+    using type =
+        Options::Auto<std::vector<std::string>, Options::AutoLabel::All>;
+    static constexpr Options::String help = {
+        "A list of block and group names on which to observe."};
+  };
+
   using options =
       tmpl::list<SubfileName, CoordinatesFloatingPointType, FloatingPointTypes,
-                 VariablesToObserve, InterpolateToMesh>;
+                 VariablesToObserve, BlocksToObserve, InterpolateToMesh>;
 
   static constexpr Options::String help =
       "Observe volume tensor fields.\n"
@@ -170,12 +181,14 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
 
   ObserveFields() = default;
 
-  ObserveFields(const std::string& subfile_name,
-                FloatingPointType coordinates_floating_point_type,
-                const std::vector<FloatingPointType>& floating_point_types,
-                const std::vector<std::string>& variables_to_observe,
-                std::optional<Mesh<VolumeDim>> interpolation_mesh = {},
-                const Options::Context& context = {});
+  ObserveFields(
+      const std::string& subfile_name,
+      FloatingPointType coordinates_floating_point_type,
+      const std::vector<FloatingPointType>& floating_point_types,
+      const std::vector<std::string>& variables_to_observe,
+      std::optional<std::vector<std::string>> active_block_or_block_groups = {},
+      std::optional<Mesh<VolumeDim>> interpolation_mesh = {},
+      const Options::Context& context = {});
 
   using compute_tags_for_observation_box =
       tmpl::list<Tensors..., NonTensorComputeTags...>;
@@ -192,6 +205,10 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
                   const ElementId<VolumeDim>& array_index,
                   const ParallelComponent* const component,
                   const ObservationValue& observation_value) const {
+    if (not active_block(get<domain::Tags::Domain<VolumeDim>>(box),
+                         array_index)) {
+      return;
+    }
     // Skip observation on elements that are not part of a section
     const std::optional<std::string> section_observation_key =
         observers::get_section_observation_key<ArraySectionIdTag>(box);
@@ -333,6 +350,10 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
       std::pair<observers::TypeOfObservation, observers::ObservationKey>>
   get_observation_type_and_key_for_registration(
       const db::DataBox<DbTagsList>& box) const {
+    if (not active_block(db::get<domain::Tags::Domain<VolumeDim>>(box),
+                         db::get<domain::Tags::Element<VolumeDim>>(box).id())) {
+      return std::nullopt;
+    }
     const std::optional<std::string> section_observation_key =
         observers::get_section_observation_key<ArraySectionIdTag>(box);
     if (not section_observation_key.has_value()) {
@@ -359,6 +380,7 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
     Event::pup(p);
     p | subfile_path_;
     p | variables_to_observe_;
+    p | active_block_or_block_groups_;
     p | interpolation_mesh_;
   }
 
@@ -375,21 +397,37 @@ class ObserveFields<VolumeDim, tmpl::list<Tensors...>,
     return false;
   }
 
+  bool active_block(const Domain<VolumeDim>& domain,
+                    const ElementId<VolumeDim>& element_id) const {
+    if (not active_block_or_block_groups_.has_value()) {
+      return true;
+    }
+    const std::unordered_set<std::string> block_names =
+        domain::expand_block_groups_to_block_names(
+            active_block_or_block_groups_.value(), domain.block_names(),
+            domain.block_groups());
+    return alg::found(block_names,
+                      domain.blocks().at(element_id.block_id()).name());
+  }
+
   std::string subfile_path_;
   std::unordered_map<std::string, FloatingPointType> variables_to_observe_{};
+  std::optional<std::vector<std::string>> active_block_or_block_groups_{};
   std::optional<Mesh<VolumeDim>> interpolation_mesh_{};
 };
 
 template <size_t VolumeDim, typename... Tensors,
           typename... NonTensorComputeTags, typename ArraySectionIdTag>
 ObserveFields<VolumeDim, tmpl::list<Tensors...>,
               tmpl::list<NonTensorComputeTags...>, ArraySectionIdTag>::
-    ObserveFields(const std::string& subfile_name,
-                  const FloatingPointType coordinates_floating_point_type,
-                  const std::vector<FloatingPointType>& floating_point_types,
-                  const std::vector<std::string>& variables_to_observe,
-                  std::optional<Mesh<VolumeDim>> interpolation_mesh,
-                  const Options::Context& context)
+    ObserveFields(
+        const std::string& subfile_name,
+        const FloatingPointType coordinates_floating_point_type,
+        const std::vector<FloatingPointType>& floating_point_types,
+        const std::vector<std::string>& variables_to_observe,
+        std::optional<std::vector<std::string>> active_block_or_block_groups,
+        std::optional<Mesh<VolumeDim>> interpolation_mesh,
+        const Options::Context& context)
     : subfile_path_("/" + subfile_name),
       variables_to_observe_([&context, &floating_point_types,
                              &variables_to_observe]() {
@@ -416,6 +454,7 @@ ObserveFields<VolumeDim, tmpl::list<Tensors...>,
         }
         return result;
       }()),
+      active_block_or_block_groups_(std::move(active_block_or_block_groups)),
       interpolation_mesh_(interpolation_mesh) {
   ASSERT(
       (... or (db::tag_name<Tensors>() == "InertialCoordinates")),

diff --git a/support/Pipelines/Bbh/InitialData.yaml b/support/Pipelines/Bbh/InitialData.yaml
@@ -247,6 +247,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
       - ObserveAdmIntegrals
 
 RandomizeInitialGuess: None

diff --git a/support/Pipelines/Bbh/Inspiral.yaml b/support/Pipelines/Bbh/Inspiral.yaml
@@ -328,6 +328,7 @@ EventsAndTriggers:
           # for visualization.
           CoordinatesFloatingPointType: Float
           FloatingPointTypes: [Float]
+          BlocksToObserve: All
   # Try to find common horizon at small separation
   - Trigger:
       SeparationLessThan:

diff --git a/support/Pipelines/Bbh/Ringdown.yaml b/support/Pipelines/Bbh/Ringdown.yaml
@@ -191,6 +191,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
       - ApparentHorizon
       - ExcisionBoundary
   # Never terminate... run until something fails!

diff --git a/tests/InputFiles/CurvedScalarWave/PlaneWaveMinkowski3D.yaml b/tests/InputFiles/CurvedScalarWave/PlaneWaveMinkowski3D.yaml
@@ -100,6 +100,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:
@@ -116,6 +117,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/CurvedScalarWave/WorldtubeKerrSchild.yaml b/tests/InputFiles/CurvedScalarWave/WorldtubeKerrSchild.yaml
@@ -112,6 +112,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/Elasticity/BentBeam.yaml b/tests/InputFiles/Elasticity/BentBeam.yaml
@@ -108,6 +108,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/Elasticity/HalfSpaceMirror.yaml b/tests/InputFiles/Elasticity/HalfSpaceMirror.yaml
@@ -142,6 +142,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/Elasticity/SingleCoatingMirror.yaml b/tests/InputFiles/Elasticity/SingleCoatingMirror.yaml
@@ -159,6 +159,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Float
           FloatingPointTypes: [Float]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/GeneralizedHarmonic/CylindricalBinaryBlackHole.yaml b/tests/InputFiles/GeneralizedHarmonic/CylindricalBinaryBlackHole.yaml
@@ -205,6 +205,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/GeneralizedHarmonic/GaugeWave1D.yaml b/tests/InputFiles/GeneralizedHarmonic/GaugeWave1D.yaml
@@ -145,6 +145,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         Specified:

diff --git a/tests/InputFiles/GeneralizedHarmonic/GaugeWave3D.yaml b/tests/InputFiles/GeneralizedHarmonic/GaugeWave3D.yaml
@@ -138,6 +138,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         Specified:

diff --git a/tests/InputFiles/GeneralizedHarmonic/KerrSchild.yaml b/tests/InputFiles/GeneralizedHarmonic/KerrSchild.yaml
@@ -195,6 +195,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/GrMhd/GhValenciaDivClean/BinaryNeutronStar.yaml b/tests/InputFiles/GrMhd/GhValenciaDivClean/BinaryNeutronStar.yaml
@@ -311,6 +311,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Float
           FloatingPointTypes: [Float]
+          BlocksToObserve: All
   - Trigger:
       TimeCompares:
         Comparison: GreaterThan
@@ -362,6 +363,7 @@ EventsRunAtCleanup:
         InterpolateToMesh: None
         CoordinatesFloatingPointType: Double
         FloatingPointTypes: [Double]
+        BlocksToObserve: All
 
 # Control systems are disabled by default
 ControlSystems:

diff --git a/tests/InputFiles/GrMhd/GhValenciaDivClean/GhMhdBondiMichel.yaml b/tests/InputFiles/GrMhd/GhValenciaDivClean/GhMhdBondiMichel.yaml
@@ -206,6 +206,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double, Double, Double, Double, Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/GrMhd/GhValenciaDivClean/GhMhdTovStar.yaml b/tests/InputFiles/GrMhd/GhValenciaDivClean/GhMhdTovStar.yaml
@@ -239,6 +239,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double, Double, Double, Double, Double]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         Specified:

diff --git a/tests/InputFiles/Poisson/Lorentzian.yaml b/tests/InputFiles/Poisson/Lorentzian.yaml
@@ -132,6 +132,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 BuildMatrix:
   MatrixSubfileName: Matrix

diff --git a/tests/InputFiles/Poisson/ProductOfSinusoids1D.yaml b/tests/InputFiles/Poisson/ProductOfSinusoids1D.yaml
@@ -169,6 +169,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 BuildMatrix:
   MatrixSubfileName: Matrix

diff --git a/tests/InputFiles/Poisson/ProductOfSinusoids2D.yaml b/tests/InputFiles/Poisson/ProductOfSinusoids2D.yaml
@@ -111,6 +111,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/Poisson/ProductOfSinusoids3D.yaml b/tests/InputFiles/Poisson/ProductOfSinusoids3D.yaml
@@ -115,6 +115,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/Punctures/MultiplePunctures.yaml b/tests/InputFiles/Punctures/MultiplePunctures.yaml
@@ -169,6 +169,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
       - ObserveNorms:
           SubfileName: VolumeIntegrals
           TensorsToObserve:

diff --git a/tests/InputFiles/ScalarAdvection/Krivodonova1D.yaml b/tests/InputFiles/ScalarAdvection/Krivodonova1D.yaml
@@ -84,6 +84,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Float, Float]
+          BlocksToObserve: All
 
 EventsAndDenseTriggers:
 

diff --git a/tests/InputFiles/ScalarAdvection/Kuzmin2D.yaml b/tests/InputFiles/ScalarAdvection/Kuzmin2D.yaml
@@ -85,6 +85,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Float, Float]
+          BlocksToObserve: All
 
 EventsAndDenseTriggers:
 

diff --git a/tests/InputFiles/ScalarAdvection/Sinusoid1D.yaml b/tests/InputFiles/ScalarAdvection/Sinusoid1D.yaml
@@ -84,6 +84,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Float, Float]
+          BlocksToObserve: All
 
 EventsAndDenseTriggers:
 

diff --git a/tests/InputFiles/ScalarTensor/KerrSchildSphericalHarmonic.yaml b/tests/InputFiles/ScalarTensor/KerrSchildSphericalHarmonic.yaml
@@ -173,6 +173,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Float
           FloatingPointTypes: [Float]
+          BlocksToObserve: All
   - Trigger:
       Slabs:
         EvenlySpaced:

diff --git a/tests/InputFiles/ScalarWave/PlaneWave1DEventsAndTriggersExample.yaml b/tests/InputFiles/ScalarWave/PlaneWave1DEventsAndTriggersExample.yaml
@@ -93,6 +93,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
       - ObserveNorms:
           SubfileName: Errors
           TensorsToObserve:

diff --git a/tests/InputFiles/ScalarWave/PlaneWave1DObserveExample.yaml b/tests/InputFiles/ScalarWave/PlaneWave1DObserveExample.yaml
@@ -129,6 +129,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double, Float, Float]
+          BlocksToObserve: All
 # [observe_event_trigger]
 
 Observers:

diff --git a/tests/InputFiles/Xcts/BinaryBlackHole.yaml b/tests/InputFiles/Xcts/BinaryBlackHole.yaml
@@ -269,3 +269,4 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
diff --git a/tests/InputFiles/Xcts/HeadOnBns.yaml b/tests/InputFiles/Xcts/HeadOnBns.yaml
@@ -222,6 +222,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet

diff --git a/tests/InputFiles/Xcts/KerrSchild.yaml b/tests/InputFiles/Xcts/KerrSchild.yaml
@@ -242,3 +242,4 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Double
           FloatingPointTypes: [Double]
+          BlocksToObserve: All
diff --git a/tests/InputFiles/Xcts/TovStar.yaml b/tests/InputFiles/Xcts/TovStar.yaml
@@ -157,6 +157,7 @@ EventsAndTriggers:
           InterpolateToMesh: None
           CoordinatesFloatingPointType: Float
           FloatingPointTypes: [Float]
+          BlocksToObserve: All
 
 Amr:
   Verbosity: Quiet