Add spellchecking action (#865)

Co-authored-by: Dennis Ogiermann <termi-official@users.noreply.github.com>

Author: KnutAM

.github/workflows/SpellCheck.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v6
+      - name: Check spelling
+        uses: crate-ci/typos@v1.44.0

.typos.toml

@@ -0,0 +1,21 @@
+[files]
+extend-exclude = ["*.svg", "*.toml"]
+
+[default.extend-words]
+ue = "ue"
+ba = "ba"
+nd = "nd"
+
+[type.qrtables]
+extend-glob = ["**/gaussquad_*_table.jl", "**/generate_quadrature.jl"]
+
+[type.qrtables.extend-words]
+Methode = "Methode"
+Numer = "Numer"
+Secrest = "Secrest"
+
+[type.feintro]
+extend-glob = ["**/fe_intro.md"]
+
+[type.feintro.extend-words]
+Strang = "Strang"

CHANGELOG.md

@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
  - Support for directly assembling to `SparseMatrixCSR` (from `SparseMatricesCSR.jl`). ([#864])
  - Enhance `generate_grid` to support outputting line meshes embedded in two and three
-   spatial dimentions. ([#1122], [#1214])
+   spatial dimensions. ([#1122], [#1214])
 
 ### Fixes
  - Fix L2 projection of tensor fields on discontinuous interpolations. ([#1197], [#1198])
@@ -38,7 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Documentation updates
  - Extended assembly docs with information on how to support direct assembly into new matrix
    types. ([#864])
- - Add a list of reserach papers where Ferrite was used for numbeir simulations. Please add
+ - Add a list of research papers where Ferrite was used for simulations. Please add
    your paper! ([#1221])
  - Add section on global and local DoF numbering. ([#1089])
  - Fix some typos and grammar ([#1210], [#1224], [#1228])
@@ -687,7 +687,7 @@ poking into Ferrite internals:
  - Fix grid coloring for cell sets with 0 or 1 cells. ([#600])
 ### Other improvements
  - Documentation improvements:
-    - Simplications and clarifications to hyperelasticity example. ([#591])
+    - Simplifications and clarifications to hyperelasticity example. ([#591])
     - Remove duplicate docstring entry for `vtk_point_data`. ([#602])
     - Update documentation about initial conditions. ([#601], [#604])
 

CONTRIBUTING.md

@@ -85,6 +85,14 @@ configure pre-commit to run before each commit:
 pre-commit install
 ```
 
+### Spell-checking
+Ferrite uses [typos] for spell checking. If you have that installed,
+you run it locally with by running `typos` from the top level directory.
+To fix mistakes automatically, run `typos -w`, but be careful as e.g. names
+and words from other languages might be incorrectly corrected (which is why
+it is not included as a [pre-commit] hook). Exceptions should be added to
+`.typos.toml`.
+
 [documenter]: https://juliadocs.github.io/Documenter.jl/
 [first-contributions]: https://github.com/firstcontributions/first-contributions
 [gh-edit-files]: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository
@@ -101,3 +109,4 @@ pre-commit install
 [so-mre]: https://stackoverflow.com/help/minimal-reproducible-example
 [tim-doc]: https://youtu.be/ZpH1ry8qqfw
 [tim-git]: https://youtu.be/cquJ9kPkwR8
+[typos]: https://github.com/crate-ci/typos

docs/src/devdocs/interpolations.md

@@ -177,7 +177,7 @@ Ferrite.adjust_dofs_during_distribution(::QTI) = false
 ```
 
 Finally, our interpolation results in continuous function values across
-cell borders, but the derivatives are discontinous. Hence, it describes
+cell borders, but the derivatives are discontinuous. Hence, it describes
 a $H_1$ conformity,
 ```@example InterpolationExample
 Ferrite.conformity(::QTI) = Ferrite.H1Conformity()

docs/src/literate-gallery/topology_optimization.jl

@@ -58,7 +58,7 @@
 # \nabla \chi_p \cdot \textbf{n} = \frac{1}{\Delta h} (\chi_w - \chi_e) = 0
 # ```
 # from which follows $\chi_w = \chi_e$. Thus for boundary elements we can replace the value for the missing neighbor by the value of the opposite neighbor.
-# In order to find the corresponding neighbor elements, we will make use of Ferrites grid topology funcionalities.
+# In order to find the corresponding neighbor elements, we will make use of Ferrite's grid topology functionalities.
 #
 # ## Commented Program
 # We now solve the problem in Ferrite. What follows is a program spliced with comments.
@@ -188,7 +188,7 @@ function compute_densities(states, dh)
 end
 #md nothing # hide
 
-# For the Laplacian we need some neighboorhood information which is constant throughout the analysis so we compute it once and cache it.
+# For the Laplacian we need some neighborhood information which is constant throughout the analysis so we compute it once and cache it.
 # We iterate through each facet of each element,
 # obtaining the neighboring element by using the `getneighborhood` function. For boundary facets,
 # the function call will return an empty object. In that case we use the dictionary to instead find the opposite
@@ -218,7 +218,7 @@ function cache_neighborhood(dh, topology)
 end
 #md nothing # hide
 
-# Now we calculate the Laplacian using the previously cached neighboorhood information.
+# Now we calculate the Laplacian using the previously cached neighborhood information.
 function approximate_laplacian(nbgs, χn, Δh)
     ∇²χ = zeros(length(nbgs))
     for i in 1:length(nbgs)
@@ -290,13 +290,13 @@ end
 # Finally, we put everything together to update the density. The loop ensures the stability of the
 # updated solution.
 
-function update_density(dh, states, mp, ρ, neighboorhoods, Δh)
+function update_density(dh, states, mp, ρ, neighborhoods, Δh)
     n_j = Int(ceil(6 * mp.β / (mp.η * Δh^2))) # iterations needed for stability
     χn = compute_densities(states, dh) # old density field
     χn1 = zeros(length(χn))
 
     for j in 1:n_j
-        ∇²χ = approximate_laplacian(neighboorhoods, χn, Δh) # Laplacian
+        ∇²χ = approximate_laplacian(neighborhoods, χn, Δh) # Laplacian
         pΨ = compute_driving_forces(states, mp, dh, χn) # driving forces
         p_Ω = compute_average_driving_force(mp, pΨ, χn) # average driving force
 
@@ -442,7 +442,7 @@ function topopt(ra, ρ, n, filename; output = :false)
     conv = :false
 
     topology = ExclusiveTopology(grid)
-    neighboorhoods = cache_neighborhood(dh, topology)
+    neighborhoods = cache_neighborhood(dh, topology)
 
     ## Newton-Raphson loop
     NEWTON_TOL = 1.0e-8
@@ -496,7 +496,7 @@ function topopt(ra, ρ, n, filename; output = :false)
         end
 
         ## update density
-        χ = update_density(dh, states, mp, ρ, neighboorhoods, Δh)
+        χ = update_density(dh, states, mp, ρ, neighborhoods, Δh)
 
         ## update old displacement, density and compliance
         un .= u

docs/src/literate-howto/postprocessing.jl

@@ -17,7 +17,7 @@
 # different ways. Ferrite provides several tools to facilitate these tasks:
 #
 #  - L2 projection of (discrete) data onto FE interpolations using the `L2Projector`
-#  - Evalutation of fields (solutions, projections, etc) at arbitrary, user-defined, points
+#  - Evaluation of fields (solutions, projections, etc) at arbitrary, user-defined, points
 #    using the `PointEvalHandler`
 #  - Builtin functionality for exporting data (solutions, cell data, projections, etc) to
 #    the VTK format
@@ -30,7 +30,7 @@
 # domain.
 
 # !!! warning "Custom visualization"
-#     A common assumption is that the numbering of degrees of freedom matche the numbering
+#     A common assumption is that the numbering of degrees of freedom matches the numbering
 #     of the nodes in the grid. This is *NOT* the case in Ferrite. If the available tools
 #     don't suit your needs and you decide to "roll your own" visualization you need to be
 #     aware of this and take it into account. For the specific case of evaluating the

docs/src/literate-howto/threaded_assembly.jl

@@ -29,7 +29,7 @@
 #       commutative.
 #     - **Assembler task**: By using a designated task for the assembling we (obviously)
 #       ensure that only a single task assembles. The worker tasks (the tasks computing the
-#       element contributions) would then hand off their results to the assemly task. This
+#       element contributions) would then hand off their results to the assembly task. This
 #       can be a useful approach if computing the element contributions is much slower than
 #       the assembly -- otherwise the assembler task can't keep up with the worker tasks.
 #       There might also be some extra overhead because of task switching in the scheduler.
@@ -207,7 +207,7 @@ nothing # hide
 #     For a different problem setup where some cells might take longer to process (perhaps
 #     they experience plastic deformation and we need to solve a local problem) we might
 #     benefit from load balancing. The `DynamicScheduler` can be used also for load
-#     balancing by specifiying `nchunks` or `chunksize`. However, the `DynamicScheduler`
+#     balancing by specifying `nchunks` or `chunksize`. However, the `DynamicScheduler`
 #     will always spawn `nchunks` tasks which can become costly since we are allocating
 #     scratch data for every task. To limit the number of tasks, while allowing for more
 #     than `ntasks` chunks, we can use the `GreedyScheduler` *with chunking*. For example,

docs/src/literate-tutorials/computational_homogenization.jl

@@ -158,7 +158,7 @@
 # \bar{\boldsymbol{\varepsilon}} = \begin{pmatrix}0 & 0.5\\ 0.5 & 0\end{pmatrix}
 # ```
 #
-# as the input to the RVE problem. When the sensitivies are solved we can compute the
+# as the input to the RVE problem. When the sensitivities are solved we can compute the
 # entries of the homogenized stiffness as follows
 #
 # ```math
@@ -288,7 +288,7 @@ Em = SymmetricTensor{4, 2}(
 Ei = 10 * Em;
 
 # As mentioned above, in order to compute the apparent/homogenized stiffness we will solve
-# the problem repeatedly with different macroscale strain tensors to compute the sensitvity
+# the problem repeatedly with different macroscale strain tensors to compute the sensitivity
 # of the homogenized stress, ``\bar{\boldsymbol{\sigma}}``, w.r.t. the macroscopic strain,
 # ``\bar{\boldsymbol{\varepsilon}}``. The corresponding unit strains are defined below,
 # and will result in three different right-hand-sides:

docs/src/literate-tutorials/plasticity.jl

@@ -296,7 +296,7 @@ function solve()
 
     ## Newton-Raphson loop
     NEWTON_TOL = 1 # 1 N
-    print("\n Starting Netwon iterations:\n")
+    print("\n Starting Newton iterations:\n")
 
     for timestep in 1:n_timesteps
         t = timestep # actual time (used for evaluating d-bndc)