Use runic

Author: vchuravy

.github/workflows/runic.yml

@@ -0,0 +1,22 @@
+name: Runic formatting
+on:
+  push:
+    branches:
+      - 'main'
+      - 'release-'
+    tags:
+      - '*'
+  pull_request:
+jobs:
+  runic:
+    name: Runic
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # - uses: julia-actions/setup-julia@v2
+      #   with:
+      #     version: '1'
+      # - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: '1'

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+-  repo: https://github.com/fredrikekre/runic-pre-commit
+   rev: v1.0.0
+   hooks:
+    - id: runic

Project.toml

@@ -6,6 +6,7 @@ version = "0.1.0"
 [deps]
 Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
 Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
+KrylovPreconditioners = "45d422c2-293f-44ce-8315-2cb988662dec"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 

examples/bratu.jl

@@ -5,48 +5,48 @@ using KrylovPreconditioners
 using SparseArrays, LinearAlgebra
 
 function bratu!(res, y, Δx, λ)
-	N = length(y)
-	for i in 1:N
-		y_l = i == 1 ? zero(eltype(y)) : y[i - 1]
-		y_r = i == N ? zero(eltype(y)) : y[i + 1]
-		y′′ = (y_r - 2y[i] + y_l) / Δx^2
-
-		res[i] = y′′ + λ * exp(y[i]) # = 0
-	end
-	nothing
+    N = length(y)
+    for i in 1:N
+        y_l = i == 1 ? zero(eltype(y)) : y[i - 1]
+        y_r = i == N ? zero(eltype(y)) : y[i + 1]
+        y′′ = (y_r - 2y[i] + y_l) / Δx^2
+
+        res[i] = y′′ + λ * exp(y[i]) # = 0
+    end
+    return nothing
 end
 
 function bratu(y, dx, λ)
-	res = similar(y)
-	bratu!(res, y, dx, λ)
-	res
+    res = similar(y)
+    bratu!(res, y, dx, λ)
+    return res
 end
 
 function true_sol_bratu(x)
-	# for λ = 3.51382, 2nd sol θ = 4.8057
-	θ = 4.79173
-	-2 * log(cosh(θ * (x-0.5)/2) / (cosh(θ/4)))
+    # for λ = 3.51382, 2nd sol θ = 4.8057
+    θ = 4.79173
+    return -2 * log(cosh(θ * (x - 0.5) / 2) / (cosh(θ / 4)))
 end
 
 const N = 10_000
 const λ = 3.51382
 const dx = 1 / (N + 1) # Grid-spacing
 
-x  = LinRange(0.0+dx, 1.0 - dx, N)
-u₀ = sin.(x.* π)
+x = LinRange(0.0 + dx, 1.0 - dx, N)
+u₀ = sin.(x .* π)
 
 reference = true_sol_bratu.(x)
 
 uₖ_1 = newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = CgSolver,
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = CgSolver,
 )
 
 uₖ_2 = newton_krylov(
-	(u) -> bratu(u, dx, λ),
-	copy(u₀);
-	Solver = CgSolver
+    (u) -> bratu(u, dx, λ),
+    copy(u₀);
+    Solver = CgSolver
 )
 
 ϵ1 = abs2.(uₖ_1 .- reference)
@@ -55,19 +55,19 @@ uₖ_2 = newton_krylov(
 ##
 # Solving with a fixed forcing
 newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = CgSolver,
-	forcing = NewtonKrylov.Fixed()
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = CgSolver,
+    forcing = NewtonKrylov.Fixed()
 )
 
 ##
 # Solving with no forcing
 newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = CgSolver,
-	forcing = nothing
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = CgSolver,
+    forcing = nothing
 )
 
 ##
@@ -81,40 +81,40 @@ newton_krylov!(
 ##
 # Solve using GMRES + ILU Preconditoner
 @time newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = GmresSolver,
-	N = (J) -> ilu(collect(J)), # Assembles the full Jacobian
-	ldiv = true,
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = GmresSolver,
+    N = (J) -> ilu(collect(J)), # Assembles the full Jacobian
+    ldiv = true,
 )
 
 ##
 # Solve using FGMRES + ILU Preconditoner
 @time newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = FgmresSolver,
-	N = (J) -> ilu(collect(J)), # Assembles the full Jacobian
-	ldiv = true,
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = FgmresSolver,
+    N = (J) -> ilu(collect(J)), # Assembles the full Jacobian
+    ldiv = true,
 )
 
 ##
 # Solve using FGMRES + GMRES Preconditoner
 struct GmresPreconditioner{JOp}
-	J::JOp
-	itmax::Int
+    J::JOp
+    itmax::Int
 end
 
 function LinearAlgebra.mul!(y, P::GmresPreconditioner, x)
-  sol, _ = gmres(P.J, x; P.itmax)
-  copyto!(y, sol)
+    sol, _ = gmres(P.J, x; P.itmax)
+    return copyto!(y, sol)
 end
 
 @time newton_krylov!(
-	(res, u) -> bratu!(res, u, dx, λ),
-	copy(u₀), similar(u₀);
-	Solver = FgmresSolver,
-	N = (J) -> GmresPreconditioner(J, 30),
+    (res, u) -> bratu!(res, u, dx, λ),
+    copy(u₀), similar(u₀);
+    Solver = FgmresSolver,
+    N = (J) -> GmresPreconditioner(J, 30),
 )
 
 # # Explodes..
@@ -131,4 +131,4 @@ end
 # 	verbose = 1,
 # 	Solver = BicgstabSolver,
 # 	η_max = nothing
-# )
+# )