Spellcheck (#27)

* spellcheck
raptor-library · Dec 23, 2023 · 0a21b1c · 0a21b1c
1 parent a34610b
commit 0a21b1c
Show file tree

Hide file tree

Showing 19 changed files with 36 additions and 21 deletions.
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,15 @@
+[default.extend-words]
+preconditioner = "preconditioner"
+MIS = "MIS"
+Cleary = "Cleary"
+ser = "ser"
+[default.extend-identifiers]
+hypre_BoomerAMGCoarseParms = "hypre_BoomerAMGCoarseParms"
+[default]
+extend-ignore-identifiers-re = [
+"sort_2nd",
+".*_fiter",
+"SCOTCH_.*",
+]
+[type.cpp]
+extend-glob = ["*.h"]
diff --git a/cmake/FindPETSc.cmake b/cmake/FindPETSc.cmake
@@ -36,7 +36,7 @@ if(NOT PETSc_FIND_COMPONENTS)
     set(PETSC_LANGUAGE_BINDINGS "CXX")
   endif ()
 else()
-  # Right now, this is designed for compatability with the --with-clanguage option, so
+  # Right now, this is designed for compatibility with the --with-clanguage option, so
   # only allow one item in the components list.
   list(LENGTH ${PETSc_FIND_COMPONENTS} components_length)
   if(${components_length} GREATER 1)

diff --git a/cmake/FindPackageMultipass.cmake b/cmake/FindPackageMultipass.cmake
@@ -27,7 +27,7 @@
 #  variable is either C or CXX indicating which compiler the test should
 #  use.
 # MULTIPASS_C_SOURCE_RUNS (Name INCLUDES LIBRARIES SOURCE RUNS)
-#  DEPRECATED! This is only included for backwards compatability. Use
+#  DEPRECATED! This is only included for backwards compatibility. Use
 #  the more general MULTIPASS_SOURCE_RUNS instead.
 #  Always runs the given test, use this when you need to re-run tests
 #  because parent variables have made old cache entries stale.

diff --git a/cmake/ResolveCompilerPaths.cmake b/cmake/ResolveCompilerPaths.cmake
@@ -78,7 +78,7 @@ macro (RESOLVE_LIBRARIES LIBS LINK_LINE)
     endif (token MATCHES "-L([^\" ]+|\"[^\"]+\")")
   endforeach (token)
   set (_lib "NOTFOUND" CACHE INTERNAL "Scratch variable" FORCE)
-  # only the LAST occurence of each library is required since there should be no circular dependencies
+  # only the LAST occurrence of each library is required since there should be no circular dependencies
   if (_libs_found)
     list (REVERSE _libs_found)
     list (REMOVE_DUPLICATES _libs_found)

diff --git a/docs/logo/README.md b/docs/logo/README.md
@@ -1,2 +1,2 @@
 The original image is from https://pixabay.com/en/hawk-silhouette-eagle-bird-of-prey-24009/
-Retreived 10/2017, with CC0 license.
+Retrieved 10/2017, with CC0 license.
diff --git a/docs/logo/logo-gen.ipynb b/docs/logo/logo-gen.ipynb
@@ -64,7 +64,7 @@
     "xmax = I.shape[1]\n",
     "ymax = I.shape[0]\n",
     "\n",
-    "# blur, exand, then contract the image to smooth the lines\n",
+    "# blur, expand, then contract the image to smooth the lines\n",
     "blur=((3,3),1)\n",
     "erode=(3, 3)\n",
     "dilate=(5, 5)\n",

diff --git a/examples/benchmark_nek5000.cpp b/examples/benchmark_nek5000.cpp
@@ -22,7 +22,7 @@ int main(int argc, char *argv[])
     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
     MPI_Comm_size(MPI_COMM_WORLD, &num_procs);
 
-    // Set HYPRE AMG Perferences
+    // Set HYPRE AMG Preferences
     int coarsen_type = 0; // CLJP = 0, Falgout = 6
     int interp_type = 0; // Classical 0, Direct 3 
     double strong_threshold = 0.25;

diff --git a/examples/profile_amg.cpp b/examples/profile_amg.cpp
@@ -268,7 +268,7 @@ int main(int argc, char* argv[])
         // Form Coarse Grid Operator (P^TAP)
         for (int test = 0; test < n_tests; test++)
         {
-            // Time Ac Contruction
+            // Time Ac Construction
             MPI_Barrier(MPI_COMM_WORLD);
             t0 = MPI_Wtime();
             hypre_BoomerAMGBuildCoarseOperatorKT(P, A_h, P, keepTranspose, &Ac);
@@ -399,7 +399,7 @@ int main(int argc, char* argv[])
         // Form Coarse Grid Operator (P^TAP)
         for (int test = 0; test < n_tests; test++)
         {
-            // Time Ac Contruction
+            // Time Ac Construction
             MPI_Barrier(MPI_COMM_WORLD);
             t0 = MPI_Wtime();
             hypre_BoomerAMGBuildCoarseOperatorKT(P, A_array[i], P, keepTranspose, &Ac);

diff --git a/raptor/core/matrix.cpp b/raptor/core/matrix.cpp
@@ -871,7 +871,7 @@ void BSCMatrix::move_diag()
 /**************************************************************
 *****   Matrix Removes Duplicates
 **************************************************************
-***** Goes thorugh each sorted row, and removes duplicate
+***** Goes through each sorted row, and removes duplicate
 ***** entries, summing associated values
 **************************************************************/
 template <typename T>

diff --git a/raptor/core/par_matrix.hpp b/raptor/core/par_matrix.hpp
@@ -48,7 +48,7 @@
  ***** 
  ***** Methods
  ***** -------
- ***** initalize_partition()
+ ***** initialize_partition()
  *****    Determines which rows are local to process and which 
  *****    columns fall in local block 
  ***** add_value()

diff --git a/raptor/core/par_vector.hpp b/raptor/core/par_vector.hpp
@@ -70,7 +70,7 @@ namespace raptor
         /**************************************************************
         *****   ParVector Class Constructor
         **************************************************************
-        ***** Creates an empy ParVector (local_n = 0)
+        ***** Creates an empty ParVector (local_n = 0)
         **************************************************************/
         ParVector()
         {

diff --git a/raptor/external/tests/test_petsc_wrapper.cpp b/raptor/external/tests/test_petsc_wrapper.cpp
@@ -53,7 +53,7 @@ TEST(PetscWrapperTest, TestsInExternal)
     KSPGetResidualNorm(ksp, &rnorm);
     ASSERT_LE(rnorm, 1e-05); 
 
-    // Detroy RAPtor Preconditioner
+    // Destroy RAPtor Preconditioner
     VecDestroy(&rhs);
     VecDestroy(&sol);
     MatDestroy(&pmat);

diff --git a/raptor/gallery/matrix_market.hpp b/raptor/gallery/matrix_market.hpp
@@ -31,7 +31,7 @@ int mm_write_mtx_crd_size(FILE *f, int M, int N, int nz);
 int mm_write_mtx_array_size(FILE *f, int M, int N);
 
 
-/********************* MM_typecode query fucntions ***************************/
+/********************* MM_typecode query functions ***************************/
 
 #define mm_is_matrix(typecode)	((typecode)[0]=='M')
 
@@ -53,7 +53,7 @@ int mm_write_mtx_array_size(FILE *f, int M, int N);
 int mm_is_valid(MM_typecode matcode);		/* too complex for a macro */
 
 
-/********************* MM_typecode modify fucntions ***************************/
+/********************* MM_typecode modify functions ***************************/
 
 #define mm_set_matrix(typecode)	((*typecode)[0]='M')
 #define mm_set_coordinate(typecode)	((*typecode)[1]='C')
@@ -94,7 +94,7 @@ int mm_is_valid(MM_typecode matcode);		/* too complex for a macro */
 
    MM_matrix_typecode: 4-character sequence
 
-				    ojbect 		sparse/   	data        storage 
+				    object 		sparse/   	data        storage 
 						  		dense     	type        scheme
 
    string position:	 [0]        [1]			[2]         [3]

diff --git a/raptor/gallery/tests/test_stencil.cpp b/raptor/gallery/tests/test_stencil.cpp
@@ -26,7 +26,7 @@ TEST(StencilTest, TestsInGallery)
     std::vector<double> A_python(16 * 16, 0);
     std::vector<double> A_dense(16 * 16, 0);
 
-    // Add values ot A_python
+    // Add values of A_python
     int rows[100] = {0, 0, 0, 0, 
         1, 1, 1, 1, 1, 1, 
         2, 2, 2, 2, 2, 2,

diff --git a/raptor/krylov/partial_inner.cpp b/raptor/krylov/partial_inner.cpp
@@ -183,7 +183,7 @@ void create_partial_inner_comm(RAPtor_MPI_Comm &inner_comm, RAPtor_MPI_Comm &roo
     procs_in_group = num_procs * frac;
     if (num_procs % 2) procs_in_group++;
 
-    // Split into contigous groups by color and get root for each group
+    // Split into contiguous groups by color and get root for each group
     my_inner_color = rank / procs_in_group;
     inner_root = my_inner_color * procs_in_group;
     if (rank == inner_root) my_root_color = 0;

diff --git a/raptor/multilevel/par_multilevel.hpp b/raptor/multilevel/par_multilevel.hpp
@@ -47,7 +47,7 @@
  *****      - Jacobi: weighted jacobi for both on and off proc
  *****      - SOR: weighted jacobi off_proc, SOR on_proc
  *****      - SSOR : weighted jacobi off_proc, SSOR on_proc
- ***** num_smooth_sweeps : int (defualt 1)
+ ***** num_smooth_sweeps : int (default 1)
  *****    Number of relaxation sweeps (both pre and post smoothing)
  *****    to be performed during each cycle of the AMG solve.
  ***** relax_weight : double

diff --git a/raptor/ruge_stuben/par_cf_splitting.cpp b/raptor/ruge_stuben/par_cf_splitting.cpp
@@ -678,7 +678,7 @@ void update_local_dist2_weights(const ParCSRMatrix* S,
             }
         }
 
-        // Go through each row i strongly conected to c, and see if any column
+        // Go through each row i strongly connected to c, and see if any column
         // in Si is also in c_dep_cache (and edge not already removed), reduce
         // weight and remove edge
         for (int j = start; j < end; j++)

diff --git a/raptor/util/linalg/external/parmetis_wrapper.hpp b/raptor/util/linalg/external/parmetis_wrapper.hpp
@@ -84,7 +84,7 @@ int* parmetis_partition(ParCSRMatrix* A)
     // Imbalance tolerance for each vertex weight
     // Array size ncon 
     // Perfect balance: 1
-    // Perfect imblance: nparts
+    // Perfect imbalance: nparts
     // Recommended: 1.05
     std::vector<float> ubvec(1, 1.05);
 

diff --git a/test_data/PetscBinaryIO.py b/test_data/PetscBinaryIO.py
@@ -316,7 +316,7 @@ def writeMatSparse(self, fh, mat):
 
     @decorate_with_conf
     def readMatDense(self, fh):
-        """Reads a PETSc Mat, returning a dense represention of the data, must be called after readObjectType()"""
+        """Reads a PETSc Mat, returning a dense representation of the data, must be called after readObjectType()"""
 
         try:
             M,N,nz = np.fromfile(fh, dtype=self._inttype, count=3)