Skip to content

Commit

Permalink
Update getting_started.md (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
ranocha authored Sep 13, 2024
1 parent 4574c77 commit e8cd25b
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ using Printf, CairoMakie # for I/O and plotting
In this introductory tutorial, we will use the CPU backend for simplicity:

```julia
arch = Arch(CPU())
backend = CPU()
arch = Arch(backend)
```

If a different backend is desired, one needs to load the relevant package accordingly. For example, if Nvidia or AMD GPUs are available, one can comment out `using CUDA` or `using AMDGPU` and make sure to use `arch = Arch(CUDABackend())` or `arch = Arch(ROCBackend())`, respectively, when selecting the architecture. For further information about executing on a single-device or multi-device architecture, see the documentation section for [Architectures](./concepts/architectures.md)
Expand Down Expand Up @@ -128,6 +129,20 @@ set!(C, grid, (_, _) -> rand())
bc!(arch, grid, C => Neumann(); exchange=C)
```

You should get a result like in the following plot.

```julia
fig = Figure()
ax = Axis(fig[1, 1];
aspect = DataAspect(),
xlabel = "x", ylabel = "y",
title = "it = 0")
plt = heatmap!(ax, centers(grid)..., interior(C) |> Array;
colormap = :turbo)
Colorbar(fig[1, 2], plt)
display(fig)
```

```@raw html
<div style="text-align: center;">
<img src="https://raw.githubusercontent.com/PTsolvers/Chmy.jl/main/docs/src/assets/field_set_ic_random.png" width="50%"/>
Expand All @@ -150,6 +165,18 @@ end

After running the simulation, you should see something like this, here the final result at `it = 100` for the field `C` is plotted:

```julia
fig = Figure()
ax = Axis(fig[1, 1];
aspect = DataAspect(),
xlabel = "x", ylabel = "y",
title = "it = 100")
plt = heatmap!(ax, centers(grid)..., interior(C) |> Array;
colormap = :turbo)
Colorbar(fig[1, 2], plt)
display(fig)
```

```@raw html
<div style="text-align: center;">
<img src="https://raw.githubusercontent.com/PTsolvers/Chmy.jl/main/docs/src/assets/diffusion_2d_it_100.png" width="50%"/>
Expand Down

0 comments on commit e8cd25b

Please sign in to comment.