From 9f0414a808f0252450053051c14dfb3687197490 Mon Sep 17 00:00:00 2001
From: Oliver Sander <oliver.sander@tu-dresden.de>
Date: Thu, 22 Dec 2022 21:50:30 +0100
Subject: [PATCH] Make CI run 'codespell'

---
 .gitlab-ci.yml                                         | 10 ++++++++++
 .../assemblers/mooneyrivlinfunctionalassembler.hh      |  2 +-
 .../assemblers/mooneyrivlinoperatorassembler.hh        |  2 +-
 dune/elasticity/common/trustregionsolver.cc            |  4 ++--
 dune/elasticity/materials/mooneyrivlinmaterial.hh      |  4 ++--
 5 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 1b4af5d..e2cdbbb 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -43,3 +43,13 @@ dune:git  clang  C++17:
 dune:git  gcc-8  C++17:
   image: registry.dune-project.org/docker/ci/dune:git-debian-10-gcc-8-17
   script: duneci-standard-test
+
+# Check for spelling mistakes in text
+code-spelling-check:
+  stage: .pre
+  # Avoid the global 'before_script'
+  before_script: ""
+  image: registry.dune-project.org/docker/ci/debian:11
+  script:
+  - codespell
+    --ignore-words-list afe,tre
diff --git a/dune/elasticity/assemblers/mooneyrivlinfunctionalassembler.hh b/dune/elasticity/assemblers/mooneyrivlinfunctionalassembler.hh
index 733b0da..483d234 100644
--- a/dune/elasticity/assemblers/mooneyrivlinfunctionalassembler.hh
+++ b/dune/elasticity/assemblers/mooneyrivlinfunctionalassembler.hh
@@ -23,7 +23,7 @@
  *      - \f$tr \f$: the trace operator
  *      - \f$J\f$ the determinant of the deformation gradient
  *      - \f$\a\f$,...,\f$\e\f$ material parameters
- *      - \f$k\f$ controlls orientation preservation (k \approx \floor(1/(1-2nu) -1))
+ *      - \f$k\f$ controls orientation preservation (k \approx \floor(1/(1-2nu) -1))
 */
 template <class GridType, class TrialLocalFE>
 class MooneyRivlinFunctionalAssembler :
diff --git a/dune/elasticity/assemblers/mooneyrivlinoperatorassembler.hh b/dune/elasticity/assemblers/mooneyrivlinoperatorassembler.hh
index 43f7eaf..162b498 100644
--- a/dune/elasticity/assemblers/mooneyrivlinoperatorassembler.hh
+++ b/dune/elasticity/assemblers/mooneyrivlinoperatorassembler.hh
@@ -26,7 +26,7 @@
  *      - \f$tr \f$: the trace operator
  *      - \f$J\f$ the determinant of the deformation gradient
  *      - \f$\a\f$,...,\f$\e\f$ material parameters
- *      - \f$k\f$ controlls orientation preservation (k \approx \floor(1/(1-2nu) -1))
+ *      - \f$k\f$ controls orientation preservation (k \approx \floor(1/(1-2nu) -1))
 */
 template <class GridType, class TrialLocalFE, class AnsatzLocalFE>
 class MooneyRivlinOperatorAssembler
diff --git a/dune/elasticity/common/trustregionsolver.cc b/dune/elasticity/common/trustregionsolver.cc
index a5316cd..7e9fb98 100644
--- a/dune/elasticity/common/trustregionsolver.cc
+++ b/dune/elasticity/common/trustregionsolver.cc
@@ -294,7 +294,7 @@ setup(const typename BasisType::GridView::Grid& grid,
 
     // Here we set up the restriction of the leaf grid space into the leaf grid P1/Q1 space
     // TODO: IIRC that move to P1Basis was only implemented because I didn't have general
-    // prolongation operators between arbitratry FE spaces.
+    // prolongation operators between arbitrary FE spaces.
     if (not isP1Basis)
     {
       TransferOperatorType pkToP1TransferMatrix;
@@ -605,7 +605,7 @@ void TrustRegionSolver<BasisType,VectorType>::solve()
 
                 if (energy >= oldEnergy) {
                     if (this->verbosity_ == NumProc::FULL and rank==0)
-                        printf("Richtung ist keine Abstiegsrichtung!\n");
+                        printf("Direction is not a descent direction!\n");
                 }
 
                 if (energy >= oldEnergy && (std::fabs(relativeFunctionalDecrease) < 1e-9 || std::fabs(relativeModelDecrease) < 1e-9)) {
diff --git a/dune/elasticity/materials/mooneyrivlinmaterial.hh b/dune/elasticity/materials/mooneyrivlinmaterial.hh
index a1e51d2..0a92d31 100644
--- a/dune/elasticity/materials/mooneyrivlinmaterial.hh
+++ b/dune/elasticity/materials/mooneyrivlinmaterial.hh
@@ -15,7 +15,7 @@
 
 #include <dune/matrix-vector/addtodiagonal.hh>
 
-#warning Mooney-Rivlin Might not work properly yet
+#warning Mooney-Rivlin might not work properly yet
 
 /** \brief Class representing a hyperelastic Mooney-Rivlin material.
  *
@@ -35,7 +35,7 @@
  *
  *  with
  *      \f$\gamma(J)$:= dJ^2 + e J^-k,  k>=2\f
- *      \f$k\f$ controlls orientation preservation (k \approx \floor(1/(1-2nu) -1))
+ *      \f$k\f$ controls orientation preservation (k \approx \floor(1/(1-2nu) -1))
  */
 template <class Basis>
 class MooneyRivlinMaterial : public Material<Basis>,
-- 
GitLab