proximalgalerkin

This repository contains examples of the proximal Galerkin finite element method and other proximal numerical methods derived from the LVPP algorithm

https://github.com/methods-group/proximalgalerkin

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 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

This repository contains examples of the proximal Galerkin finite element method and other proximal numerical methods derived from the LVPP algorithm

Basic Info
  • Host: GitHub
  • Owner: METHODS-Group
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 10.3 MB
Statistics
  • Stars: 10
  • Watchers: 5
  • Forks: 2
  • Open Issues: 4
  • Releases: 4
Created over 2 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

ProximalGalerkin

Launch on Binder DOI

This repository contains implementations of the proximal Galerkin finite element method and other proximal numerical methods for variational problems with inequality constraints derived in

bibtex @misc{dokken2025latent, title={The latent variable proximal point algorithm for variational problems with constraints}, author={Dokken, {J\o rgen} S. and Farrell, Patrick~E. and Keith, Brendan and Papadopoulos, Ioannis~P.A. and Surowiec, Thomas~M.}, year={2025}, }

Please cite the aforementioned manuscript if using the code in this repository.

Installation instructions

We provide a single docker container ghcr.io/methods-group/proximalgalerkin from Proximal Galerkin Docker container registry that provides an installation of all dependencies used in the examples of this paper.

One can start the image with

bash docker run -ti -v $(pwd):/root/shared --name=proximal-examples ghcr.io/methods-group/proximalgalerkin:v0.3.0

This shares the current directory with the docker container under the location /root/shared. To restart this container at a later instance call

bash docker container start -i proximal-examples

Within this installation you find all examples under /root/LVPP.

MFEM

When wanting to run MFEM-examples, one has to navigate to /root/LVPP/mfem/examples and call make name_of_example to compile the corresponding demo.

The MFEM scripts from this paper are already placed in this location in the container.

FEniCS/Firedrake compatibility

FEniCS and Firedrake are installed in separate virtual environments within the container. At launch, the user gets to use FEniCS by default. To change to Firedrake, call

bash source firedrake-mode

To change back to FEniCS call

bash source dolfinx-mode

Table of Examples and Figures

The following table associates each implementation to the examples and figures in the paper. Further information to run the codes is provided for each specific example can be found in the corresponding folder.

| Figure | Folder | Backend | Problem Type | | :----: | :--------------------------------------------------------------------: | :-------------------------------: | ---------------------------- | | 3b | 01obstacleproblem | FEniCS | Obstacle problem (FEM) | | 3c(i) | 01obstacleproblem | Julia | Obstacle problem (FD) | | 3c(ii) | 01obstacleproblem | MultivariateOrthogonalPolynomials | Obstacle problem (Spectral) | | 4 | 02_signorini | FEniCS | Signorini | | 5 | 03_fracture | Firedrake/FEniCS | Fracture | | 6 | 04_multiphase | FEniCS | Cahn-Hilliard | | 7 | 05obstacletype_qvi | Gridap.jl/FEniCS | Thermoforming QVI | | 8 | 06gradientconstraints | FEniCS | Gradient constraint | | 9 | 07eigenvalueconstraints | Firedrake/FEniCS | Landau–de Gennes | | 10 | 08intersectingconstraints | Firedrake/FEniCS | Intersections of constraints | | 11 | 09_eikonal | MFEM/FEniCS | Eikonal equation | | 12 | 10mongeampere | Firedrake/FEniCS | Monge-Ampere |

Owner

  • Name: METHODS Group
  • Login: METHODS-Group
  • Kind: organization
  • Email: brendan_keith@brown.edu
  • Location: United States of America

Models, Experiments, and Theory for High-Performance Optimization, Design, and Simulation

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite both the article from preferred-citation and the software itself.
authors:
  - family-names: Dokken
    given-names: Jørgen S.
  - family-names: Farrell
    given-names: Patrick~E.
  - family-names: Keith
    given-names: Brendan
  - family-names: Papadopoulos
    given-names: Ioannis~P.A.
  - family-names: Surowiec
    given-names: Thomas~M.
title: The latent variable proximal point algorithm for variational problems with constraints
version: 1.0.0
date-released: "2025-02-17"
preferred-citation:
  authors:
    - family-names: Dokken
      given-names: Jørgen S.
    - family-names: Farrell
      given-names: Patrick~E.
    - family-names: Keith
      given-names: Brendan
    - family-names: Papadopoulos
      given-names: Ioannis~P.A.
    - family-names: Surowiec
      given-names: Thomas~M.
  title: The latent variable proximal point algorithm for variational problems with constraints
  type: generic
  year: "2025"
  conference: {}
  publisher: {}

GitHub Events

Total
  • Create event: 29
  • Release event: 4
  • Watch event: 9
  • Delete event: 19
  • Issue comment event: 5
  • Public event: 1
  • Push event: 106
  • Pull request review comment event: 9
  • Pull request review event: 11
  • Pull request event: 39
  • Fork event: 1
Last Year
  • Create event: 29
  • Release event: 4
  • Watch event: 9
  • Delete event: 19
  • Issue comment event: 5
  • Public event: 1
  • Push event: 106
  • Pull request review comment event: 9
  • Pull request review event: 11
  • Pull request event: 39
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.42
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: about 9 hours
  • Issue authors: 0
  • Pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.42
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
Pull Request Authors
  • jorgensd (18)
  • brendankeith (2)
  • ioannisPApapadopoulos (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1) github_actions (1)

Dependencies

.github/workflows/build-docker-image.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • docker/build-push-action v6 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
  • docker/setup-buildx-action v3 composite
.github/workflows/test_julia.yml actions
  • actions/checkout v4 composite
pyproject.toml pypi
  • fenics-dolfinx >=0.9.0
.github/workflows/test_dolfinx.yml actions
  • actions/checkout v4 composite
.github/workflows/test_firedrake.yml actions
  • actions/checkout v4 composite
.github/workflows/test_mfem.yml actions
  • actions/checkout v4 composite
environment.yml conda
  • fenics-dolfinx 0.9.0.*
  • git
  • ipywidgets
  • pip
  • python-gmsh
  • pyvista
  • scifem
  • scipy
  • tqdm
  • trame
  • trame-client
  • trame-server
  • trame-vtk
  • trame-vuetify
Dockerfile docker
  • ghcr.io/methods-group/proximalgalerkin v0.2.0 build
docker/Dockerfile docker
  • dolfinx-onbuild latest build
  • dolfinx-user-env latest build
  • firedrake-env latest build
  • firedrake-petsc-env latest build
  • galahad latest build
  • ghcr.io/fenics/dolfinx/dev-env v0.9.0-openmpi build
  • mfem-user-env latest build
  • optimization latest build