Skip to content

Commit

Permalink
Merge pull request #3 from bcube-project/dev_gmsh
Browse files Browse the repository at this point in the history
Refactor gmsh mesh generators
  • Loading branch information
bmxam authored Nov 20, 2023
2 parents 7e4afbb + de84f36 commit 12e4890
Show file tree
Hide file tree
Showing 18 changed files with 501 additions and 7,441 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,36 @@
Bcube is a Julia library providing tools for the spatial discretization of partial differential equation(s) (PDE). It offers a high-level API to discretize linear or non-linear problems on unstructured mesh using continuous or discontinuous finite elements (FEM - DG).

The main features are:
* high-level api : `a(u, v) = ∫(η * ∇(u) ⋅ ∇(v))dΩ`
* 1D, 2D, 3D unstructured mesh with high-order geometrical elements (gmsh format)
* Lagrange (continuous & discontinuous) and Taylor (discontinuous) finite elements (line, quad, tri, hexa, penta)
* arbitrary order for hypercube Lagrange elements

Tutorials are available in the [documentation](https://bcube-project.github.io/Bcube.jl). You will also find more information about the code architecture.
- high-level api : `a(u, v) = ∫(η * ∇(u) ⋅ ∇(v))dΩ`
- 1D, 2D, 3D unstructured mesh with high-order geometrical elements (gmsh format)
- Lagrange (continuous & discontinuous) and Taylor (discontinuous) finite elements (line, quad, tri, hexa, penta)
- arbitrary order for hypercube Lagrange elements

Tutorials are available in the [documentation](https://bcube-project.github.io/Bcube.jl). You will also find more information about the code architecture.

## Installation

Bcube can be added to your Julia environment with this simple line :

```julia-repl
pkg> add https://github.com/bcube-project/Bcube.jl
```

## Alternatives

Numerous FEM-DG Julia packages are available, here is a non-exhaustive list;
* [Gridap.jl](https://github.com/gridap/Gridap.jl) (which has greatly influenced the development of Bcube)
* [Ferrite.jl](https://github.com/Ferrite-FEM/Ferrite.jl)
* [Trixi.jl](https://github.com/trixi-framework/Trixi.jl)

- [Gridap.jl](https://github.com/gridap/Gridap.jl) (which has greatly influenced the development of Bcube)
- [Ferrite.jl](https://github.com/Ferrite-FEM/Ferrite.jl)
- [Trixi.jl](https://github.com/trixi-framework/Trixi.jl)

## Contribution

Any contribution(s) and/or remark(s) are welcome! Don't hesitate to open an issue to ask a question or signal a bug. PRs improving the code (new features, new elements, fixing bugs, ...) will be greatly appreciated.

## Gallery
|![](https://bcube-project.github.io/Bcube.jl/stable/assets/helmholtz_x21_y21_vp6.png)|![](https://bcube-project.github.io/Bcube.jl/stable/assets/phase-field-supercooled-rectangle.gif)|![](https://bcube-project.github.io/Bcube.jl/stable/assets/linear_transport.gif)|
|[Helmholtz equation](https://bcube-project.github.io/Bcube.jl/stable/tutorial/helmholtz.html)|[Phase field solidification](https://bcube-project.github.io/Bcube.jl/stable/tutorial/phase_field_supercooled.html)|[Linear transport equation](https://bcube-project.github.io/Bcube.jl/stable/tutorial/linear_transport.html)|
| [Helmholtz equation](https://bcube-project.github.io/Bcube.jl/stable/tutorial/helmholtz.html) | [Phase field solidification](https://bcube-project.github.io/Bcube.jl/stable/tutorial/phase_field_supercooled.html) | [Linear transport equation](https://bcube-project.github.io/Bcube.jl/stable/tutorial/linear_transport.html) |
|-|-|-|
| ![](https://bcube-project.github.io/Bcube.jl/stable/assets/helmholtz_x21_y21_vp6.png) | ![](https://bcube-project.github.io/Bcube.jl/stable/assets/phase-field-supercooled-rectangle.gif) | ![](https://bcube-project.github.io/Bcube.jl/stable/assets/linear_transport.gif) |
|
51 changes: 0 additions & 51 deletions input/mesh/2_cubes.geo

This file was deleted.

216 changes: 0 additions & 216 deletions input/mesh/2_cubes.msh

This file was deleted.

71 changes: 0 additions & 71 deletions input/mesh/cube_pile.geo

This file was deleted.

Loading

0 comments on commit 12e4890

Please sign in to comment.