some interface documentation

Author: philippwindischhofer

include/Eisvogel/Current0D.hh

@@ -9,6 +9,15 @@ class Current0D {
 public:
 
   Current0D() : m_points({}), m_charges({}) { };
+
+  /**
+   * Create a new particle trajectory as a collection of straight-line segments, with a certain
+   * amount of charge flowing along each segment.
+   *
+   * @param points   Vector of (t, x, y, z) coordinates defining the start- and endpoints of the individual straight-line segments.
+   *                 A vector of length `N` defines `N-1` line segments.
+   * @param charges  Vector of length `N-1` containing charges for each line segment.
+   */  
   Current0D(std::vector<CoordVector>&& points, std::vector<scalar_t>&& charges) : m_points(points), 
 										  m_charges(charges) { 
     if(m_points.size() != m_charges.size() + 1) {

include/Eisvogel/SignalCalculator.hh

@@ -14,6 +14,16 @@ public:
   SignalCalculator(const std::filesystem::path& geometry_path);
   scalar_t ComputeSignal(const Current0D& track, scalar_t t_sig);
   scalar_t ComputeSignal(const SparseCurrentDensity3D& current_distribution, scalar_t t_sig);
+
+   /**
+     * Calculate the contribution to the antenna signal arising from a particle track.
+     *
+     * @param track    The particle track.
+     * @param ts       The time values at which the signal should be calculated
+     * @param signal   Antenna signal buffer in which the contribution is to be accumulated.
+     *                 Must exist and have the same length as ts.
+     */  
+  void AccumulateSignal(const Current0D& track, std::vector<scalar_t>& ts, std::vector<scalar_t>& signal);
 
 private:
   std::filesystem::path m_geometry_path;