diff options
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralKSpace.H')
| -rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralKSpace.H | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralKSpace.H b/Source/FieldSolver/SpectralSolver/SpectralKSpace.H index 5816a3477..b53fc7c4d 100644 --- a/Source/FieldSolver/SpectralSolver/SpectralKSpace.H +++ b/Source/FieldSolver/SpectralSolver/SpectralKSpace.H @@ -61,7 +61,16 @@ class SpectralKSpace amrex::RealVect dx; }; +/** + * \brief Returns an array of coefficients (Fornberg coefficients), corresponding + * to the weight of each point in a finite-difference approximation of a derivative + * (up to order \c n_order). + * + * \param[in] n_order order of the finite-difference approximation + * \param[in] nodal whether the finite-difference approximation is computed + * on a nodal grid or a staggered grid + */ amrex::Vector<amrex::Real> -getFonbergStencilCoefficients( const int n_order, const bool nodal ); +getFornbergStencilCoefficients(const int n_order, const bool nodal); #endif |