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.

Sign up for GitHub

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

Sk/update basic examples and docstrings #96

Merged
merged 17 commits into from
Jul 15, 2024
Merged

Sk/update basic examples and docstrings #96

Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7bf8f80
Updated basic examples
SKopecz Jul 11, 2024
4009c33
Edited doc strings for MPRK and SSPMPRK schemes
SKopecz Jul 11, 2024
73bfa3a
Started tutorial for linear advection
SKopecz Jul 12, 2024
6769b68
spell check
SKopecz Jul 12, 2024
68615ad
documenter latex
SKopecz Jul 12, 2024
afc405f
extended tutorial
SKopecz Jul 12, 2024
a5f2b54
Update docs/make.jl
SKopecz Jul 15, 2024
c887c57
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
bd0bd0f
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
bf8b3be
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
a25f9b4
Updated Project.toml and improved tutorial for linear advection
SKopecz Jul 15, 2024
18a4a0f
N=1000 in linear advection tutorial
SKopecz Jul 15, 2024
e4ab817
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
f3a90c9
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
8cdb600
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
4d845d7
Update docs/src/linear_advection.md
SKopecz Jul 15, 2024
c37dbba
Added plot labels
SKopecz Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/src/linear_advection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,14 @@ nothing #hide
```@example LinearAdvection
using Plots

plot(x,u0)
plot!(x, last(sol.u))
plot(x, u0; label = "u0", xguide = "x", yguide = "u")
plot!(x, last(sol.u); label = "u")
```

### Using sparse matrices

TODO: Some text
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This TODO note is still open?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we take care of this once the sparse matrices work as expected.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough 👍


```@example LinearAdvection
using SparseArrays
p_prototype = spdiagm(-1 => ones(eltype(u0), N - 1),
Expand All @@ -107,10 +111,15 @@ nothing #hide
```

```@example LinearAdvection
plot(x,u0)
plot!(x, last(sol_sparse.u))
plot(x,u0; label = "u0", xguide = "x", yguide = "u")
plot!(x, last(sol_sparse.u); label = "u")
```

### Performance comparison

Finally, we use [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl)
to compare the performance of the different implementations.

```@example LinearAdvection
using BenchmarkTools
@benchmark solve(prob, MPRK43I(1.0, 0.5); save_everystep = false)
Expand Down