Issue 394 src rcv python

CMakeLists.txt

@@ -216,6 +216,7 @@ if (NOT HDF5_CXX_BUILD)
         mesh
         source_class
         receiver_class
+        yaml-cpp
         ${BOOST_LIBS}
         Kokkos::kokkos)
 else()
@@ -224,8 +225,9 @@ else()
         mesh
         source_class
         receiver_class
-
         Kokkos::kokkos
+        yaml-cpp
+        ${BOOST_LIBS}
         ${HDF5_LIBRARIES}
     )
 endif()

include/IO/interface.hpp

@@ -7,6 +7,7 @@
 #include "source/interface.hpp"
 #include "specfem_mpi/interface.hpp"
 #include "specfem_setup.hpp"
+#include <yaml-cpp/yaml.h>
 
 namespace specfem {
 
@@ -53,5 +54,21 @@ read_sources(const std::string sources_file, const int nsteps,
              const type_real user_t0, const type_real dt,
              const specfem::simulation::type simulation_type);
 
+/**
+ * @brief Read sources file written in .yml format
+ *
+ * Parse source specification file written in yaml format and create a vector of
+ * specfem::source::source * object
+ *
+ * @param yaml YAML node containing source information
+ * @param mpi Pointer to specfem MPI object
+ * @return std::vector<specfem::sources::source *> vector of instantiated source
+ * objects
+ */
+std::tuple<std::vector<std::shared_ptr<specfem::sources::source> >, type_real>
+read_sources(const YAML::Node yaml, const int nsteps, const type_real user_t0,
+             const type_real dt,
+             const specfem::simulation::type simulation_type);
+
 } // namespace IO
 } // namespace specfem

include/source/moment_tensor_source.hpp

@@ -30,6 +30,26 @@ class moment_tensor : public source {
    *
    */
   moment_tensor(){};
+
+  /**
+   * @brief Get the Mxx component of the moment tensor
+   *
+   * @return type_real x-coordinate
+   */
+  type_real get_Mxx() const { return Mxx; }
+  /**
+   * @brief Get the Mxz component of the moment tensor
+   *
+   * @return type_real z-coordinate
+   */
+  type_real get_Mxz() const { return Mxz; }
+  /**
+   * @brief Get the Mzz component of the moment tensor
+   *
+   * @return type_real z-coordinate
+   */
+  type_real get_Mzz() const { return Mzz; }
+
   /**
    * @brief Construct a new moment tensor force object
    *

src/IO/sources.cpp

@@ -17,6 +17,15 @@ specfem::IO::read_sources(const std::string sources_file, const int nsteps,
                           const type_real user_t0, const type_real dt,
                           const specfem::simulation::type simulation_type) {
 
+  return read_sources(YAML::LoadFile(sources_file), nsteps, user_t0, dt,
+                      simulation_type);
+}
+
+std::tuple<std::vector<std::shared_ptr<specfem::sources::source> >, type_real>
+specfem::IO::read_sources(const YAML::Node yaml, const int nsteps,
+                          const type_real user_t0, const type_real dt,
+                          const specfem::simulation::type simulation_type) {
+
   const bool user_defined_start_time =
       (std::abs(user_t0) > std::numeric_limits<type_real>::epsilon());
 
@@ -34,7 +43,6 @@ specfem::IO::read_sources(const std::string sources_file, const int nsteps,
 
   // read sources file
   std::vector<std::shared_ptr<specfem::sources::source> > sources;
-  YAML::Node yaml = YAML::LoadFile(sources_file);
   int nsources = yaml["number-of-sources"].as<int>();
   YAML::Node Node = yaml["sources"];
   assert(Node.IsSequence());
@@ -89,9 +97,8 @@ specfem::IO::read_sources(const std::string sources_file, const int nsteps,
   if (sources.size() != nsources) {
     std::ostringstream message;
     message << "Found only " << sources.size()
-            << " number of sources. Total number of sources in " << sources_file
-            << " are" << nsources
-            << " Please check if there is a error in sources file.";
+            << " number of sources. Found total number of sources in are "
+            << nsources << " Please check if there is a error in sources file.";
     throw std::runtime_error(message.str());
   }
 

tests/unit-tests/CMakeLists.txt

@@ -203,6 +203,7 @@ add_executable(
   assembly/sources/sources.cpp
 )
 
+
 target_link_libraries(
   assembly_tests
   reader
@@ -218,6 +219,19 @@ target_link_libraries(
   -lpthread -lm
 )
 
+add_executable(
+  IO_tests
+  IO/sources/test_read_sources.cpp
+)
+
+target_link_libraries(
+  IO_tests
+  IO
+  gtest_main
+  kokkos_environment
+  yaml-cpp
+  Boost::filesystem
+)
 
 add_executable(
   locate_point

tests/unit-tests/IO/sources/data/single_moment_tensor.yml

@@ -0,0 +1,13 @@
+number-of-sources: 1
+sources:
+  - moment-tensor:
+      x: 2000.0
+      z: 3000.0
+      Mxx: 1.0
+      Mzz: 1.0
+      Mxz: 0.0
+      angle: 0.0
+      Ricker:
+          factor: 1.0e10
+          tshift: 30.0
+          f0: 1.0

tests/unit-tests/IO/sources/test_read_sources.cpp

@@ -0,0 +1,49 @@
+#include "../../Kokkos_Environment.hpp"
+#include "IO/interface.hpp"
+#include "enumerations/specfem_enums.hpp"
+#include "enumerations/wavefield.hpp"
+#include "source/interface.hpp"
+#include <Kokkos_Core.hpp>
+#include <gtest/gtest.h>
+#include <yaml-cpp/yaml.h>
+
+TEST(read_sources, READ_SOURCES) {
+  /**
+   *  This test checks whether a moment tensor source is read correctly
+   */
+
+  std::string sources_file =
+      "../../../tests/unit-tests/IO/sources/data/single_moment_tensor.yml";
+
+  int nsteps = 100;
+  type_real t0 = 0.0;
+  type_real dt = 0.01;
+  type_real f0 = 1.0;
+  type_real tshift = 30.0;
+  type_real factor = 1.0e10;
+  // This is from the definition of the STF such that it is zero at t=0
+  type_real hdur = 1.0 / f0;
+  type_real t0_final = -1.2 * hdur + tshift;
+
+  auto [sources, user_t0] = specfem::IO::read_sources(
+      sources_file, nsteps, t0, dt, specfem::simulation::type::forward);
+
+  ASSERT_EQ(sources.size(), 1);
+  auto source = sources[0];
+  auto mt = std::dynamic_pointer_cast<specfem::sources::moment_tensor>(source);
+  ASSERT_EQ(mt->get_wavefield_type(),
+            specfem::wavefield::simulation_field::forward);
+  ASSERT_EQ(mt->get_Mxx(), 1.0);
+  ASSERT_EQ(mt->get_Mxz(), 0.0);
+  ASSERT_EQ(mt->get_Mzz(), 1.0);
+  EXPECT_NEAR(mt->get_x(), 2000.0, 1e-10);
+  EXPECT_NEAR(mt->get_z(), 3000.0, 1e-10);
+  ASSERT_EQ(source->get_t0(), t0_final);
+  ASSERT_EQ(source->get_tshift(), 0.0); // tshift is adjusted to be 0.0
+}
+
+int main(int argc, char *argv[]) {
+  ::testing::InitGoogleTest(&argc, argv);
+  ::testing::AddGlobalTestEnvironment(new KokkosEnvironment);
+  return RUN_ALL_TESTS();
+}