docs

particle-track-and-trace/src/advection/UVGrid.h

@@ -11,6 +11,11 @@ private:
    */
   std::vector<Vel> uvData;
 public:
+  /**
+   * Constructs the UVGrid.
+   * @param path The data path where the constructor expects to find
+   * the files hydrodynamic_U.h5, hydrodynamic_V.h5, and grid.h5
+   */
   UVGrid(std::string path);
 
   /**
@@ -76,7 +81,7 @@ public:
    * The 3D index into the data. The array is sized by [8761][67][116]
    * @return Velocity at that index
    */
-    const Vel& operator[](size_t timeIndex, size_t latIndex, size_t lonIndex) const;
+  const Vel &operator[](size_t timeIndex, size_t latIndex, size_t lonIndex) const;
 
   /**
    * Streams a slice at timeIndex t of the matrix to the outstream given by os