aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.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/FiniteDifferenceSolver.H
parent54c5cc9faa06ab4ce5a7f53e93c077cf5488060b (diff)
downloadWarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.gz
WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.zst
WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.zip
Add Doxygen comments
Diffstat (limited to 'Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H')
-rw-r--r--Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H8
1 files changed, 8 insertions, 0 deletions
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H
index 0dbcea7ba..4bf88077f 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H
@@ -21,6 +21,14 @@ class FiniteDifferenceSolver
public:
// Constructor
+ /** \brief Initialize the finite-difference Maxwell solver (for a given refinement level)
+ *
+ * This function initializes the stencil coefficients for the chosen finite-difference algorithm
+ *
+ * \param fdtd_algo Identifies the chosen algorithm, as defined in WarpXAlgorithmSelection.H
+ * \param cell_size Cell size along each dimension, for the chosen refinement level
+ * \param do_nodal Whether the solver is applied to a nodal or staggered grid
+ */
FiniteDifferenceSolver (
int const fdtd_algo,
std::array<amrex::Real,3> cell_size,