sbadrian · surzks · Mar 12, 2024 · Mar 13, 2024 · Mar 13, 2024 · Mar 15, 2024
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,47 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags: '*'
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.10' # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
+          - '1' # Leave this line unchanged. '1' will automatically expand to the latest stable 1.x release of Julia.
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v4
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v4
+        with:
+          files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -0,0 +1,29 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+    branches:
+        - master
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -4,6 +4,22 @@ on:
     types:
       - created
   workflow_dispatch:
+    inputs:
+      lookback:
+        default: "3"
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
@@ -12,5 +28,6 @@ jobs:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          ssh: ${{ secrets.DOCUMENTER_KEY }}
-
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_SSH_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,9 @@ docs/site/
 temp/
 dev/
 profile/
-Manifest.toml
+/envs/
+/Manifest.toml
+/test/Manifest.toml
+/docs/Manifest.toml
+/examples/Manifest.toml
+data/
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+# New in 2.7.2
+
+- GMRES from Krylov.jl wrapped as a LinearMap
+- Function `union` for a vector of spaces of the same type and defined on the same mesh returns a space containing the union of the functions in the input spaces.
+- Function `extend` computes the extension by zero of functions defined on a submesh. Currently works only when the corresponding cellls in the submesh and supermesh are ordered identically (oriented identically is not sufficient).
+
+## New in 2.7.0
+
+- PR #157: Improved support for 2D Helmholtz problems
diff --git a/Project.toml b/Project.toml
@@ -1,51 +1,63 @@
 name = "BEAST"
 uuid = "bb4162c7-ba94-5a20-af32-d8ec4428bdd1"
-version = "1.3.0"
+version = "2.7.2"
 
 [deps]
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 BlockArrays = "8e7c35d0-a365-5155-bbbb-fb81a777f24e"
 CollisionDetection = "2b5bf9a6-f3f8-5352-af9c-82bb4af718d8"
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
 CompScienceMeshes = "3e66a162-7b8c-5da0-b8f8-124ecd2c3ae1"
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
+ConvolutionOperators = "15927181-a1bb-497c-b745-8dbf505c019d"
 Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+ExtendableSparse = "95c220a8-a1cf-11e9-0c77-dbfce5f500b3"
 FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 FastGaussQuadrature = "442a2c76-b920-505d-bb47-c5924d526838"
 FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
+Infiltrator = "5903a43b-9cc3-4c30-8d17-598619ec4e9b"
+InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 IterativeSolvers = "42fd0dbc-a981-5370-80f2-aaf504508153"
+Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
+LiftedMaps = "d22a30c1-52ac-4762-a8c9-5838452405e0"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+LinearMaps = "7a12625a-238d-50fd-b39a-03d52299707e"
+NestedUnitRanges = "032820ab-dc03-4b49-91f4-7d58d4da98b3"
+Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+SauterSchwab3D = "0a13313b-1c00-422e-8263-562364ed9544"
 SauterSchwabQuadrature = "535c7bfe-2023-5c1d-b712-654ef9d93a38"
 SharedArrays = "1a1011a3-84de-559e-8e89-a11a2f7dc383"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-SparseMatrixDicts = "5cb6c4b0-9b79-11e8-24c9-f9621d252589"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
+TestItems = "1c621080-faea-4a02-84b6-bbd5e436b8fe"
 WiltonInts84 = "a3e2863e-c0ee-5ff6-a523-307a4cdc8724"
 
 [compat]
-BlockArrays = "^0.10, ^0.11, ^0.12, ^0.13, ^0.14, 0.15"
-CollisionDetection = "^0.1"
-Combinatorics = "^0.7, ^1"
-CompScienceMeshes = "^0.2.8"
-Compat = "^2, ^3"
-FFTW = "^0.2.3, ^1"
-FastGaussQuadrature = "^0.3, ^0.4"
-FillArrays = "0.11"
-IterativeSolvers = "^0.9"
-SauterSchwabQuadrature = "^2.1.1, 2.1"
-SparseMatrixDicts = "0.2"
-SpecialFunctions = "^0.7, ^0.8, ^0.9, ^0.10, ^1"
-StaticArrays = "^0.8.3, ^0.9, ^0.10, ^0.11, ^0.12, ^1"
-WiltonInts84 = "^0.2"
-julia = "^1.3"
-
-[extras]
-DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
-Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
-LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
-SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Pkg", "DelimitedFiles", "LinearAlgebra", "SparseArrays", "Test", "Distributed"]
+AbstractTrees = "0.4.4"
+BlockArrays = "1"
+CollisionDetection = "0.1.7"
+Combinatorics = "0.7, 1"
+CompScienceMeshes = "0.10"
+Compat = "2, 3, 4"
+ConvolutionOperators = "0.4"
+ExtendableSparse = "1.4"
+FFTW = "0.2.3, 1"
+FastGaussQuadrature = "0.3, 0.4, 0.5, 1"
+FillArrays = "0.11, 0.12, 0.13, 1"
+Infiltrator = "1.8.2"
+IterativeSolvers = "0.9"
+Krylov = "0.10.1"
+LiftedMaps = "0.5.1"
+LinearMaps = "3.7 - 3.9, 3.11.2"
+NestedUnitRanges = "0.2.2"
+Requires = "1"
+SauterSchwab3D = "0.2"
+SauterSchwabQuadrature = "2.4.0"
+SpecialFunctions = "0.7, 0.8, 0.9, 0.10, 1, 2"
+StaticArrays = "0.8.3, 0.9, 0.10, 0.11, 0.12, 1"
+Suppressor = "0.2.8"
+TestItems = "0.1.1, 1"
+WiltonInts84 = "0.2.8"
+julia = "1.10"
diff --git a/README.md b/README.md
@@ -1,72 +1,62 @@
-# BEAST
 
-Boundary Element Analysis and Simulation Toolkit
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/src/assets/logo_README_white.svg" height="170">
+  <source media="(prefers-color-scheme: light)" srcset="docs/src/assets/logo_README.svg" height="170">
+  <img alt="" src="" height="170">
+</picture>
 
-[![Build Status](https://travis-ci.org/krcools/BEAST.jl.svg?branch=master)](https://travis-ci.org/krcools/BEAST.jl)
+
+[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://krcools.github.io/BEAST.jl/stable/)
+[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/krcools/BEAST.jl/blob/master/LICENSE)
+[![CI](https://github.com/krcools/BEAST.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/krcools/BEAST.jl/actions/workflows/CI.yml)
 [![codecov.io](http://codecov.io/github/krcools/BEAST.jl/coverage.svg?branch=master)](http://codecov.io/github/krcools/BEAST.jl?branch=master)
-[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://krcools.github.io/BEAST.jl/latest/)
 [![DOI](https://zenodo.org/badge/87720391.svg)](https://zenodo.org/badge/latestdoi/87720391)
 
+
 ## Introduction
 
-This package contains common basis functions and assembly routines for the implementation of
-boundary element methods. Examples are included for the 2D and 3D Helmholtz equations and for
-the 3D Maxwell equations.
+This Julia package, the *boundary element analysis and simulation toolkit (BEAST)*, provides routines to convert integral and differential equations to linear systems of equations
+via the boundary element method (BEM) and the finite element method (FEM). 
+To this end, the (Petrov-) **Galerkin method** is employed.
 
-Support for the space-time Galerkin based solution of time domain integral equations is in
-place for the 3D Helmholtz and Maxwell equations.
+Currently, the focus is on equations encountered in **classical electromagnetism**, where frequency and time domain equations are covered.
+Several operators, basis functions, and geometry representations are implemented.
 
-## Installation
 
-Installing `BEAST` is done by entering the package manager (enter `]` at the julia REPL) and issuing:
+## Documentation
 
-```
-pkg>add BEAST
-```
+- Documentation for the [latest stable version](https://krcools.github.io/BEAST.jl/stable/).
+- Documentation for the [development version](https://krcools.github.io/BEAST.jl/dev/).
 
-To run the examples, the following steps are required in addition:
-
-```
-pkg> add CompScienceMeshes # For the creation of scatterer geometries
-pkg> add Plots             # For visualising the results
-pkg> add GR                # Other Plots compatible back-ends can be chosen
-```
-
-Examples can be run by:
-
-```
-julia>using BEAST
-julia>d = dirname(pathof(BEAST))
-julia>include(joinpath(d,"../examples/efie.jl"))
-```
 
 ## Hello World
 
-To solve scattering of a time harmonic electromagnetic plane wave by a perfectly conducting
-sphere:
+To solve scattering of a time-harmonic electromagnetic plane wave by a perfectly conducting sphere:
 
 ```julia
-using CompScienceMeshes, BEAST
+using CompScienceMeshes
+using BEAST
 
-Γ = readmesh(joinpath(dirname(pathof(BEAST)),"../examples/sphere2.in"))
-X = raviartthomas(Γ)
+# --- basis functions
+Γ  = meshsphere(1.0, 2.5)   # triangulate sphere of radius one
+RT = raviartthomas(Γ)       # define basis functions
 
-t = Maxwell3D.singlelayer(wavenumber=1.0)
-E = Maxwell3D.planewave(direction=ẑ, polarization=x̂, wavenumber=1.0)
-e = (n × E) × n
+# --- operators & excitation
+𝑇 = Maxwell3D.singlelayer(wavenumber=2.0)                             # integral operator
+𝐸 = Maxwell3D.planewave(direction=x̂, polarization=ẑ, wavenumber=2.0)  # excitation
+𝑒 = (n × 𝐸) × n # tangential part
 
-@hilbertspace j
-@hilbertspace k
-efie = @discretise t[k,j]==e[k]  j∈X k∈X
-u = gmres(efie)
-```
-![](output.png)
+# --- compute the RHS and system matrix
+e = assemble(𝑒, RT)         # assemble RHS
+T = assemble(𝑇, RT, RT)     # assemble system matrix
 
-## Features
+# --- solve
+u = T \ -e
 
-- General framework allowing to easily add support for more kernels, finite element spaces, and excitations.
-- Assembly routines that take in symbolic representations of the defining bilinear form. Support for block systems and finite element spaces defined in terms of direct products or tensor products of atomic spaces.
-- LU and iterative solution of the resulting system.
-- Computation of secondary quantities of interest such as the near field and the limiting far field.
-- Support for space-time Galerkin and convolution quadrature approaches to the solution of time domain boundary integral equations.
-- Implementation of Lagrange zeroth and first order space, Raviart-Thomas, Brezzi-Douglas-Marini, and Buffa-Christianssen vector elemenents.
+# ... post processing ...
+```
+<p align="center">
+  <img src="docs/src/assets/currentREADME.png" height="240">
+  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+  <img src="docs/src/assets/currentRealREADME.png" height="240">
+</p>
diff --git a/TODO.md b/TODO.md
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,10 @@
+[deps]
+BEAST = "bb4162c7-ba94-5a20-af32-d8ec4428bdd1"
+CompScienceMeshes = "3e66a162-7b8c-5da0-b8f8-124ecd2c3ae1"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
+PlotlyBase = "a03496cd-edff-5a9b-9e67-9cda94a718b5"
+PlotlyDocumenter = "9b90f1cd-2639-4507-8b17-2fbe371ceceb"
+TypeTree = "04da0e3b-1cad-4b2c-a963-fc1602baf1af"