Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gmsh extension3 #34

Merged
merged 17 commits into from
Nov 22, 2023
1 change: 1 addition & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"

[weakdeps]
Expand Down
5 changes: 5 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
ExtendableGrids = "cfc395e8-590f-11e8-1f13-43a2532b2fa8"
Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
GridVisualize = "5eed8a63-0fb0-45eb-886d-8d5a387d12b8"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
SimplexGridFactory = "57bfcd06-606e-45d6-baf4-4ba06da0efd5"
Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"

[compat]
Documenter = "1"
julia = "1.9"
50 changes: 24 additions & 26 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,40 +1,38 @@
ENV["MPLBACKEND"]="agg"
using Documenter, ExtendableGrids, Literate, GridVisualize, SimplexGridFactory
ENV["MPLBACKEND"] = "agg"
using Documenter, ExtendableGrids, Literate, GridVisualize, SimplexGridFactory, Gmsh
import CairoMakie, Triangulate

CairoMakie.activate!(type="svg",visible=false)
CairoMakie.activate!(; type = "svg", visible = false)

example_md_dir = joinpath(@__DIR__,"src","examples")
example_md_dir = joinpath(@__DIR__, "src", "examples")



examples1d=joinpath(@__DIR__,"..","examples","examples1d.jl")
examples1d = joinpath(@__DIR__, "..", "examples", "examples1d.jl")
include(examples1d)
examples2d=joinpath(@__DIR__,"..","examples","examples2d.jl")
examples2d = joinpath(@__DIR__, "..", "examples", "examples2d.jl")
include(examples2d)
examples3d=joinpath(@__DIR__,"..","examples","examples3d.jl")
examples3d = joinpath(@__DIR__, "..", "examples", "examples3d.jl")
include(examples3d)

include("makeplots.jl")

function mkdocs()
Literate.markdown(examples1d, example_md_dir; documenter = false, info = false)
Literate.markdown(examples2d, example_md_dir; documenter = false, info = false)
Literate.markdown(examples3d, example_md_dir; documenter = false, info = false)

generated_examples = joinpath.("examples", filter(x -> endswith(x, ".md"), readdir(example_md_dir)))

Literate.markdown(examples1d, example_md_dir, documenter=false,info=false)
Literate.markdown(examples2d, example_md_dir, documenter=false,info=false)
Literate.markdown(examples3d, example_md_dir, documenter=false,info=false)

generated_examples=joinpath.("examples",filter(x->endswith(x, ".md"),readdir(example_md_dir)))

makeplots(example_md_dir, Plotter=CairoMakie)

makedocs(sitename="ExtendableGrids.jl",
modules = [ExtendableGrids],
clean = false,
makeplots(example_md_dir; Plotter = CairoMakie)

makedocs(; sitename = "ExtendableGrids.jl",
modules = [ExtendableGrids, Base.get_extension(ExtendableGrids, :ExtendableGridsGmshExt)],
clean = false,
warnonly = true,
doctest = true,
authors = "J. Fuhrmann, Ch. Merdon",
repo="https://github.com/j-fu/ExtendableGrids.jl",
pages=[
"Home"=>"index.md",
repo = "https://github.com/j-fu/ExtendableGrids.jl",
pages = [
"Home" => "index.md",
"adjacency.md",
"vectorofconstants.md",
"typehierarchy.md",
Expand All @@ -52,12 +50,12 @@ function mkdocs()
"refinement.md",
"regionedit.md",
"tokenstream.md",
"gmsh.md",
"allindex.md",
"Examples" => generated_examples
"Examples" => generated_examples,
])
end

mkdocs()

deploydocs(repo = "github.com/j-fu/ExtendableGrids.jl.git")

deploydocs(; repo = "github.com/j-fu/ExtendableGrids.jl.git")
22 changes: 22 additions & 0 deletions docs/src/gmsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Gmsh interoperability
This functionality is in beta stage.
Breaking changes for this API are considered non-breaking for the package.
Therefore, these functions are not exported yet.



## API
These methods become available via a package extension which is loaded together with
[Gmsh.jl](https://github.com/JuliaFEM/Gmsh.jl).
See the general [gmsh documentation](https://gmsh.info/), the [Gmsh reference manual](https://gmsh.info/doc/texinfo/gmsh.html)
and the [Gmsh Julia API source code](https://gitlab.onelab.info/gmsh/gmsh/blob/master/api/gmsh.jl) for information.


```@docs
ExtendableGrids.simplexgrid_from_gmsh
ExtendableGrids.simplexgrid_to_gmsh
ExtendableGrids.mixedgrid_from_gmsh
ExtendableGrids.mixedgrid_to_gmsh
```


Loading
Loading