Merge pull request #24 from gridap/gsoc2021-master

Gsoc2021 master
gridap · Aug 22, 2021 · 6afee42 · 6afee42
2 parents 176550d + 3f91a21
commit 6afee42
Show file tree

Hide file tree

Showing 28 changed files with 843 additions and 523 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,56 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    name: Tests ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.6'
+        os:
+          - ubuntu-18.04
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
+      - uses: julia-actions/julia-buildpkg@v1
+      - run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=@. -e 'using Pkg; Pkg.test(coverage=true)'
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.6'
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()
+            Pkg.build()'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 /docs/build/
 Manifest.toml
+.DS_Store
diff --git a/.travis.yml b/.travis.yml
diff --git a/Justfile b/Justfile
diff --git a/Project.toml b/Project.toml
@@ -4,20 +4,26 @@ authors = ["Francesc Verdugo <fverdugo@cimne.upc.edu>", "Jan Weidner <jw3126@gma
 version = "0.1.0"
 
 [deps]
-AbstractPlotting = "537997a7-5e4e-5d89-9595-2241ea00577e"
-ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"
-ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
+FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
+GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
 Gridap = "56d4f2e9-7ea1-5844-9cf6-b9c51ca7ce8e"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
 
 [compat]
-julia = "1.4"
+CairoMakie = "0.6"
+FileIO = "1"
+FillArrays = "0.12"
+GLMakie = "0.4"
+GeometryBasics = "0.3"
+Gridap = "0.16"
+Makie = "0.15"
+julia = "1.6"
 
 [extras]
-FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
-ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
-Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Makie", "FileIO", "ImageMagick"]
+test = ["Test"]
diff --git a/README.md b/README.md
@@ -1,83 +1,185 @@
-```@meta
-EditURL = "<unknown>/README.jl"
-```
-
 # GridapMakie
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gridap.github.io/GridapMakie.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gridap.github.io/GridapMakie.jl/dev)
-[![Build Status](https://travis-ci.com/gridap/GridapMakie.jl.svg?branch=master)](https://travis-ci.com/gridap/GridapMakie.jl)
+[![Build Status](https://github.com/gridap/GridapMakie.jl/workflows/CI/badge.svg?branch=master)](https://github.com/gridap/GridapMakie.jl/actions)
 [![Coverage](https://codecov.io/gh/gridap/GridapMakie.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/gridap/GridapMakie.jl)
 
-# This package is experimental
-
-Things can and will break without deprecation or warning
-
-# Examples
-
-```@example README
-using Gridap, GridapMakie, Makie
-
-model = simplexify(CartesianDiscreteModel((-2pi,2pi,-pi,pi), (20,10)))
-scene = plot(model)
-```
-
-![](_readme/images/2d.png)
+## Overview
 
-```@example README
-data = GridapMakie.demo_data(spacedim=1, valuetype=Float64)
-scene = plot(data.u, data.model)
-```
-
-![](_readme/images/plot_1d_Scalar.png)
-
-```@example README
-model = simplexify(CartesianDiscreteModel((-2pi,2pi,-pi,pi), (10,10)))
-V = TestFESpace(reffe=:Lagrangian, order=1, valuetype = Float64,
-    conformity=:H1, model=model)
-f(pt) = sin(pt[1])*cos(pt[2])
-u = interpolate(V, f)
-scene = mesh(u, model, color=:yellow)
-```
+The visualization of numerical results is an important part of finite element (FE) computations. However, before the inception of GridapMakie.jl, the
+only approach available to data visualization of [Gridap.jl](https://github.com/gridap/Gridap.jl) computations was to write simulation
+data to data files (e.g., in vtu format) for later visualization with, e.g., Paraview or VisIt. From the idea of visually inspecting
+data from Julia code directly or to manipulate it with packages of the Julia
+open-source package ecosystem, [GridapMakie.jl](https://github.com/gridap/GridapMakie.jl) is born. As a part of the Google Summer of
+Code 2021 program, GridapMakie adopts [Makie.jl](https://github.com/JuliaPlots/Makie.jl) as a second visualization back-end for
+Gridap.jl simulations. This package is thought as a built-in tool to assess the user in their FE calculations with a smoother workflow
+in a highly intuitive API.
 
-![](_readme/images/mesh_2d_Scalar.png)
+## Installation
 
-```@example README
-model = simplexify(CartesianDiscreteModel((-2pi,2pi,-pi,pi), (10,10)))
-V = TestFESpace(reffe=:Lagrangian, order=1, valuetype = Float64,
-    conformity=:H1, model=model)
-f(pt) = sin(pt[1])*cos(pt[2])
-u = interpolate(V, f)
-scene = wireframe(u, model)
-```
-
-![](_readme/images/wireframe_2d_Scalar.png)
+According to Makie's guidelines, it is enough to install one of its backends, e.g. GLMakie. Additionally, Gridap provides the plot objects
+to be visualized and `FileIO` allows to save the figures plotted.
 
-```@example README
-model = CartesianDiscreteModel((-1,1,-1,1), (10,10))
-V = TestFESpace(reffe=:Lagrangian, order=1, valuetype = VectorValue{2, Float64},
-    conformity=:H1, model=model)
-f(pt) = VectorValue(-pt[2], pt[1])
-u = interpolate(V, f)
-scene = arrows(u, model, arrowsize=0.1, lengthscale=0.5)
+```julia
+julia> ]
+pkg> add Gridap, GridapMakie, GLMakie, FileIO
 ```
 
-![](_readme/images/arrows_2d_Vec2d.png)
+## Examples
 
-```@example README
-model = CartesianDiscreteModel((-1,1,-1,1, -1, 1), (10,10, 10))
-V_pressure = TestFESpace(reffe=:Lagrangian, order=1, valuetype=Float64, conformity=:H1, model=model)
-V_velo = TestFESpace(reffe=:Lagrangian, order=1, valuetype=VectorValue{3, Float64},
-    conformity=:H1, model=model)
+First things first, we shall be using the three packages as well as `FileIO`.
+We may as well create directories to store downloaded meshes and output files
 
-pressure = interpolate(V_pressure, pt -> pt[1]*pt[2]*pt[3])
-velocity = interpolate(V_velo, pt -> VectorValue(-pt[3]*pt[2],pt[3]*pt[1], 0.1*pt[1]*pt[2]))
-
-color = GridapMakie.to_visualization_data(pressure, model) |> GridapMakie.get_nodalvalues
-scene = arrows(velocity, model, arrowsize=0.1, lengthscale=0.2, arrowcolor=color)
-```
+````julia
+using Gridap, GridapMakie, GLMakie
+using FileIO
+mkdir("models")
+mkdir("images")
+````
+
+### 2D Plots
+
+Then, let us consider a simple, 2D simplexified cartesian triangulation Ω
+
+````julia
+domain = (0, 1, 0, 1)
+cell_nums = (10, 10)
+model = CartesianDiscreteModel(domain, cell_nums) |> simplexify
+Ω = Triangulation(model)
+````
+
+The visualization of the vertices, edges, and faces of Ω can be achieved as follows
+
+````julia
+fig = plot(Ω)
+wireframe!(Ω, color=:black, linewidth=2)
+scatter!(Ω, marker=:star8, markersize=20, color=:blue)
+save("images/2d_Fig1.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/2d_Fig1.png" width="500"/>
+</p>
+
+We now consider a FE function `uh` constructed with Gridap
 
-![](_readme/images/arrows_3d_Vec3d_Fancy.png)
+````julia
+reffe = ReferenceFE(lagrangian, Float64, 1)
+V = FESpace(model, reffe)
+uh = interpolate(x->sin(π*(x[1]+x[2])), V)
+````
+
+and plot it over Ω, adding a colorbar
+
+````julia
+fig, _ , plt = plot(Ω, uh)
+Colorbar(fig[1,2], plt)
+save("images/2d_Fig11.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/2d_Fig11.png" width="500"/>
+</p>
+
+On the other hand, we may as well plot cell values
+
+````julia
+celldata = π*rand(num_cells(Ω)) .-1
+fig, _ , plt = plot(Ω, color=celldata, colormap=:heat)
+Colorbar(fig[2,1], plt, vertical=false)
+save("images/2d_Fig13.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/2d_Fig13.png" width="500"/>
+</p>
+
+If we are only interested in the boundary of Ω, namely Γ
+
+````julia
+Γ = BoundaryTriangulation(model)
+fig, _ , plt = plot(Γ, uh, colormap=:algae, linewidth=10)
+Colorbar(fig[1,2], plt)
+save("images/2d_Fig111.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/2d_Fig111.png" width="500"/>
+</p>
+
+### 3D Plots
+
+In addition to the 2D plots, GridapMakie is able to handle more complex geometries. For example,
+take the mesh from the [first Gridap tutorial](https://gridap.github.io/Tutorials/stable/pages/t001_poisson/#Tutorial-1:-Poisson-equation-1),
+which can be downloaded using
+
+````julia
+url = "https://github.com/gridap/GridapMakie.jl/raw/d5d74190e68bd310483fead8a4154235a61815c5/_readme/model.json"
+download(url,"models/model.json")
+````
+
+Therefore, we may as well visualize such mesh
+
+````julia
+model = DiscreteModelFromFile("models/model.json")
+Ω = Triangulation(model)
+∂Ω = BoundaryTriangulation(model)
+fig = plot(Ω, shading=true)
+wireframe!(∂Ω, color=:black)
+save("images/3d_Fig1.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/3d_Fig1.png" width="500"/>
+</p>
+
+````julia
+v(x) = sin(π*(x[1]+x[2]+x[3]))
+fig, ax, plt = plot(Ω, v, shading=true)
+Colorbar(fig[1,2], plt)
+save("images/3d_Fig2.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/3d_Fig2.png" width="500"/>
+</p>
+
+we can even plot functions in certain subdomains, e.g.
+
+````julia
+Γ = BoundaryTriangulation(model, tags=["square", "triangle", "circle"])
+fig = plot(Γ, v, colormap=:rainbow, shading=true)
+wireframe!(∂Ω, linewidth=0.5, color=:gray)
+save("images/3d_Fig3.png", fig)
+````
+
+<p align="center">
+<img src="_readme/images/3d_Fig3.png" width="500"/>
+</p>
+
+### Animations and interactivity
+
+Finally, by using Makie [Observables](https://makie.juliaplots.org/stable/interaction/nodes.html), we
+can create animations or interactive plots. For example, if the nodal field has a time dependence
+
+````julia
+t = Observable(0.0)
+u = lift(t) do t
+    x->sin(π*(x[1]+x[2]+x[3]))*cos(π*t)
+end
+fig = plot(Ω, u, colormap=:rainbow, shading=true, colorrange=(-1,1))
+wireframe!(∂Ω, color=:black, linewidth=0.5)
+framerate = 30
+timestamps = range(0, 2, step=1/framerate)
+record(fig, "images/animation.gif", timestamps; framerate=framerate) do this_t
+    t[] = this_t
+end
+````
+
+<p align="center">
+<img src="_readme/images/animation.gif" width="500"/>
+</p>
 
 ---
 

diff --git a/_readme/Project.toml b/_readme/Project.toml
@@ -1,5 +1,6 @@
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
+GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 Gridap = "56d4f2e9-7ea1-5844-9cf6-b9c51ca7ce8e"
 GridapMakie = "41f30b06-6382-4b60-a5f7-79d86b35bf5d"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"