From aaff267a621a75a5efb5e608f09384f7f4dde570 Mon Sep 17 00:00:00 2001 From: Gregor Olenik Date: Mon, 12 Jun 2023 09:37:58 +0200 Subject: [PATCH 1/4] check for typos --- .github/workflows/typo_check.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/workflows/typo_check.yml diff --git a/.github/workflows/typo_check.yml b/.github/workflows/typo_check.yml new file mode 100644 index 000000000..9aaeca573 --- /dev/null +++ b/.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 + From c4cb6c64092641826e4bf6a307c9e0db4f5186b6 Mon Sep 17 00:00:00 2001 From: Gregor Olenik Date: Mon, 12 Jun 2023 09:43:07 +0200 Subject: [PATCH 2/4] fix typos --- .../DevicePersistentBase/DevicePersistentBase.H | 6 +++--- cmake/create_test.cmake | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/DevicePersistent/DevicePersistentBase/DevicePersistentBase.H b/DevicePersistent/DevicePersistentBase/DevicePersistentBase.H index 6f2bfc56c..5a2d86385 100644 --- a/DevicePersistent/DevicePersistentBase/DevicePersistentBase.H +++ b/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( IOobject(path, db), f.init());) diff --git a/cmake/create_test.cmake b/cmake/create_test.cmake index 31c7220db..fbac887e6 100644 --- a/cmake/create_test.cmake +++ b/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} From e6d8d906a3200057f8593eb266d2a2bb4cd1e671 Mon Sep 17 00:00:00 2001 From: Gregor Olenik Date: Mon, 12 Jun 2023 09:48:30 +0200 Subject: [PATCH 3/4] fix typos --- .../DevicePersistentVector/DevicePersistentVector.H | 2 +- DevicePersistent/IOGlobalIndex/gkoGlobalIndex.H | 2 +- HostMatrix/HostMatrix.C | 4 ++-- HostMatrix/HostMatrix.H | 2 +- StoppingCriterion/StoppingCriterion.H | 2 +- cmake/CTestScript.cmake | 2 +- cmake/package_helpers.cmake | 2 +- lduLduBase/lduLduBase.H | 6 +++--- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/DevicePersistent/DevicePersistentVector/DevicePersistentVector.H b/DevicePersistent/DevicePersistentVector/DevicePersistentVector.H index 9d4b3f73a..6dbb924fa 100644 --- a/DevicePersistent/DevicePersistentVector/DevicePersistentVector.H +++ b/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); diff --git a/DevicePersistent/IOGlobalIndex/gkoGlobalIndex.H b/DevicePersistent/IOGlobalIndex/gkoGlobalIndex.H index 089655df9..40ef98172 100644 --- a/DevicePersistent/IOGlobalIndex/gkoGlobalIndex.H +++ b/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); diff --git a/HostMatrix/HostMatrix.C b/HostMatrix/HostMatrix.C index c4a881c5f..6ae338df8 100644 --- a/HostMatrix/HostMatrix.C +++ b/HostMatrix/HostMatrix.C @@ -179,7 +179,7 @@ HostMatrixWrapper::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(iface->interface())) { const cyclicLduInterface &pldui = @@ -460,7 +460,7 @@ void HostMatrixWrapper::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; diff --git a/HostMatrix/HostMatrix.H b/HostMatrix/HostMatrix.H index e104310f2..279d2a18d 100644 --- a/HostMatrix/HostMatrix.H +++ b/HostMatrix/HostMatrix.H @@ -161,7 +161,7 @@ public: // coeffs for internal cells const FieldField &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, diff --git a/StoppingCriterion/StoppingCriterion.H b/StoppingCriterion/StoppingCriterion.H index 411e71d01..cd8946a0b 100644 --- a/StoppingCriterion/StoppingCriterion.H +++ b/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})); diff --git a/cmake/CTestScript.cmake b/cmake/CTestScript.cmake index 61d53b044..81ff86625 100644 --- a/cmake/CTestScript.cmake +++ b/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. diff --git a/cmake/package_helpers.cmake b/cmake/package_helpers.cmake index de11251b3..5450510d0 100644 --- a/cmake/package_helpers.cmake +++ b/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") diff --git a/lduLduBase/lduLduBase.H b/lduLduBase/lduLduBase.H index f947b10c9..5b17b1944 100644 --- a/lduLduBase/lduLduBase.H +++ b/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; From b5f118e7f9c215fa12c88438e9f431fcfdbbfb05 Mon Sep 17 00:00:00 2001 From: Gregor Olenik Date: Mon, 12 Jun 2023 09:49:05 +0200 Subject: [PATCH 4/4] add config file --- _typos.toml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 _typos.toml diff --git a/_typos.toml b/_typos.toml new file mode 100644 index 000000000..5741cef6b --- /dev/null +++ b/_typos.toml @@ -0,0 +1,5 @@ +[files] +extend-exclude = ["third_party/*"] + +[default.extend-words] +nd = "nd"