Skip to content

Commit 75b58e2

Browse files
committed
Fixed an error in solvePoisson.m. Added a new folder documentation/figures_from_the_paper, with live scripts for a few figures. Updated the readme with a new section explaining where to find code to produce each figure created using QGLAB.
1 parent 91731f6 commit 75b58e2

22 files changed

+66
-8
lines changed
70.8 KB
Binary file not shown.
76 KB
Binary file not shown.
210 KB
Binary file not shown.
193 KB
Binary file not shown.
93.5 KB
Binary file not shown.

documentation/templateGallery.mlx

-40.3 KB
Binary file not shown.

readme.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,41 @@ This will open up a project window. This does three things that allow you to run
2424

2525
In December, 2023, we submitted a paper describing the algorithms underlying QGLAB to a journal for publication. A slightly-modified version has been posted to the [arXiv](https://arxiv.org/abs/2401.00561).
2626

27-
2827
#### Documentation
2928

30-
Basic instructions are in a matlab live script `quantumGraphRoutines.mlx`, which has also been saved as an [html file](quantumGraphRoutines.html).
29+
Basic instructions are in a Matlab live script quantumGraphRoutines.mlx, which has also been saved as an HTML file](quantumGraphRoutines.html).
3130

3231
Many additional examples are presented in live scripts in directories `source/examples` and its subdirectories, and in `documentation`.
3332

3433
A wide variety of graphs are implemented in `source/templates`. These are demonstrated in `source/templates/templateGallery.mlx`.
3534

3635
If it doesn't make sense, just ask me.
3736

38-
#### QGLAB in action
37+
#### Reproducibility
38+
39+
There is a live script to reproduce every figure in the preprint that was produced using QGLAB. Some of the figures were edited interactively for clarity after being created by a script so that formatting may differ slightly. The following table lists the figures (numbered as on the arXiV while the paper remains under review).
40+
41+
| Figure | Description | file |
42+
| ----------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
43+
| 2.2 | Layout and Laplacian matrix ($\mathbf{L}_{\mathrm{VC}}$) nonzero pattern for lollipop graph | `documentation/figures_from_the_paper/figure2p2.mlx` |
44+
| 2.4 | Same as 2.2 but for Chebyshev and includes interpolation matrix $\mathbf{V}_0$ | `documentation/figures_from_the_paper/figure2p4.mlx` |
45+
| 2.5 and A.1 | Four eigenfunctions and spectral determinant for a Y-shaped graph | `documentation/figures_from_the_paper/figure2p5.mlx` |
46+
| 2.6 | Stationary NLS solutions on dumbbell and spiderweb graphs | `documentation/figures_from_the_paper/figure2p6.mlx` |
47+
| 2.7 & A.6 | Continuation study of NLS solutions on the necklace graph and two eigenfunctions | `source/examples/stationary/necklaceBifurcationDiagram.mlx` |
48+
| 2.8 and A.9 | Soliton solutions colliding with a vertex on balanced and unbalanced star graphs. | `source/examples/evolution/NLSOnBalancedStar23t.mlx` and `source/examples/evolution/NLSOnUnbalancedStar23t.mlx` |
49+
| 2.9 | KPP equation on a honeycomb | `source/examples/evolution/KPPonHoneycomb.mlx` |
50+
| 3.1 | Function plotting on graphs with 2D and 3D layout | `documentation/figures_from_the_paper/figure3p1.mlx` |
51+
| A.2 | QGLAB log (ground state of L-shaped quantum graph) | In `/documentation/templateGallery.mlx` |
52+
| A.3 | Solution of Poisson equation on a 3-node graph | `source/examples/stationary/poissonExample.mlx` and `source/examples/chebyshev/poissonExampleChebyshev.mlx` |
53+
| A.4 | Cubic NLS continuation study on a dumbbell graph | `documentation/continuationInstructions.mlx` contains these images and many more useful plotting routines for continuation studies |
54+
| A.5 | Cubic-Quintic NLS continuation on a dumbbell graph | `source/examples/stationary/dumbbellContinuation35.mlx` |
55+
| A.7 | Heat equation solution on dumbbell | `source/examples/evolution/heatOnDumbbell.mlx` also see `source/examples/evolution/heatOnDumbbellTestOrder.mlx` for convergence study |
56+
| A.8 | sine-Gordon equation on tetrahedron (flattened to Mercedes-Benz logo for plotting) | `source/examples/evolution/sineGordonOnTetra.mlx` |
57+
| B.2 | Visualization of a function defined on a random graph using `plot` and `pcolor` | Code in text |
58+
| B.3 | The "bubble tower" graph | Code in text |
59+
60+
#### QGLAB in action
61+
3962
This package (or earlier versions) has been used in the following papers:
4063

4164
* Goodman, R. H., [NLS bifurcations on the bowtie combinatorial graph and the dumbbell metric graph](http://doi.org/10.3934/dcds.2019093). *Discrete & Continuous Dynamical Systems - A*, *39*(4), 2203–2232, (2019).
@@ -53,7 +76,7 @@ and in the [2022 doctoral dissertation](https://cdr.lib.unc.edu/concern/disserta
5376
* More advanced IMEX time-steppers
5477
* More general vertex conditions
5578

56-
We are happy to consider adding features and/or to merge in contributions.
79+
We are happy to consider adding features and/or merging contributions.
5780

5881
If you use the package for published work, please cite it as
5982

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info/>
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info/>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info>
3+
<Category UUID="FileClassCategory">
4+
<Label UUID="design"/>
5+
</Category>
6+
</Info>

0 commit comments

Comments
 (0)