ReceiverWriter.h

/**
 * @file
 * This file is part of SeisSol.
 *
 * @author Carsten Uphoff (c.uphoff AT tum.de, http://www5.in.tum.de/wiki/index.php/Carsten_Uphoff,_M.Sc.)
 *
 * @section LICENSE
 * Copyright (c) 2019, SeisSol Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @section DESCRIPTION
 **/

#ifndef RESULTWRITER_RECEIVERWRITER_H_
#define RESULTWRITER_RECEIVERWRITER_H_

#include <vector>
#include <string_view>

#include <Eigen/Dense>
#include "Geometry/MeshReader.h"
#include "Initializer/tree/Lut.hpp"
#include "Initializer/LTS.h"
#include "Kernels/Receiver.h"
#include "Modules/Module.h"
#include "Monitoring/Stopwatch.h"

struct LocalIntegrationData;
struct GlobalData;
namespace seissol::initializer::parameters {
  struct ReceiverOutputParameters;
}

namespace seissol::writer {
    Eigen::Vector3d parseReceiverLine(const std::string& line);
    std::vector<Eigen::Vector3d> parseReceiverFile(const std::string& receiverFileName);

    class ReceiverWriter : public seissol::Module {
    public:
      void init(const std::string& fileNamePrefix, double endTime, const seissol::initializer::parameters::ReceiverOutputParameters& parameters);

      void addPoints(
          const seissol::geometry::MeshReader& mesh,
          const seissol::initializers::Lut& ltsLut,
          const seissol::initializers::LTS& lts,
          const GlobalData* global);

      kernels::ReceiverCluster* receiverCluster(unsigned clusterId, LayerType layer) {
        assert(layer != Ghost);
        assert(m_receiverClusters.find(layer) != m_receiverClusters.end());
        auto& clusters = m_receiverClusters[layer];
        if (clusterId < clusters.size()) {
          return &clusters[clusterId];
        }
        return nullptr;
      }
      //
      // Hooks
      //
      void syncPoint(double) override;

    private:
      [[nodiscard]] std::string fileName(unsigned pointId) const;
      void writeHeader(unsigned pointId, Eigen::Vector3d const& point);

      std::string m_receiverFileName;
      std::string m_fileNamePrefix;
      double      m_samplingInterval;
      bool        m_computeRotation;
      // Map needed because LayerType enum casts weirdly to int.
      std::unordered_map<LayerType, std::vector<kernels::ReceiverCluster>> m_receiverClusters;
      Stopwatch   m_stopwatch;
    };
  }

#endif