Merge pull request #7518 from hen-w/ldg_scalar_wave_boundary_base_pr

Add BoundaryCondition base class for SecondOrderScalarWave system

Author: kidder

src/Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/BoundaryCondition.cpp

@@ -0,0 +1,29 @@
+// Distributed under the MIT License.
+// See LICENSE.txt for details.
+
+#include "Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/BoundaryCondition.hpp"
+
+#include <pup.h>
+
+#include "Domain/BoundaryConditions/BoundaryCondition.hpp"
+#include "Utilities/GenerateInstantiations.hpp"
+
+namespace SecondOrderScalarWave::BoundaryConditions {
+template <size_t Dim>
+BoundaryCondition<Dim>::BoundaryCondition(CkMigrateMessage* const msg)
+    : domain::BoundaryConditions::BoundaryCondition(msg) {}
+
+template <size_t Dim>
+void BoundaryCondition<Dim>::pup(PUP::er& p) {
+  domain::BoundaryConditions::BoundaryCondition::pup(p);
+}
+
+#define DIM(data) BOOST_PP_TUPLE_ELEM(0, data)
+
+#define INSTANTIATION(r, data) template class BoundaryCondition<DIM(data)>;
+
+GENERATE_INSTANTIATIONS(INSTANTIATION, (1, 2, 3))
+
+#undef INSTANTIATION
+#undef DIM
+}  // namespace SecondOrderScalarWave::BoundaryConditions

src/Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/BoundaryCondition.hpp

@@ -0,0 +1,32 @@
+// Distributed under the MIT License.
+// See LICENSE.txt for details.
+
+#pragma once
+
+#include <cstddef>
+
+#include "Domain/BoundaryConditions/BoundaryCondition.hpp"
+
+/// \cond
+namespace PUP {
+class er;
+}  // namespace PUP
+/// \endcond
+
+/// \brief Boundary conditions for the second-order scalar wave system
+namespace SecondOrderScalarWave::BoundaryConditions {
+/// \brief The base class off of which all boundary conditions must inherit
+template <size_t Dim>
+class BoundaryCondition : public domain::BoundaryConditions::BoundaryCondition {
+ public:
+  BoundaryCondition() = default;
+  BoundaryCondition(BoundaryCondition&&) = default;
+  BoundaryCondition& operator=(BoundaryCondition&&) = default;
+  BoundaryCondition(const BoundaryCondition&) = default;
+  BoundaryCondition& operator=(const BoundaryCondition&) = default;
+  ~BoundaryCondition() override = default;
+  explicit BoundaryCondition(CkMigrateMessage* msg);
+
+  void pup(PUP::er& p) override;
+};
+}  // namespace SecondOrderScalarWave::BoundaryConditions

src/Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/CMakeLists.txt

@@ -0,0 +1,15 @@
+# Distributed under the MIT License.
+# See LICENSE.txt for details.
+
+spectre_target_sources(
+  ${LIBRARY}
+  PRIVATE
+  BoundaryCondition.cpp
+  )
+
+spectre_target_headers(
+  ${LIBRARY}
+  INCLUDE_DIRECTORY ${CMAKE_SOURCE_DIR}/src
+  HEADERS
+  BoundaryCondition.hpp
+  )

src/Evolution/Systems/SecondOrderScalarWave/CMakeLists.txt

@@ -30,6 +30,9 @@ target_link_libraries(
   DataStructures
   DiscontinuousGalerkin
   Domain
+  DomainBoundaryConditions
   LinearOperators
   Utilities
   )
+
+add_subdirectory(BoundaryConditions)

src/Evolution/Systems/SecondOrderScalarWave/System.hpp

@@ -7,6 +7,7 @@
 #include <string>
 
 #include "DataStructures/VariablesTag.hpp"
+#include "Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/BoundaryCondition.hpp"
 #include "Evolution/Systems/SecondOrderScalarWave/Characteristics.hpp"
 #include "Evolution/Systems/SecondOrderScalarWave/Tags.hpp"
 #include "Evolution/Systems/SecondOrderScalarWave/TimeDerivative.hpp"
@@ -27,6 +28,8 @@ template <size_t Dim>
 struct System {
   static std::string name() { return "SecondOrderScalarWave"; }
 
+  using boundary_conditions_base = BoundaryConditions::BoundaryCondition<Dim>;
+
   static constexpr bool is_in_flux_conservative_form = false;
   static constexpr bool has_primitive_and_conservative_vars = false;
   static constexpr size_t volume_dim = Dim;

tests/Unit/Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/Test_Periodic.cpp

@@ -0,0 +1,29 @@
+// Distributed under the MIT License.
+// See LICENSE.txt for details.
+
+#include "Framework/TestingFramework.hpp"
+
+#include <cstddef>
+
+#include "Domain/BoundaryConditions/Periodic.hpp"
+#include "Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/BoundaryCondition.hpp"
+#include "Helpers/Evolution/DiscontinuousGalerkin/BoundaryConditions.hpp"
+
+namespace {
+template <size_t Dim>
+void test() {
+  CAPTURE(Dim);
+  TestHelpers::evolution::dg::test_periodic_condition<
+      domain::BoundaryConditions::Periodic<
+          SecondOrderScalarWave::BoundaryConditions::BoundaryCondition<Dim>>,
+      SecondOrderScalarWave::BoundaryConditions::BoundaryCondition<Dim>>(
+      "Periodic:\n");
+}
+}  // namespace
+
+SPECTRE_TEST_CASE("Unit.SecondOrderScalarWave.BoundaryConditions.Periodic",
+                  "[Unit][Evolution]") {
+  test<1>();
+  test<2>();
+  test<3>();
+}

tests/Unit/Evolution/Systems/SecondOrderScalarWave/CMakeLists.txt

@@ -4,6 +4,7 @@
 set(LIBRARY Test_SecondOrderScalarWave)
 
 set(LIBRARY_SOURCES
+  BoundaryConditions/Test_Periodic.cpp
   Test_Characteristics.cpp
   Test_System.cpp
   Test_Tags.cpp