Merge master

Author: termi-official

.github/workflows/Check.yml

@@ -27,7 +27,7 @@ jobs:
       - uses: julia-actions/cache@v2
       - uses: fredrikekre/runic-action@v1
         with:
-          version: "d9a27b9d6279a103fedc7202258207a7b7afe18c"
+          version: "1.4" # Keep version in sync with .pre-commit-config.yaml
 
   explicit-imports:
     runs-on: ubuntu-latest

.github/workflows/Test.yml

@@ -38,8 +38,10 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
         with:
           directories: 'src,ext'
-      - uses: codecov/codecov-action@v4
+      - uses: codecov/codecov-action@v5
         with:
-          file: lcov.info
+          files: lcov.info
+          plugins: noop
+          disable_search: true
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.pre-commit-config.yaml

@@ -10,6 +10,8 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: 'https://github.com/fredrikekre/runic-pre-commit'
-    rev: v1.0.0
+    rev: v2.0.1
     hooks:
       - id: runic
+        additional_dependencies:
+          - 'Runic@1.4' # Keep version in sync with .github/workflows/Check.yml

CHANGELOG.md

@@ -153,7 +153,7 @@ more discussion).
   - ip_function = Lagrange{2, RefTetrahedron, 2}()
   - ip_geometry = Lagrange{2, RefTetrahedron, 1}()
   - cv = CellScalarValues(qr, ip_function, ip_geometry)
-  + ip_function = Lagrange{2, RefTetrahedron, 2}()
+  + ip_function = Lagrange{RefTriangle, 2}()
   + cv = CellValues(qr, ip_function)
   ```
   and if you have quadratic (or higher order) elements in the grid you must now pass the
@@ -162,8 +162,8 @@ more discussion).
   qr = QuadratureRule(...)
   - ip_function = Lagrange{2, RefTetrahedron, 2}()
   - cv = CellScalarValues(qr, ip_function)
-  + ip_function = Lagrange{2, RefTetrahedron, 2}()
-  + ip_geometry = Lagrange{2, RefTetrahedron, 1}()
+  + ip_function = Lagrange{RefTriangle, 2}()
+  + ip_geometry = Lagrange{RefTriangle, 1}()
   + cv = CellValues(qr, ip_function, ip_geometry)
   ```
 

CONTRIBUTING.md

@@ -70,39 +70,21 @@ issues][open-issues].
 Remember to always include (when applicable): i) unit tests which exercises the new code,
 ii) documentation, iii) a note in the [CHANGELOG.md](CHANGELOG.md) file.
 
-### Code formatting
+### Code formatting and pre-commit hooks
 
-Ferrite uses [Runic.jl][runic] for code formatting. You can install Runic with the following
-command:
+Ferrite uses [Runic.jl][runic] for code formatting, see the [README][runic-readme] for
+details on how to install and run manually. Alternatively, you can use Ferrite's
+[pre-commit] setup to run the same formatting checks as the github actions,
+including Runic formatting.
 
-```shell
-julia --project=@runic -e 'using Pkg; Pkg.add(url = "https://github.com/fredrikekre/Runic.jl")'
-```
-
-and you can then run the formatter from the root of the repository with:
-
-```shell
-julia --project=@runic -e 'using Runic; exit(Runic.main(ARGS))' -- --inplace .
-```
-
-Refer to the Runic.jl [README][runic-readme] for more details (such as editor integration).
-
-
-### pre-commit hooks
-
-Ferrite uses [pre-commit] to run various checks (including Runic formatting). After
-installing pre-commit (refer to the [pre-commit installation
-instructions][pre-commit-install]) run the following from the root of the repository to
+After installing pre-commit (refer to the [pre-commit installation
+instructions][pre-commit-install]), run the following from the root of the repository to
 configure pre-commit to run before each commit:
 
 ```shell
 pre-commit install
 ```
 
-Note that this currently requires Runic.jl to be installed in the shared `@runic`
-environment according to the instructions above.
-
-
 [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

Project.toml

@@ -52,6 +52,7 @@ Metis = "2679e427-3c69-5b7f-982b-ece356f1e94b"
 NBInclude = "0db19996-df87-5ea3-a455-e3a50d440464"
 OhMyThreads = "67456a42-1dca-4109-a031-0a68de7e3ad5"
 ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
+QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 SparseMatricesCSR = "a0a7dd2c-ebf4-11e9-1f05-cf50bc540ca1"
@@ -60,4 +61,4 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TimerOutputs = "a759f4b9-e2f1-59dc-863e-4aeb61b1ea8f"
 
 [targets]
-test = ["BlockArrays", "Downloads", "FerriteGmsh", "ForwardDiff", "Gmsh", "IterativeSolvers", "Metis", "NBInclude", "OhMyThreads", "ProgressMeter", "Random", "SHA", "SparseMatricesCSR", "TaskLocalValues", "Test", "TimerOutputs", "Logging"]
+test = ["BlockArrays", "Downloads", "FerriteGmsh", "ForwardDiff", "Gmsh", "IterativeSolvers", "Metis", "NBInclude", "OhMyThreads", "ProgressMeter", "Random", "SHA", "SparseMatricesCSR", "TaskLocalValues", "Test", "TimerOutputs", "Logging", "QuadGK"]

README.md

@@ -4,8 +4,9 @@
   <img alt="Ferrite.jl logo." src="https://github.com/Ferrite-FEM/Ferrite.jl/blob/master/docs/src/assets/logo-horizontal.svg">
 </picture>
 
-![Build Status](https://github.com/Ferrite-FEM/Ferrite.jl/workflows/CI/badge.svg?event=push)
+[![Test Status](https://github.com/Ferrite-FEM/Ferrite.jl/actions/workflows/Test.yml/badge.svg?branch=master&event=push)](https://github.com/Ferrite-FEM/Ferrite.jl/actions/workflows/Test.yml)
 [![codecov.io](https://codecov.io/github/Ferrite-FEM/Ferrite.jl/coverage.svg?branch=master)](https://codecov.io/github/Ferrite-FEM/Ferrite.jl?branch=master)
+[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13862652.svg)](https://doi.org/10.5281/zenodo.13862652)
 
 A finite element toolbox written in Julia.

benchmark/benchmarks-dofs.jl

@@ -36,30 +36,30 @@ for spatial_dim in [3] # 1:3
 
                     LAGRANGE_SUITE["DofHandler"] = BenchmarkGroup()
 
-                    close_helper = function(grid, ip)
+                    close_helper = function (grid, ip)
                         dh = DofHandler(grid)
                         push!(dh, :u, field_dim, ip)
                         return close!(dh)
                     end
                     LAGRANGE_SUITE["DofHandler"]["one-field"] = @benchmarkable $close_helper($grid, $ip)
 
-                    close_helper = function(grid, ip, ip2)
+                    close_helper = function (grid, ip, ip2)
                         dh = DofHandler(grid)
                         push!(dh, :u, field_dim, ip)
                         push!(dh, :p, 1, ip2)
                         return close!(dh)
                     end
                     LAGRANGE_SUITE["DofHandler"]["two-fields"] = @benchmarkable $close_helper($grid, $ip, $ip2)
 
-                    close_helper = function(grid)
+                    close_helper = function (grid)
                         dh = DofHandler(grid)
                         sdh = SubDofHandler(dh, Set(1:Int(round(getncells(grid) / 2))))
                         add!(sdh, :u, ip^field_dim)
                         return close!(dh)
                     end
                     LAGRANGE_SUITE["DofHandler"]["one-field-subdomain"] = @benchmarkable $close_helper($grid)
 
-                    close_helper = function(grid)
+                    close_helper = function (grid)
                         dh = DofHandler(grid)
                         sdh = SubDofHandler(dh, Set(1:Int(round(getncells(grid) / 2))))
                         add!(sdh, :u, ip^field_dim)

docs/src/devdocs/FEValues.md

@@ -22,7 +22,7 @@ Ferrite.BCValues
 ## Internal utilities
 ```@docs
 Ferrite.embedding_det
-Ferrite.shape_value_type
+Ferrite.shape_value_type(::Ferrite.AbstractValues)
 Ferrite.shape_gradient_type
 Ferrite.ValuesUpdateFlags
 ```

docs/src/devdocs/dofhandler.md

@@ -1,4 +1,4 @@
-# [Dof Handler](@id dofhandler-interpolations)
+# [Dof handler](@id dofhandler-interpolations)
 
 ## Type definitions