From a2acacfd063a33a61ae8c3e089d34850ac5b2dc8 Mon Sep 17 00:00:00 2001 From: Arianna Formenti Date: Mon, 16 Dec 2024 17:40:42 -0800 Subject: [PATCH 1/3] fix wrong comments --- Source/ablastr/fields/IntegratedGreenFunctionSolver.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Source/ablastr/fields/IntegratedGreenFunctionSolver.cpp b/Source/ablastr/fields/IntegratedGreenFunctionSolver.cpp index 998bb179f5b..74f9b308acd 100755 --- a/Source/ablastr/fields/IntegratedGreenFunctionSolver.cpp +++ b/Source/ablastr/fields/IntegratedGreenFunctionSolver.cpp @@ -70,7 +70,7 @@ computePhiIGF ( amrex::MultiFab const & rho, amrex::Real const dz = cell_size[2]; if (!is_igf_2d_slices){ - // 2D sliced solver + // fully 3D solver obc_solver->setGreensFunction( [=] AMREX_GPU_DEVICE (int i, int j, int k) -> amrex::Real { @@ -84,7 +84,7 @@ computePhiIGF ( amrex::MultiFab const & rho, return SumOfIntegratedPotential3D(x, y, z, dx, dy, dz); }); }else{ - // fully 3D solver + // 2D sliced solver obc_solver->setGreensFunction( [=] AMREX_GPU_DEVICE (int i, int j, int k) -> amrex::Real { From 9c263c8b8a7b380b65fb5d6b741f6ded66a6396e Mon Sep 17 00:00:00 2001 From: Arianna Formenti Date: Mon, 16 Dec 2024 17:41:18 -0800 Subject: [PATCH 2/3] add to the docs --- Docs/source/usage/parameters.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 310a7986abf..fb6cc96191a 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -290,7 +290,7 @@ Overall simulation parameters In electromagnetic mode, this solver can be used to initialize the species' self fields (``.initialize_self_fields=1``) provided that the field BCs are PML (``boundary.field_lo,hi = PML``). - * ``warpx.use_2d_slices_fft_solver`` (`bool`, default: 0): Select the type of Integrated Green Function solver. + * ``warpx.use_2d_slices_fft_solver`` (`bool`) optional (default: 0): Select the type of Integrated Green Function solver. If 0, solve Poisson equation in full 3D geometry. If 1, solve Poisson equation in a quasi 3D geometry, neglecting the :math:`z` derivatives in the Laplacian of the Poisson equation. In practice, in this case, the code performes many 2D Poisson solves on all :math:`(x,y)` slices, each slice at a given :math:`z`. @@ -298,6 +298,13 @@ Overall simulation parameters As a consequence, this solver does not need to do an FFT along the :math:`z` direction, and instead uses only transverse FFTs (along :math:`x` and :math:`y`) at each :math:`z` position (or :math:`z` "slice"). + * ``ablastr.nprocs_igf_fft`` (`int`) optional (default: number of MPI ranks): Number of MPI ranks used to parallalelize the FFT solver. + This can be less or equal than then number of MPI ranks that are used to run the overall simulation. + It can be useful if the auxiliary simulation boxes fit within a single process, so to avoid extra communications. + The auxiliary boxes are extended boxes in real and spectral space that are used to perform the necessary FFTs. + The extended simulation box size in real space is :math:`2n_x-1, 2n_y-1, 2n_z-1` with the 3D solver, :math:`2n_x-1, 2n_y -1, n_z` with the 2D solver. + The extended simulation box size in spectral space is :math:`n_x, 2n_y-1, 2n_z-1` with the 3D solver, :math:`n_x, 2n_y-1, n_z` with the 2D solver. + * ``warpx.self_fields_required_precision`` (`float`, default: 1.e-11) The relative precision with which the electrostatic space-charge fields should be calculated. More specifically, the space-charge fields are From dbb24b2b75c69e949ef5e590647b3efafcda7a94 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 17 Dec 2024 01:46:36 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- Docs/source/usage/parameters.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index fb6cc96191a..31f0e06ab5b 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -300,7 +300,7 @@ Overall simulation parameters * ``ablastr.nprocs_igf_fft`` (`int`) optional (default: number of MPI ranks): Number of MPI ranks used to parallalelize the FFT solver. This can be less or equal than then number of MPI ranks that are used to run the overall simulation. - It can be useful if the auxiliary simulation boxes fit within a single process, so to avoid extra communications. + It can be useful if the auxiliary simulation boxes fit within a single process, so to avoid extra communications. The auxiliary boxes are extended boxes in real and spectral space that are used to perform the necessary FFTs. The extended simulation box size in real space is :math:`2n_x-1, 2n_y-1, 2n_z-1` with the 3D solver, :math:`2n_x-1, 2n_y -1, n_z` with the 2D solver. The extended simulation box size in spectral space is :math:`n_x, 2n_y-1, 2n_z-1` with the 3D solver, :math:`n_x, 2n_y-1, n_z` with the 2D solver.