Merge pull request #82 from hpsim/typos

Typos

.github/workflows/typo_check.yml

@@ -0,0 +1,12 @@
+name: Test GitHub Action
+on: [pull_request]
+
+jobs:
+  run:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Check for typos
+      uses: crate-ci/typos@master
+

DevicePersistent/DevicePersistentBase/DevicePersistentBase.H

@@ -63,10 +63,10 @@ public:
  *
  * This class creates an unitialised Ginkgo array and copies the
  * shared ptr to the DevicePersistentBase. This will prevent it from
- * beeing deleted when leaving the scope.
+ * being deleted when leaving the scope.
  *
  * Additionally, for parallel runs it can be specified, whether the local,
- * global or both data should be persistant. Here are some usecase example
+ * global or both data should be persistent. Here are some usecase example
  * ldu_csr_mapping, local only
  * values, local and global persistent
  * row and col ptr only global persistent
@@ -125,7 +125,7 @@ public:
 
             // NOTE when objectRegistry is deleted delete for every pointer
             // owned by the registry is called
-            // TODO make shure isOwnedByRegistry returns true
+            // TODO make sure isOwnedByRegistry returns true
             TIME_WITH_FIELDNAME(verbose_, call_init, name_,
                                 auto po = new DevicePersistentBase<T>(
                                     IOobject(path, db), f.init());)

DevicePersistent/DevicePersistentVector/DevicePersistentVector.H

@@ -217,7 +217,7 @@ public:
         host_device_vector->operator=(*get_vector().get());
 
         // TODO why does it need its size
-        // repartitioner size should be suficient
+        // repartitioner size should be sufficient
         auto target_vector = dist_vec::create(
             exec_.get_ref_exec(), *comm.get(), gko::dim<2>{global_size, 1},
             gko::dim<2>{local_host_size, 1}, 1);

DevicePersistent/IOGlobalIndex/gkoGlobalIndex.H

@@ -116,7 +116,7 @@ public:
     /**
      * Initialize from local size.
      *
-     * Gets msgType and worlComm from Pstream and call 4 arguments init
+     * Gets msgType and worldComm from Pstream and call 4 arguments init
      */
     void init(const label localSize);
 

HostMatrix/HostMatrix.C

@@ -179,7 +179,7 @@ HostMatrixWrapper<MatrixType>::collect_local_interface_indices(
         const auto &face_cells{iface->interface().faceCells()};
         const label interface_size = face_cells.size();
 
-        // TODO make this a seperate specialized function
+        // TODO make this a separate specialized function
         label interface_ctr = 0;
         if (isA<cyclicLduInterface>(iface->interface())) {
             const cyclicLduInterface &pldui =
@@ -460,7 +460,7 @@ void HostMatrixWrapper<MatrixType>::init_local_sparsity_pattern(
 
                 // the copy rows are or equal
                 // in that case we need to check if the
-                // copy colums are lower
+                // copy columns are lower
                 if (rows_copy[current_idx_ctr] == interface_row &&
                     cols_copy[current_idx_ctr] > interface_col) {
                     return false;

HostMatrix/HostMatrix.H

@@ -161,7 +161,7 @@ public:
         // coeffs for internal cells
         const FieldField<Field, scalar> &interfaceIntCoeffs,
         // pointers to interfaces can be used to access concrete
-        // functions such as transfering indices, patch neighbours etc
+        // functions such as transferring indices, patch neighbours etc
         const lduInterfaceFieldPtrsList &interfaces,
         const dictionary &solverControls, const word &fieldName)
         : MatrixType::solver(fieldName, matrix, interfaceBouCoeffs,

StoppingCriterion/StoppingCriterion.H

@@ -119,7 +119,7 @@ class StoppingCriterion {
             gkomatrix->compute_column_vector_sum(res.get());
             res->scale(xAvg.get());
 #else
-            // if column vector sum is not availible use dot product
+            // if column vector sum is not available use dot product
             auto xAvg_vec = gko::share(dist_vec::create(
                 device_exec, x->get_communicator(), gko::dim<2>{global_size, 1},
                 gko::dim<2>{local_size, 1}));

_typos.toml

@@ -0,0 +1,5 @@
+[files]
+extend-exclude = ["third_party/*"]
+
+[default.extend-words]
+nd = "nd"

cmake/CTestScript.cmake

@@ -4,7 +4,7 @@
 #
 # Runs our tests through CTest, with support for Coverage or memory checking.
 #
-# This script provides a full CTest run whith result submission to Ginkgo's
+# This script provides a full CTest run with result submission to Ginkgo's
 # CDash dashboard. The supported runs are:
 # + With or without coverage, requires the gcov tool.
 # + With or without address sanitizers.

cmake/create_test.cmake

@@ -188,7 +188,7 @@ function(ginkgo_create_hip_test test_name)
     # Only `math` requires it so far, but it's much easier
     # to put these this way.
     ${GINKGO_HIP_THRUST_PATH}
-    # Only `exception_helpers` requires thess so far, but it's much easier
+    # Only `exception_helpers` requires this so far, but it's much easier
     # to put these this way.
     ${HIPBLAS_INCLUDE_DIRS}
     ${HIPSPARSE_INCLUDE_DIRS}

cmake/package_helpers.cmake

@@ -246,7 +246,7 @@ macro(ginkgo_find_package package_name target_list header_only)
       )
       set(_target_list ${target_list}) # CMake weirdness: target_list is not a
                                        # list anymore
-      # Count the number of elements in the list. Substract by one to iterate
+      # Count the number of elements in the list. Subtract by one to iterate
       # from 0 to the end.
       list(LENGTH _target_list _GKO_len1)
       math(EXPR _GKO_len2 "${_GKO_len1} - 1")

lduLduBase/lduLduBase.H

@@ -307,7 +307,7 @@ public:
 
         TIME_WITH_FIELDNAME(verbose_, copy_x_back, this->fieldName(),
                             dist_x.copy_back();)
-        auto bandwith_copy_back = sizeof(scalar) *
+        auto bandwidth_copy_back = sizeof(scalar) *
                                   partition.get_local_device_size() /
                                   delta_t_copy_x_back / 1000.0;
 
@@ -330,8 +330,8 @@ public:
             std::to_string(time_for_res_norm_eval) +
             std::string(" [mu s]\n\tTime per iteration and DOF: ") +
             std::to_string(time_per_iter_and_dof) + std::string(" [ns]") +
-            std::string("\n\tRetrieve results bandwith ") +
-            std::to_string(bandwith_copy_back) + std::string(" [GByte/s]");
+            std::string("\n\tRetrieve results bandwidth ") +
+            std::to_string(bandwidth_copy_back) + std::string(" [GByte/s]");
         MLOG_0(verbose_, msg)
 
         return solverPerf;