From 4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2 Mon Sep 17 00:00:00 2001
From: Remi Lehe <remi.lehe@normalesup.org>
Date: Thu, 6 Feb 2020 09:59:11 -0800
Subject: Add Doxygen comments

---
 .../FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H              | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H')

diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H
index 28d159e08..ab32c8bcb 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H
@@ -12,6 +12,10 @@
 #include <AMReX_Array4.H>
 #include <AMReX_Gpu.H>
 
+/**
+ * This struct contains only static functions to initialize the stencil coefficients
+ * and to compute finite-difference derivatives for the Cartesian Yee algorithm.
+ */
 struct CylindricalYeeAlgorithm {
 
     static void InitializeStencilCoefficients (
-- 
cgit v1.2.3