added linkers

Author: pritkc

doc/sphinx/source/index.md

@@ -78,7 +78,8 @@ math_functions/index
 :maxdepth: 2
 :caption: Examples
 
-examples/index
+examples/examples-doc/index
+
 ```
 
 ```{toctree}

examples/examples-doc/Elliptic/1D/Elliptic1D.md

@@ -22,4 +22,21 @@ $$
 au(1) + b\frac{du(1)}{dx} = 2e
 $$
 
-This corresponds to the call to robinBC2D of `robinBC2D(k, m, dx, a, b)`.
+This corresponds to the call to robinBC2D of `robinBC2D(k, m, dx, a, b)`.
+
+---
+
+This example is implemented in:
+- [MATLAB](../../../../matlab/Elliptic/1D/elliptic1D.m)
+- [C++](../../../../cpp/Elliptic/1D/elliptic1D.cpp)
+
+Additional MATLAB variants of this example with different boundary conditions:
+- [Homogeneous Dirichlet](../../../../matlab/Elliptic/1D/elliptic1DHomogeneousDirichlet.m)
+- [Non-Homogeneous Dirichlet](../../../../matlab/Elliptic/1D/elliptic1DNonHomogeneousDirichlet.m)
+- [Left Dirichlet, Right Neumann](../../../../matlab/Elliptic/1D/elliptic1DLeftDirichletRightNeumann.m)
+- [Left Dirichlet, Right Robin](../../../../matlab/Elliptic/1D/elliptic1DLeftDirichletRightRobin.m)
+- [Left Neumann, Right Neumann](../../../../matlab/Elliptic/1D/elliptic1DLeftNeumannRightNeumann.m)
+- [Left Neumann, Right Robin](../../../../matlab/Elliptic/1D/elliptic1DLeftNeumannRightRobin.m)
+- [Left Robin, Right Robin](../../../../matlab/Elliptic/1D/elliptic1DLeftRobinRightRobin.m)
+- [Periodic Boundary Conditions](../../../../matlab/Elliptic/1D/elliptic1DPeriodicBC.m)
+- [Non-Periodic Boundary Conditions](../../../../matlab/Elliptic/1D/elliptic1DNonPeriodicBC.m)

examples/examples-doc/Hyperbolic/1D/Burgers1D.md

@@ -12,4 +12,10 @@ $$
 u(x,0) = e^{\frac{-x^2}{50}}
 $$
 
-The wave is allowed to propagate across the domain while the area under the curve is calculated. 
+The wave is allowed to propagate across the domain while the area under the curve is calculated. 
+
+---
+
+This example is implemented in:
+- [MATLAB](../../../../matlab/Hyperbolic/1D/burgers1D.m)
+- [C++](../../../../cpp/Hyperbolic/1D/Burgers1D.cpp) 

examples/examples-doc/Hyperbolic/1D/Hyperbolic1D.md

@@ -36,4 +36,13 @@ $$
 
 $$
 U^{n+1}_i = U^n_i - a \Delta t \mathbf{D} U^n_i
-$$
+$$
+
+---
+
+This example is implemented in:
+- [MATLAB](../../../../matlab/Hyperbolic/1D/hyperbolic1D.m)
+
+Additional MATLAB variants:
+- [Upwind Scheme](../../../../matlab/Hyperbolic/1D/hyperbolic1D_upwind.m)
+- [Lax-Friedrichs Scheme](../../../../matlab/Hyperbolic/1D/hyperbolic1D_lax_friedrichs.m)

examples/examples-doc/Hyperbolic/1D/Transport1D.md

@@ -6,4 +6,9 @@ $$
 \frac{\partial C}{\partial t} + v\frac{\partial C}{\partial x} = D\frac{\partial^2 C}{\partial x^2}
 $$
 
-where $C$ is the concentration, $v$ is the pore-water flow velocity, and $D$ is the dispersion coefficient.
+where $C$ is the concentration, $v$ is the pore-water flow velocity, and $D$ is the dispersion coefficient.
+
+---
+
+This example is implemented in:
+- [C++](../../../../cpp/Hyperbolic/1D/transport1D.cpp)

examples/examples-doc/Hyperbolic/1D/Wave-1D.md

@@ -14,4 +14,13 @@ $$
 
 $$
 u'(x,0) = 0
-$$
+$$
+
+---
+
+This example is implemented in:
+- [MATLAB](../../../../matlab/Hyperbolic/1D/wave1D.m)
+
+Additional MATLAB variants:
+- [Wave 1D Case 2](../../../../matlab/Hyperbolic/1D/wave1D_case2.m)
+- [Wave 1D with Time-Varying BC](../../../../matlab/Hyperbolic/1D/wave1DTimeVaryingBC.m)

examples/examples-doc/Schrodinger/1D/Schrodinger1D.md

@@ -6,4 +6,9 @@ $$
 H \psi = E \psi
 $$
 
-where $H$ is the Hamiltonian operator, $\psi$ is the wave function, and $E$ is the energy. The Hamiltonian includes the kinetic energy term represented by the Laplacian and a potential energy term.
+where $H$ is the Hamiltonian operator, $\psi$ is the wave function, and $E$ is the energy. The Hamiltonian includes the kinetic energy term represented by the Laplacian and a potential energy term.
+
+---
+
+This example is implemented in:
+- [C++](../../../../cpp/Schrodinger/schrodinger1D.cpp)

examples/examples-doc/index.md

@@ -6,12 +6,38 @@ The MOLE library contains many examples written in OCTAVE/MATLAB and C++. These
 
 ```{toctree}
 :maxdepth: 2
-:caption: Examples
+:caption: Elliptic Problems
 
-README
-examples
-cpp/README
-matlab/compact_operators/README
+Elliptic/1D/Elliptic1D
+Elliptic/1D/Poisson1D
+Elliptic/2D/Elliptic2D
+Elliptic/2D/Elliptic2D-Case-2
+Elliptic/2D/Elliptic2D-Nodal-Curv
+Elliptic/2D/Elliptic2D-Nodal-Curv-Sinusoidal
+Elliptic/2D/Minimal-Poisson-2D
+Elliptic/3D/Elliptic3D
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: Hyperbolic Problems
+
+Hyperbolic/1D/Wave-1D
+Hyperbolic/1D/Wave-1D-Case-2
+Hyperbolic/1D/Transport1D
+Hyperbolic/1D/Burgers1D
+Hyperbolic/1D/Hyperbolic1D
+Hyperbolic/1D/Hyperbolic1D-upwind
+Hyperbolic/1D/Hyperbolic1D-Lax-Friedrichs
+Hyperbolic/2D/Wave-2D
+Hyperbolic/2D/Wave-2D-Case-2
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: Schrödinger Problems
+
+Schrodinger/1D/Schrodinger1D
 ```
 
 More examples will be added in the future.