LFAToolkit

Local Fourier Analysis for arbitrary order finite element type operators

https://github.com/jeremylt/lfatoolkit.jl

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.2%) to scientific vocabulary

Keywords

lfa local-fourier-analysis partial-differential-equations preconditioners

Keywords from Contributors

pde numerics
Last synced: 6 months ago · JSON representation ·

Repository

Local Fourier Analysis for arbitrary order finite element type operators

Basic Info
Statistics
  • Stars: 12
  • Watchers: 2
  • Forks: 4
  • Open Issues: 5
  • Releases: 12
Topics
lfa local-fourier-analysis partial-differential-equations preconditioners
Created over 5 years ago · Last pushed 12 months ago
Metadata Files
Readme Contributing License Citation

README.md

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.

Contact

You can reach the LFAToolkit.jl by leaving a comment in the issue tracker.

How to Cite

If you utilize LFAToolkit.jl please cite:

bibtex @software{LFAToolkit_jl, author = {Thompson, Jeremy L and Bankole, Adeleke O and Brown, Jed}, title = {{LFAToolkit.jl}}, version = {0.7.0}, month = mar, year = {2024}, url = {https://jeremylt.github.io/LFAToolkit.jl/stable/}, doi = {10.5281/zenodo.4659283}, }

Owner

  • Name: Jeremy L Thompson
  • Login: jeremylt
  • Kind: user
  • Location: Denver, CO

Research Software Engineer (he/him)

Citation (CITATION.cff)

cff-version: 1.1.0
title: "LFAToolkit.jl"
message: "Please cite the following works when using this software."
version: 0.7.0
date-released: 2024-03-01
license:  BSD-2-Clause
authors:
  - family-names: Thompson
    given-names: Jeremy L
    orcid: 0000-0003-2980-0899
  - family-names: Bankole
    given-names: Adeleke O
    orcid: 0000-0003-2804-5457
  - family-names: Brown
    given-names: Jed
    orcid: 0000-0002-9945-0639
doi: "10.5281/zenodo.5064056"
url: "https://jeremylt.github.io/LFAToolkit.jl/stable/"
repository: "https://github.com/jeremylt/LFAToolkit.jl"
references:
  - type: article
    title: "Local Fourier Analysis of p-Multigrid for High-Order Finite Element Operators"
    authors:
      - family-names: Thompson
        given-names: Jeremy L
        orcid: 0000-0003-2980-0899
      - family-names: Brown
        given-names: Jed
        orcid: 0000-0002-9945-0639
      - family-names: He
        given-names: Yunhui
        orcid: 0000-0003-3476-2487
    journal: "SIAM Journal on Scientific Computing"
    year: 2023
    publisher:
      - name: "Society for Industrial and Applied Mathematics"
        website: "https://epubs.siam.org"
    volume: 45
    number: 3
    start: S351
    doi: 10.1137/21M1431199

GitHub Events

Total
  • Issues event: 3
  • Delete event: 2
  • Push event: 12
  • Pull request event: 4
  • Create event: 2
Last Year
  • Issues event: 3
  • Delete event: 2
  • Push event: 12
  • Pull request event: 4
  • Create event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 480
  • Total Committers: 6
  • Avg Commits per committer: 80.0
  • Development Distribution Score (DDS): 0.213
Top Committers
Name Email Commits
jeremylt t****e@g****m 378
Jeremy L Thompson 2****t@u****m 48
Jeremy L Thompson j****y@j****g 47
Jed Brown j****d@j****g 3
Adeleke O. Bankole 8****e@u****m 2
CompatHelper Julia c****y@j****g 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 19
  • Total pull requests: 75
  • Average time to close issues: 5 months
  • Average time to close pull requests: 12 days
  • Total issue authors: 3
  • Total pull request authors: 6
  • Average comments per issue: 0.53
  • Average comments per pull request: 1.24
  • Merged pull requests: 64
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 1
  • Pull requests: 4
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 7 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jeremylt (16)
  • jedbrown (2)
  • yslan (1)
Pull Request Authors
  • jeremylt (61)
  • AdelekeBankole (8)
  • jedbrown (4)
  • github-actions[bot] (3)
  • MalachiTimothyPhillips (1)
Top Labels
Issue Labels
enhancement (6) bug (3) documentation (2) testing/ci (2) papers (1)
Pull Request Labels
enhancement (11) testing/ci (7) documentation (7) papers (4) bug (3)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 1 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
juliahub.com: LFAToolkit

Local Fourier Analysis for arbitrary order finite element type operators

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1 Total
Rankings
Dependent repos count: 9.9%
Forks count: 24.5%
Average: 26.9%
Stargazers count: 34.1%
Dependent packages count: 38.9%
Last synced: 7 months ago

Dependencies

.github/workflows/compat-helper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-docdeploy latest composite
.github/workflows/style.yml actions
  • actions/checkout v3 composite
  • julia-actions/setup-julia latest composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-processcoverage latest composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/setup-julia latest composite