Adjust comments: fix spelling and end-of-line punctuation.

Author: phdum-a

palace/drivers/drivensolver.cpp

@@ -130,7 +130,7 @@ ErrorIndicator DrivenSolver::SweepUniform(SpaceOperator &space_op, int n_step, i
     // Switch paraview subfolders: one for each excitation, if nr_excitations > 1.
     post_op.InitializeParaviewDataCollection(excitation_idx);
 
-    // Frequency loop
+    // Frequency loop.
     double omega = omega0;
     for (int step = step0; step < n_step; step++, omega += delta_omega)
     {
@@ -139,7 +139,7 @@ ErrorIndicator DrivenSolver::SweepUniform(SpaceOperator &space_op, int n_step, i
                  iodata.units.Dimensionalize<Units::ValueType::FREQUENCY>(omega),
                  Timer::Duration(Timer::Now() - t0).count());
 
-      // Assemble matrices: skip if already done (first excitation & first freq point)
+      // Assemble matrices: skip if already done (first excitation & first freq point).
       if (!first_iter_set)
       {
         // Update frequency-dependent excitation and operators.
@@ -152,7 +152,7 @@ ErrorIndicator DrivenSolver::SweepUniform(SpaceOperator &space_op, int n_step, i
         ksp.SetOperators(*A, *P);
       }
       first_iter_set = false;
-      // Solve linear system
+      // Solve linear system.
       space_op.GetExcitationVector(excitation_idx, omega, RHS);
       Mpi::Print("\n");
       ksp.Mult(RHS, E);
@@ -181,7 +181,7 @@ ErrorIndicator DrivenSolver::SweepUniform(SpaceOperator &space_op, int n_step, i
       Mpi::Print(" Updating solution error estimates\n");
       estimator.AddErrorIndicator(E, B, total_domain_energy, indicator);
     }
-    // Final postprocessing & printing
+    // Final postprocessing & printing.
     BlockTimer bt0(Timer::POSTPRO);
     SaveMetadata(ksp);
   }
@@ -206,7 +206,7 @@ ErrorIndicator DrivenSolver::SweepAdaptive(SpaceOperator &space_op, int n_step,
   {
     max_size_per_excitation = 20;  // Default value
   }
-  // Maximum size — no more than nr steps needed
+  // Maximum size — no more than nr steps needed.
   max_size_per_excitation = std::min(max_size_per_excitation, (n_step - step0));
 
   // Allocate negative curl matrix for postprocessing the B-field and vectors for the
@@ -278,13 +278,13 @@ ErrorIndicator DrivenSolver::SweepAdaptive(SpaceOperator &space_op, int n_step,
       // B = -1/(iω) ∇ x E + 1/ω kp x E
       floquet_corr->AddMult(E, B, 1.0 / omega);
     }
-    // Debug option to print prom samples fields to paraview file
+    // Debug option to print prom samples fields to paraview file.
     std::optional<std::pair<int, double>> debug_print_paraview_opt = {};
     if constexpr (debug_prom_paraview)
     {
       // Paraview times are printed as excitation * padding + freq with padding gives enough
       // space for f_max + 1, e.g. if f_max = 102 GHz, then we get time n0fff where n is the
-      // excitation index and fff is the frequency
+      // excitation index and fff is the frequency.
       double excitation_padding =
           std::pow(10.0, 3.0 + static_cast<int>(std::log10(iodata.solver.driven.max_f)));
       auto freq = iodata.units.Dimensionalize<Units::ValueType::FREQUENCY>(omega);
@@ -299,7 +299,7 @@ ErrorIndicator DrivenSolver::SweepAdaptive(SpaceOperator &space_op, int n_step,
     estimator.AddErrorIndicator(E, B, total_domain_energy, indicator);
   };
 
-  // Loop excitations to add to PROM
+  // Loop excitations to add to PROM.
   auto print_counter_excitation_prom = 0;  // 1 based indexing; will increment at start
   for (const auto &[excitation_idx, spec] : excitation_helper.excitations)
   {
@@ -386,7 +386,7 @@ ErrorIndicator DrivenSolver::SweepAdaptive(SpaceOperator &space_op, int n_step,
     // Switch paraview subfolders: one for each excitation, if nr_excitations > 1.
     post_op.InitializeParaviewDataCollection(excitation_idx);
 
-    // Frequency loop
+    // Frequency loop.
     double omega = omega0;
     for (int step = step0; step < n_step; step++, omega += delta_omega)
     {
@@ -414,7 +414,7 @@ ErrorIndicator DrivenSolver::SweepAdaptive(SpaceOperator &space_op, int n_step,
       }
       post_op.MeasureAndPrintAll(excitation_idx, step, E, B, omega);
     }
-    // Final postprocessing & printing: no change to indicator since prom
+    // Final postprocessing & printing: no change to indicator since these are in PROM.
     BlockTimer bt0(Timer::POSTPRO);
     SaveMetadata(prom_op.GetLinearSolver());
   }

palace/drivers/electrostaticsolver.cpp

@@ -159,7 +159,7 @@ void ElectrostaticSolver::PostprocessTerminals(
     for (const auto &[idx2, data2] : terminal_sources)
     {
       output.table.insert(format("i2{}", idx2), format("{}[i][{}] {}", name, idx2, unit));
-      // Use the fact that iterator over i and j is the same span
+      // Use the fact that iterator over i and j is the same span.
       output.table["i"] << idx2;
 
       auto &col = output.table[format("i2{}", idx2)];

palace/drivers/magnetostaticsolver.cpp

@@ -164,7 +164,7 @@ void MagnetostaticSolver::PostprocessTerminals(
     for (const auto &[idx2, data2] : surf_j_op)
     {
       output.table.insert(format("i2{}", idx2), format("{}[i][{}] {}", name, idx2, unit));
-      // Use the fact that iterator over i and j is the same span
+      // Use the fact that iterator over i and j is the same span.
       output.table["i"] << idx2;
 
       auto &col = output.table[format("i2{}", idx2)];

palace/drivers/transientsolver.cpp

@@ -93,7 +93,7 @@ TransientSolver::Solve(const std::vector<std::unique_ptr<Mesh>> &mesh) const
     Mpi::Print(" Updating solution error estimates\n");
     estimator.AddErrorIndicator(E, B, total_domain_energy, indicator);
   }
-  // Final postprocessing & printing
+  // Final postprocessing & printing.
   BlockTimer bt1(Timer::POSTPRO);
   time_op.PrintStats();
   SaveMetadata(time_op.GetLinearSolver());

palace/fem/coefficient.hpp

@@ -33,7 +33,7 @@ class BdrGridFunctionCoefficient
 {
 protected:
   // XX TODO: For thread-safety (multiple threads evaluating a coefficient simultaneously),
-  //          the FET, FET.Elem1, and FET.Elem2 objects cannot be shared
+  //          the FET, FET.Elem1, and FET.Elem2 objects cannot be shared.
   const mfem::ParMesh &mesh;
   mfem::FaceElementTransformations FET;
   mfem::IsoparametricTransformation T1, T2;

palace/fem/libceed/basis.cpp

@@ -91,7 +91,7 @@ void InitCeedInterpolatorBasis(const mfem::FiniteElement &trial_fe,
                                const mfem::FiniteElement &test_fe, CeedInt trial_num_comp,
                                CeedInt test_num_comp, Ceed ceed, CeedBasis *basis)
 {
-  // Basis projection operator using libCEED
+  // Basis projection operator using libCEED.
   CeedBasis trial_basis, test_basis;
   const int P = std::max(trial_fe.GetDof(), test_fe.GetDof()), ir_order_max = 100;
   int ir_order = std::max(trial_fe.GetOrder(), test_fe.GetOrder());
@@ -128,25 +128,25 @@ void InitMfemInterpolatorBasis(const mfem::FiniteElement &trial_fe,
   dummy.SetIdentityTransformation(trial_fe.GetGeomType());
   if (trial_fe.GetMapType() == test_fe.GetMapType())
   {
-    // Prolongation
+    // Prolongation.
     test_fe.GetTransferMatrix(trial_fe, dummy, Bt);
   }
   else if (trial_fe.GetMapType() == mfem::FiniteElement::VALUE &&
            test_fe.GetMapType() == mfem::FiniteElement::H_CURL)
   {
-    // Discrete gradient interpolator
+    // Discrete gradient interpolator.
     test_fe.ProjectGrad(trial_fe, dummy, Bt);
   }
   else if (trial_fe.GetMapType() == mfem::FiniteElement::H_CURL &&
            test_fe.GetMapType() == mfem::FiniteElement::H_DIV)
   {
-    // Discrete curl interpolator
+    // Discrete curl interpolator.
     test_fe.ProjectCurl(trial_fe, dummy, Bt);
   }
   else if (trial_fe.GetMapType() == mfem::FiniteElement::H_DIV &&
            test_fe.GetMapType() == mfem::FiniteElement::INTEGRAL)
   {
-    // Discrete divergence interpolator
+    // Discrete divergence interpolator.
     test_fe.ProjectDiv(trial_fe, dummy, Bt);
   }
   else

palace/fem/libceed/restriction.cpp

@@ -25,7 +25,7 @@ mfem::Array<int> GetFaceDofsFromAdjacentElement(const mfem::FiniteElementSpace &
                                                 mfem::DofTransformation &dof_trans,
                                                 const int P, const int e)
 {
-  // Get coordinates of face dofs
+  // Get coordinates of face dofs.
   int elem_id, face_info;
   fespace.GetMesh()->GetBdrElementAdjacentElement(e, elem_id, face_info);
   mfem::Geometry::Type face_geom = fespace.GetMesh()->GetBdrElementGeometry(e);
@@ -48,13 +48,13 @@ mfem::Array<int> GetFaceDofsFromAdjacentElement(const mfem::FiniteElementSpace &
   mfem::DenseMatrix face_pm;
   fespace.GetMesh()->GetNodes()->GetVectorValues(Loc1.Transf, face_ir, face_pm);
 
-  // Get coordinates of element dofs
+  // Get coordinates of element dofs.
   mfem::DenseMatrix elem_pm;
   const mfem::FiniteElement *fe_elem = fespace.GetFE(elem_id);
   mfem::ElementTransformation *T = fespace.GetMesh()->GetElementTransformation(elem_id);
   T->Transform(fe_elem->GetNodes(), elem_pm);
 
-  // Find the dofs
+  // Find the dofs.
   double tol = 1E-5;
   mfem::Array<int> elem_dofs, dofs(P);
   fespace.GetElementDofs(elem_id, elem_dofs, dof_trans);

palace/fem/multigrid.hpp

@@ -101,7 +101,7 @@ inline FiniteElementSpaceHierarchy ConstructFiniteElementSpaceHierarchy(
                                                            dbc_tdof_lists->emplace_back());
   }
 
-  // h-refinement
+  // h-refinement.
   for (std::size_t l = coarse_mesh_l + 1; l < mesh.size(); l++)
   {
     fespaces.AddLevel(std::make_unique<FiniteElementSpace>(*mesh[l], fecs[0].get()));
@@ -112,7 +112,7 @@ inline FiniteElementSpaceHierarchy ConstructFiniteElementSpaceHierarchy(
     }
   }
 
-  // p-refinement
+  // p-refinement.
   for (std::size_t l = 1; l < fecs.size(); l++)
   {
     fespaces.AddLevel(std::make_unique<FiniteElementSpace>(*mesh.back(), fecs[l].get()));

palace/linalg/arpack.cpp

@@ -157,7 +157,7 @@ void CheckInfoEUPD(a_int info)
 namespace palace::arpack
 {
 
-// Base class methods
+// Base class methods.
 
 ArpackEigenvalueSolver::ArpackEigenvalueSolver(MPI_Comm comm, int print)
   : comm(comm), print(print)
@@ -485,7 +485,7 @@ void ArpackEigenvalueSolver::RescaleEigenvectors(int num_eig)
   }
 }
 
-// EPS specific methods
+// EPS specific methods.
 
 ArpackEPSSolver::ArpackEPSSolver(MPI_Comm comm, int print)
   : ArpackEigenvalueSolver(comm, print)
@@ -637,7 +637,7 @@ double ArpackEPSSolver::GetBackwardScaling(std::complex<double> l) const
   return normK + std::abs(l) * normM;
 }
 
-// PEP specific methods
+// PEP specific methods.
 
 ArpackPEPSolver::ArpackPEPSolver(MPI_Comm comm, int print)
   : ArpackEigenvalueSolver(comm, print)

palace/linalg/ksp.cpp

@@ -81,7 +81,7 @@ std::unique_ptr<IterativeSolver<OperType>> ConfigureKrylovSolver(const IoData &i
           gmres->SetPrecSide(GmresSolverBase::PrecSide::RIGHT);
           break;
         case config::LinearSolverData::SideType::DEFAULT:
-          // Do nothing
+          // Do nothing.
           break;
       }
     }