diff options
| author |  Remi Lehe <remi.lehe@normalesup.org>
| 2020-02-06 09:59:11 -0800 |
|---|---|---|
| committer | Remi Lehe <remi.lehe@normalesup.org>
| 2020-02-06 09:59:11 -0800 |
| commit | 4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2 (patch) | |
| tree | 8de7995d1f888b752f6a4bd86b33050ba68c1cf2 /Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms | |
| parent | 54c5cc9faa06ab4ce5a7f53e93c077cf5488060b (diff) | |
| download | WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.gz WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.tar.zst WarpX-4bde6ab7bbfc8b2d4ceec7ebc88e421f8bd26cf2.zip | |
Add Doxygen comments
Diffstat (limited to 'Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms')
4 files changed, 19 insertions, 2 deletions
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H index 7c759cb35..fa5dd073d 100644 --- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H +++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.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 CKC algorithm. + */ struct CartesianCKCAlgorithm { static void InitializeStencilCoefficients ( @@ -50,8 +54,9 @@ struct CartesianCKCAlgorithm { Real const delta = std::max(inv_dx,inv_dz); Real const rx = (inv_dx/delta)*(inv_dx/delta); Real const rz = (inv_dz/delta)*(inv_dz/delta); - Real const betaxz = 0.125*rz*inv_dx; - Real const betazx = 0.125*rx*inv_dz; + Real const beta = 0.125; + Real const betaxz = beta*rz*inv_dx; + Real const betazx = beta*rx*inv_dz; Real const alphax = (1. - 2.*rz*beta)*inv_dx; Real const alphaz = (1. - 2.*rx*beta)*inv_dz; // Other coefficients are 0 in 2D Cartesian diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H index ed75dedc1..69622c5fe 100644 --- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.H +++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CartesianNodalAlgorithm.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 nodal algorithm. + */ struct CartesianNodalAlgorithm { static void InitializeStencilCoefficients ( 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 ( 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 ( |