Skip to content

Commit fa8eb05

Browse files
Sébastien LoiselSébastien Loisel
authored andcommitted
Freshen docs for the JuMP and Gmsh front ends
README gains feature bullets for the two extensions (they were absent); index.md's Gmsh teaser no longer says order-2 only (quads and hexes import at any order); jump.md's exported-names note adds Continuous, mgb_solution and solver_log; gmsh.md's intro mentions that the path form also accepts .geo files.
1 parent 0a77b85 commit fa8eb05

4 files changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ plot(sol)
3838
- **Discretizations:** finite elements in 1D/2D/3D (simplicial `P1`/`P2` and tensor-product `Q_k`),
3939
plus Chebyshev spectral elements; all isoparametric.
4040
- **Solver:** an algebraic-multigrid hierarchy (`amg`) driving a barrier (interior-point) method.
41+
- **JuMP modeling front end** (loads with `using JuMP`): state variational problems with
42+
`@variable`/`@constraint`/`@objective`; `optimize!` lowers them straight to the multigrid
43+
barrier pipeline.
44+
- **Gmsh mesh import** (loads with `using Gmsh`): triangles, quads, and hexes at any order,
45+
with physical groups as named regions for boundary conditions.
4146
- **Topological meshes:** slit domains, branch cuts, and glued manifolds via explicit connectivity
4247
(the `t=` keyword and `tensor_dofmap`).
4348
- **GPU:** optional CUDA acceleration.

docs/src/gmsh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ meshes of simple domains. For real geometry — CAD shapes, holes, local
99
refinement, named boundary parts — use [Gmsh](https://gmsh.info), the standard
1010
open-source mesh generator. The `MultiGridBarrierGmshExt` extension loads
1111
automatically when both packages are imported and provides
12-
[`gmsh_import`](@ref), which converts the current Gmsh mesh (or a `.msh` file)
13-
into a `Geometry` plus named node sets:
12+
[`gmsh_import`](@ref), which converts the current Gmsh mesh (or a `.msh`/`.geo`
13+
file) into a `Geometry` plus named node sets:
1414

1515
- 3/6-node triangles → `fem2d_P1` / `fem2d_P2` (curved P2 edges supported),
1616
- quadrilaterals → tensor `fem2d` of **any order** (curved; non-planar quad

docs/src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ Prefer stating problems in an algebraic modeling language? The
257257
syntax and lowers it to this same pipeline, building the hierarchy automatically.
258258

259259
Need meshes of real geometry (CAD shapes, holes, named boundary parts)? The
260-
[Gmsh importer](gmsh.md) converts Gmsh meshes — triangles, quads, hexahedra,
261-
straight or curved order-2 — into a `Geometry`, and physical groups into named
262-
node sets for `dirichlet_nodes` and `On`.
260+
[Gmsh importer](gmsh.md) converts Gmsh meshes — P1/P2 triangles, and quads or
261+
hexahedra of any order, straight or curved — into a `Geometry`, and physical
262+
groups into named node sets for `dirichlet_nodes` and `On`.
263263

264264
### Meshes, coordinates, and connectivity
265265

docs/src/jump.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ user-visible.
1919
automatically once both `MultiGridBarrier` and `JuMP` are imported. JuMP is
2020
not a dependency of MultiGridBarrier, so add it to your environment first
2121
(`pkg> add JuMP`). The modeling API (`MGBModel`, `Coef`, `EpiPower`,
22-
`deriv`, `integral`, `set_start`, `On`, `Broken`, `Uniform`) is then
23-
exported from `MultiGridBarrier`.
22+
`deriv`, `integral`, `set_start`, `On`, `Broken`, `Continuous`, `Uniform`,
23+
`mgb_solution`, `solver_log`) is then exported from `MultiGridBarrier`.
2424

2525
## Setup
2626

0 commit comments

Comments
 (0)