ES solver cleanup - 2024 hackathon (#5241)

* initial commit with start of new BoundaryHandler class

* renaming BoundaryHandler to PoissonBoundaryHandler, defining new base class ES and derived ExplicitES

* snake case for poissonboundaryhandler

* adding files for existing ES solvers

* add `m_electrostatic_solver` to WarpX.cpp

* create base class for ElectrostaticSolvers

* continue refining electrostatic base class

* more refinements on the base electrostatic solver

* add relativistic ES solver

* remove constr and readparam

* moving functions to lab frame ES

* cmakelist and make package

* various bug fixes

* more bug fixes

* fixing compilation errors

* warpx object for dmap

* add getMaxNormRho function

* more bug fixes

* moved calculation of beta, check if fft and check if 3d out of loop over levels

* swap calculation of beta, and check if fft and check if 3d

* dx_igf becomes dx_scaled, remove duplicate code to calculate dx_scaled

* more progress on bug fixing

* more bug fixes

* getting close...

* adds interpolatePhiBetweenLevels

* yeeaaassss

* a few warnings

* fix various warnings

* fix max_norm_b

* more warnings

* remove comments

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more fixes

* move `ReadParameters` to base class for electrostatic solvers

* force `ComputeSpaceCharge` to be implemented in child classes

* remove trampoline class

* fix condition for mfl access

* reuse finest_level and ng

* remove namespace ablastr::constant::SI

* pybuild fixes

* fix for initial ES solve

* fix bugs

* add back bool to check if any potentials are set

* second try for fixing potential specified check

* comments for base class

* include in make packag

* bug fixes with number of levels in ES solvers

* another fix for `lev <= num_levels`

* more doxygen comments

* adding defaults back for toleance, max iters, verbosity

* add doxygen to PoissonSolver.H

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* oops values were defined, still amrex namespace was complaining in ci and const for required precision

* removing default for beta as well

* call `DefinePhiBCs` when ES solver is relativistic

* fix build failures

* always run solve when ES relativistic is used

* fix double counting of E-field in relativistic solves

* removing tmp file

* pass geom ref

* attempt to fix clang-tidy errors

* second attempt to fix clang-tidy issue

* minor clean-ups

Signed-off-by: roelof-groenewald <[email protected]>

* remove var not used anymore

* clean up definition

* cosmetic indentation

* Update Source/ablastr/fields/PoissonSolver.H

Remi's suggestion

Co-authored-by: Remi Lehe <[email protected]>

* Update Source/ablastr/fields/PoissonSolver.H

Co-authored-by: Remi Lehe <[email protected]>

* clean and remove empty functions and calls to these functions

---------

Signed-off-by: roelof-groenewald <[email protected]>
Co-authored-by: RevathiJambunathan <[email protected]>
Co-authored-by: Arianna Formenti <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Revathi  Jambunathan <[email protected]>
Co-authored-by: Remi Lehe <[email protected]>

Source/FieldSolver/CMakeLists.txt

@@ -2,13 +2,14 @@ foreach(D IN LISTS WarpX_DIMS)
     warpx_set_suffix_dims(SD ${D})
     target_sources(lib_${SD}
       PRIVATE
-        ElectrostaticSolver.cpp
         WarpXPushFieldsEM.cpp
         WarpXPushFieldsHybridPIC.cpp
         WarpX_QED_Field_Pushers.cpp
+        WarpXSolveFieldsES.cpp
     )
 endforeach()
 
+add_subdirectory(ElectrostaticSolvers)
 add_subdirectory(FiniteDifferenceSolver)
 add_subdirectory(MagnetostaticSolver)
 add_subdirectory(ImplicitSolvers)