Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doxygen documentation regarding is_igf_2d_slices #5556

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Add doxygen documentation regarding is_igf_2d_slices #5556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5cd591
document bool
aeriforme Jan 14, 2025
ff1d4b0
Apply suggestions from code review
ax3l Jan 14, 2025
e73f82f
Update Source/ablastr/fields/PoissonSolver.H
ax3l Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Source/FieldSolver/ElectrostaticSolvers/ElectrostaticSolver.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,15 @@ public:
* \f[
* \vec{\nabla}^2 r \phi - (\vec{\beta}\cdot\vec{\nabla})^2 r \phi = -\frac{r \rho}{\epsilon_0}
* \f]
* \param[out] phi The potential to be computed by this function
* \param[in] rho The charge density for a given species (relativistic solver)
* or total charge density (labframe solver)
* \param[out] phi The potential to be computed by this function
* \param[in] beta Represents the velocity of the source of `phi`
* \param[in] required_precision The relative convergence threshold for the MLMG solver
* \param[in] absolute_tolerance The absolute convergence threshold for the MLMG solver
* \param[in] max_iters The maximum number of iterations allowed for the MLMG solver
* \param[in] verbosity The verbosity setting for the MLMG solver
* \param[in] is_igf_2d_slices boolean to select between fully 3D Poisson solver and quasi-3D, i.e. one 2D Poisson solve on every z slice (default: false)
*/
void computePhi (
ablastr::fields::MultiLevelScalarField const& rho,
Expand Down
1 change: 1 addition & 0 deletions Source/ablastr/fields/IntegratedGreenFunctionSolver.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ namespace ablastr::fields
* @param[out] phi the electrostatic potential amrex::MultiFab
* @param[in] cell_size an arreay of 3 reals dx dy dz
* @param[in] ba amrex::BoxArray with the grid of a given level
* @param[in] is_igf_2d boolean to select between fully 3D Poisson solver and quasi-3D, i.e. one 2D Poisson solve on every z slice (default: false)
*/
void
computePhiIGF (amrex::MultiFab const & rho,
Expand Down
1 change: 1 addition & 0 deletions Source/ablastr/fields/PoissonSolver.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ inline void interpolatePhiBetweenLevels (
* \param[in] grids the grids per level (e.g., from AmrMesh)
* \param[in] grid_type Integer that corresponds to the type of grid used in the simulation (collocated, staggered, hybrid)
* \param[in] is_solver_igf_on_lev0 boolean to select the Poisson solver: 1 for FFT on level 0 & Multigrid on other levels, 0 for Multigrid on all levels
* \param[in] is_igf_2d boolean to select between fully 3D Poisson solver and quasi-3D, i.e. one 2D Poisson solve on every z slice (default: false)
* \param[in] eb_enabled solve with embedded boundaries
* \param[in] do_single_precision_comms perform communications in single precision
* \param[in] rel_ref_ratio mesh refinement ratio between levels (default: 1)
Expand Down
Loading