diff options
Diffstat (limited to 'Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H')
| -rw-r--r-- | Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.H | 8 |
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, |