Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.53 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.53 KB

LFAToolkit

CI Status CodeCov License Documentation Documentation DOI Binder Run on Repl.it

Local Fourier Analysis for arbitrary order finite element type operators

Introduction

Local Fourier Analysis is a tool commonly used in the analysis of multigrid and multilevel algorithms for solving partial differential equations via finite element or finite difference methods. This analysis can be used to predict convergence rates and optimize parameters in multilevel methods and preconditioners.

This package provides a toolkit for analyzing the performance of preconditioners for arbitrary, user provided weak forms of partial differential equations.

Installing

To install a development version, run

julia --project -e 'using Pkg; Pkg.build();'

To install and test, run

julia --project -e 'using Pkg; Pkg.build(); Pkg.test("LFAToolkit")'

Examples

Examples can be found in the examples directory, with interactive examples in Jupyter notebooks found in the examples/jupyter directory.

Documentation

Documentation can be found at the url listed above. To build the documentation locally, run

julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); Pkg.build()'

followed by

DOCSARGS=local julia --project=docs/ docs/make.jl

Online Demos

Both of the current online demos are not performing smoothly.

The Binder with interactive Jupyter notebooks takes a long time to start due to the time required to install LFAToolkit.jl and the plotting utilities.

The repl.it often reports a System Error with Disk quota exceeded. Clicking 'Run' again will typically clear the issue within a few attempts.