From 7aef6a4695dd5f5e876b787e1e713941505ab3af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Fuhrmann?= Date: Thu, 23 Nov 2023 17:11:08 +0100 Subject: [PATCH] small readme+docs update --- README.md | 10 +++++----- examples/examples1d.jl | 2 +- examples/examples3d.jl | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1ebaf882..1fec753c 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,19 @@ [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://j-fu.github.io/ExtendableGrids.jl/dev) -Container structure `ExtendableGrid` with type stable content access and lazy content creation holding data for discretization +Provide container structure `ExtendableGrid` with type stable content access and lazy content creation holding data for discretization grids for finite element and finite volume methods. Used by [VoronoiFVM](https://github.com/j-fu/VoronoiFVM.jl) and [GradientRobustMultiPhysics](https://github.com/chmerdon/GradientRobustMultiPhysics.jl), a package for novel, gradient robust finite element methods. -Additional funtionality: +Additional functionality: - Tools to create tensor product grids - Tools for grid modification +- [Gmsh.jl](https://github.com/JuliaFEM/Gmsh.jl) extension - + Companion packages: - Visualization of these grids and of functions on them is avaialable in [GridVisualize.jl](https://github.com/j-fu/GridVisualize.jl). -- The differently licensed [SimplexGridFactory](https://github.com/j-fu/SimplexGridFactory.jl) contains an interface which allows to +- The differently licensed [SimplexGridFactory](https://github.com/j-fu/SimplexGridFactory.jl) contains an API which allows to create `ExtendableGrid` objects with [Triangulate.jl](https://github.com/JuliaGeometry/Triangulate.jl) which wraps the Triangle mesh generator by J. Shewchuk and [TetGen.jl](https://github.com/JuliaGeometry/TetGen.jl) which wraps the TetGen mesh generator by H. Si. - diff --git a/examples/examples1d.jl b/examples/examples1d.jl index e3cc8b03..60a687e1 100644 --- a/examples/examples1d.jl +++ b/examples/examples1d.jl @@ -44,7 +44,7 @@ function interval_subgrid() subgrid(grid, [2, 3]) end # ![](interval_subgrid.svg) -# ## CI callbacks +# ## CI callbacks for [ExampleJuggler.jl](https://github.com/j-fu/ExampleJuggler.jl) # Unit tests using Test diff --git a/examples/examples3d.jl b/examples/examples3d.jl index 929f0d0d..49364f63 100644 --- a/examples/examples3d.jl +++ b/examples/examples3d.jl @@ -26,7 +26,7 @@ function cross3d() subgrid(grid, [2]) end # ![](cross3d.svg) -# ## CI callbacks +# ## CI callbacks for [ExampleJuggler.jl](https://github.com/j-fu/ExampleJuggler.jl) # Unit tests function mask_bedges()