Minor doxygen update.

pkestene · Sep 10, 2024 · 5ea597c · 5ea597c
1 parent ff53523
commit 5ea597c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/muscl/MHDRunFunctors2D.h b/src/muscl/MHDRunFunctors2D.h
@@ -1336,6 +1336,14 @@ class ReconstructEdgeComputeEmfAndUpdateFunctor2D : public MHDBaseFunctor2D
       functor);
   }
 
+  /**
+   * Given a cell-center MHD state and limited slopes, reconstruct a MHD state at edge.
+   *
+   * \param[out] qEdge is the reconstructed MHD state at edge
+   * \param[in] i0 x-coordinate (cell center) of the cell where the reconstruction takes place
+   * \param[in] j0 y-coordinate (cell center) of the cell where the reconstruction takes place
+   * \param[in] edge_loc is the type of edge reconstruction (from cell center)
+   */
   KOKKOS_INLINE_FUNCTION auto
   reconstruct_state_at_edge(MHDState &      qEdge,
                             uint32_t        i0,