Use uniform error message formatting in more source files (#2964)

* use WARPX_ALWAYS_ASSERT_WITH_MESSAGE instead of Abort()

* fix bug

* Update Source/WarpX.cpp

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

* use more uniform text formatting

* fixed bug

* fixed bug

* using Utils::TextMsg in more files

* fixed bug

* use Utils::TextMsg in more files

* fixed bug

* use Utils::TextMsg in more files

* fixed last merge conflict

* fixed bug

* fix indentation

Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

12 files changed, 47 insertions, 23 deletions

diff --git a/Source/FieldSolver/FiniteDifferenceSolver/ApplySilverMuellerBoundary.cpp b/Source/FieldSolver/FiniteDifferenceSolver/ApplySilverMuellerBoundary.cpp
index 46b32a8ff..01ae22a09 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/ApplySilverMuellerBoundary.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/ApplySilverMuellerBoundary.cpp
@@ -9,6 +9,7 @@
 #ifdef WARPX_DIM_RZ
 #   include "FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 
@@ -42,9 +43,10 @@ void FiniteDifferenceSolver::ApplySilverMuellerBoundary (
     amrex::Vector<int> field_boundary_hi) {
 
     // Ensure that we are using the Yee solver
-    if (m_fdtd_algo != MaxwellSolverAlgo::Yee) {
-        amrex::Abort("The Silver-Mueller boundary conditions can only be used with the Yee solver.");
-    }
+    WARPX_ALWAYS_ASSERT_WITH_MESSAGE(
+        m_fdtd_algo == MaxwellSolverAlgo::Yee,
+        "The Silver-Mueller boundary conditions can only be used with the Yee solver."
+    );
 
     // Ensure that we are using the cells the domain
     domain_box.enclosedCells();
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/ComputeDivE.cpp b/Source/FieldSolver/FiniteDifferenceSolver/ComputeDivE.cpp
index 0e511e279..f9e434699 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/ComputeDivE.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/ComputeDivE.cpp
@@ -6,6 +6,7 @@
  */
 #include "FiniteDifferenceSolver.H"
 
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #ifndef WARPX_DIM_RZ
 #   include "FiniteDifferenceAlgorithms/CartesianCKCAlgorithm.H"
@@ -64,7 +65,7 @@ void FiniteDifferenceSolver::ComputeDivE (
 
 #endif
     } else {
-        amrex::Abort("ComputeDivE: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("ComputeDivE: Unknown algorithm"));
     }
 
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveB.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveB.cpp
index 5e0a944b2..ec304fa24 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveB.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveB.cpp
@@ -13,6 +13,7 @@
 #else
 #   include "FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 #include "WarpX.H"
@@ -91,7 +92,7 @@ void FiniteDifferenceSolver::EvolveB (
 #endif
 #endif
     } else {
-        amrex::Abort("EvolveB: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveB: Unknown algorithm"));
     }
 }
 
@@ -210,7 +211,8 @@ void FiniteDifferenceSolver::EvolveBCartesianECT (
 #ifdef AMREX_USE_EB
 
 #if !(defined(WARPX_DIM_3D) || defined(WARPX_DIM_XZ))
-    amrex::Abort("EvolveBCartesianECT: Embedded Boundaries are only implemented in 2D3V and 3D3V");
+    amrex::Abort(Utils::TextMsg::Err(
+        "EvolveBCartesianECT: Embedded Boundaries are only implemented in 2D3V and 3D3V"));
 #endif
 
     amrex::LayoutData<amrex::Real> *cost = WarpX::getCosts(lev);
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveBPML.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveBPML.cpp
index 5b182812a..aad66d3d4 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveBPML.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveBPML.cpp
@@ -15,6 +15,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 
 #include <AMReX.H>
@@ -49,7 +50,8 @@ void FiniteDifferenceSolver::EvolveBPML (
    // but we compile code for each algorithm, using templates)
 #ifdef WARPX_DIM_RZ
     amrex::ignore_unused(Bfield, Efield, dt, dive_cleaning);
-    amrex::Abort("PML are not implemented in cylindrical geometry.");
+    amrex::Abort(Utils::TextMsg::Err(
+        "PML are not implemented in cylindrical geometry."));
 #else
     if (m_do_nodal) {
 
@@ -64,7 +66,8 @@ void FiniteDifferenceSolver::EvolveBPML (
         EvolveBPMLCartesian <CartesianCKCAlgorithm> (Bfield, Efield, dt, dive_cleaning);
 
     } else {
-        amrex::Abort("EvolveBPML: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err(
+            "EvolveBPML: Unknown algorithm"));
     }
 #endif
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveE.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveE.cpp
index b044f3b70..02f1d8087 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveE.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveE.cpp
@@ -13,6 +13,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 #include "WarpX.H"
@@ -83,7 +84,7 @@ void FiniteDifferenceSolver::EvolveE (
 
 #endif
     } else {
-        amrex::Abort("EvolveE: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveE: Unknown algorithm"));
     }
 
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveECTRho.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveECTRho.cpp
index fd70c0552..59a247921 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveECTRho.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveECTRho.cpp
@@ -13,6 +13,7 @@
 #else
 #   include "FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 #include "WarpX.H"
@@ -73,7 +74,8 @@ void FiniteDifferenceSolver::EvolveRhoCartesianECT (
 #ifdef AMREX_USE_EB
 
 #if !(defined(WARPX_DIM_3D) || defined(WARPX_DIM_XZ))
-    amrex::Abort("EvolveRhoCartesianECT: Embedded Boundaries are only implemented in 3D and XZ");
+    amrex::Abort(Utils::TextMsg::Err(
+        "EvolveRhoCartesianECT: Embedded Boundaries are only implemented in 3D and XZ"));
 #endif
 
     amrex::LayoutData<amrex::Real>* cost = WarpX::getCosts(lev);
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveEPML.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveEPML.cpp
index 8258ceb4b..e01d813ff 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveEPML.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveEPML.cpp
@@ -16,6 +16,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 
@@ -55,7 +56,8 @@ void FiniteDifferenceSolver::EvolveEPML (
    // but we compile code for each algorithm, using templates)
 #ifdef WARPX_DIM_RZ
     amrex::ignore_unused(Efield, Bfield, Jfield, Ffield, sigba, dt, pml_has_particles, edge_lengths);
-    amrex::Abort("PML are not implemented in cylindrical geometry.");
+    amrex::Abort(Utils::TextMsg::Err(
+        "PML are not implemented in cylindrical geometry."));
 #else
     if (m_do_nodal) {
 
@@ -73,7 +75,7 @@ void FiniteDifferenceSolver::EvolveEPML (
             Efield, Bfield, Jfield,  edge_lengths, Ffield, sigba, dt, pml_has_particles );
 
     } else {
-        amrex::Abort("EvolveEPML: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveEPML: Unknown algorithm"));
     }
 #endif
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveF.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveF.cpp
index f5bd3781f..ae5600dae 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveF.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveF.cpp
@@ -13,6 +13,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXConst.H"
 #ifdef WARPX_DIM_RZ
@@ -71,7 +72,7 @@ void FiniteDifferenceSolver::EvolveF (
 
 #endif
     } else {
-        amrex::Abort("EvolveF: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveF: Unknown algorithm"));
     }
 
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveFPML.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveFPML.cpp
index 79eed1efb..c1d88282e 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveFPML.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveFPML.cpp
@@ -14,6 +14,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 
 #include <AMReX.H>
@@ -47,7 +48,8 @@ void FiniteDifferenceSolver::EvolveFPML (
    // but we compile code for each algorithm, using templates)
 #ifdef WARPX_DIM_RZ
     amrex::ignore_unused(Ffield, Efield, dt);
-    amrex::Abort("PML are not implemented in cylindrical geometry.");
+    amrex::Abort(Utils::TextMsg::Err(
+        "PML are not implemented in cylindrical geometry."));
 #else
     if (m_do_nodal) {
 
@@ -62,7 +64,7 @@ void FiniteDifferenceSolver::EvolveFPML (
         EvolveFPMLCartesian <CartesianCKCAlgorithm> ( Ffield, Efield, dt );
 
     } else {
-        amrex::Abort("EvolveFPML: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveFPML: Unknown algorithm"));
     }
 #endif
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/EvolveG.cpp b/Source/FieldSolver/FiniteDifferenceSolver/EvolveG.cpp
index 0e9c383d9..3a705698b 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/EvolveG.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/EvolveG.cpp
@@ -14,6 +14,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 
 #include <AMReX.H>
@@ -60,7 +61,7 @@ void FiniteDifferenceSolver::EvolveG (
     }
     else
     {
-        amrex::Abort("EvolveG: unknown FDTD algorithm");
+        amrex::Abort(Utils::TextMsg::Err("EvolveG: unknown FDTD algorithm"));
     }
 #endif
 }
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.cpp b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.cpp
index cf6a603c7..f63028f50 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver.cpp
@@ -13,6 +13,7 @@
 #else
 #   include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/CylindricalYeeAlgorithm.H"
 #endif
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #ifdef WARPX_DIM_RZ
 #   include "WarpX.H"
@@ -57,7 +58,8 @@ FiniteDifferenceSolver::FiniteDifferenceSolver (
                               m_stencil_coefs_z.begin());
         amrex::Gpu::synchronize();
     } else {
-        amrex::Abort("FiniteDifferenceSolver: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err(
+            "FiniteDifferenceSolver: Unknown algorithm"));
     }
 #else
     if (do_nodal) {
@@ -76,7 +78,8 @@ FiniteDifferenceSolver::FiniteDifferenceSolver (
             m_h_stencil_coefs_x, m_h_stencil_coefs_y, m_h_stencil_coefs_z );
 
     } else {
-        amrex::Abort("FiniteDifferenceSolver: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err(
+            "FiniteDifferenceSolver: Unknown algorithm"));
     }
 
     m_stencil_coefs_x.resize(m_h_stencil_coefs_x.size());
diff --git a/Source/FieldSolver/FiniteDifferenceSolver/MacroscopicEvolveE.cpp b/Source/FieldSolver/FiniteDifferenceSolver/MacroscopicEvolveE.cpp
index bc9576cfd..4b117aad3 100644
--- a/Source/FieldSolver/FiniteDifferenceSolver/MacroscopicEvolveE.cpp
+++ b/Source/FieldSolver/FiniteDifferenceSolver/MacroscopicEvolveE.cpp
@@ -9,6 +9,7 @@
 #endif
 #include "MacroscopicProperties/MacroscopicProperties.H"
 #include "Utils/CoarsenIO.H"
+#include "Utils/TextMsg.H"
 #include "Utils/WarpXAlgorithmSelection.H"
 #include "Utils/WarpXUtil.H"
 #include "WarpX.H"
@@ -46,12 +47,14 @@ void FiniteDifferenceSolver::MacroscopicEvolveE (
    // but we compile code for each algorithm, using templates)
 #ifdef WARPX_DIM_RZ
     amrex::ignore_unused(Efield, Bfield, Jfield, edge_lengths, dt, macroscopic_properties);
-    amrex::Abort("currently macro E-push does not work for RZ");
+    amrex::Abort(Utils::TextMsg::Err(
+        "currently macro E-push does not work for RZ"));
 #else
-    if (m_do_nodal) {
-        amrex::Abort(" macro E-push does not work for nodal ");
+    WARPX_ALWAYS_ASSERT_WITH_MESSAGE(
+        !m_do_nodal, "macro E-push does not work for nodal");
 
-    } else if (m_fdtd_algo == MaxwellSolverAlgo::Yee) {
+
+    if (m_fdtd_algo == MaxwellSolverAlgo::Yee) {
 
         if (WarpX::macroscopic_solver_algo == MacroscopicSolverAlgo::LaxWendroff) {
 
@@ -83,7 +86,8 @@ void FiniteDifferenceSolver::MacroscopicEvolveE (
         }
 
     } else {
-        amrex::Abort("MacroscopicEvolveE: Unknown algorithm");
+        amrex::Abort(Utils::TextMsg::Err(
+            "MacroscopicEvolveE: Unknown algorithm"));
     }
 #endif