aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
diff options
context:
space:
mode:
authorGravatar Remi Lehe <remi.lehe@normalesup.org> 2020-02-06 09:59:11 -0800
committerGravatar Remi Lehe <remi.lehe@normalesup.org> 2020-02-06 09:59:11 -0800
commit4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2 (patch)
tree8de7995d1f888b752f6a4bd86b33050ba68c1cf2 /Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
parent54c5cc9faa06ab4ce5a7f53e93c077cf5488060b (diff)
downloadWarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.gz
WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.zst
WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.zip
Add Doxygen comments
Diffstat (limited to 'Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H')
-rw-r--r--Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H4
1 files changed, 4 insertions, 0 deletions
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
index 838e3b0bb..268c5aa89 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianYeeAlgorithm.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 CartesianYeeAlgorithm {
static void InitializeStencilCoefficients (