Skip to content

Commit d96ff36

Browse files
committed
Update
2 parents 60f379c + 35a96b4 commit d96ff36

18 files changed

+140
-76
lines changed

docs/make.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ makedocs(
3434
"2D" => "man/MomentumTwoD.md", # Checked!
3535
],
3636
],
37+
"Exercises" => Any[
38+
"01 - Euler Advection" => "man/exercises/01_Euler_Advection.md",
39+
"02 - Heat Diffusion (explicit)" => "man/exercises/02_1D_Heat_explicit.md",
40+
],
3741
"Examples" => Any[
3842
"General" => "man/Examples.md",
3943
"Diffusion Equation" => Any[

docs/src/assets/01_1D_Euler.gif

141 KB
Loading

docs/src/man/AdvectMain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ This criterion ensures that no particle is advected a greater distance than the
7979

8080
## Examples
8181

82-
- [2-D advection with constant velocity field](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection.jl)
83-
- [Resolution test of 2-D advection](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection_ResolutionTest.jl)
82+
- [2-D advection with constant velocity field](./examples/Advection2D.md)
83+
- [Resolution test of 2-D advection](./examples/AdvectionRestest2D.md)
8484

8585
See the [examples documentation](./Examples.md) for further details.
8686

docs/src/man/DiffMain.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ Currently, only *Dirichlet* and *Neumann* boundary conditions are supported. Mos
4848

4949
## Examples
5050

51-
- [1-D oceanic geotherm](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/1D/OceanicGeotherm_1D.jl)
52-
- [1-D continental geotherm](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/1D/ContinentalGeotherm_1D.jl)
53-
- [Comparison of FD schemes on a Gaussian anomaly](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/1D/Heat_1D_discretization.jl)
54-
- [2-D resolution test with Gaussian anomaly](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/2D/Gaussian_Diffusion.jl)
55-
- [2-D Poisson equation resolution test](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/2D/Poisson_ResTest.jl)
51+
- [1-D oceanic geotherm](./examples/OceanicGeotherm.md)
52+
- [1-D continental geotherm](./examples/ContinentalGeotherm.md)
53+
- [Comparison of FD schemes on a Gaussian anomaly](./examples/GaussianDiffusion1D.md)
54+
- [2-D resolution test with Gaussian anomaly](./examples/GaussianDiffusion2D.md)
55+
- [2-D Poisson equation resolution test](./examples/PoissonRestest.md)
5656

57-
For explanations, see the [examples documentation](./Examples.md) and the full [example directory](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/).
57+
For more details, see the full [example directory](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/).
5858

5959
## Exercises
6060

@@ -77,10 +77,9 @@ See the [advection documentation](./AdvectMain.md) and associated source code fo
7777

7878
## Examples
7979

80-
- [2-D advection with constant velocity field](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection.jl)
81-
- [Resolution test of 2-D advection](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection_ResolutionTest.jl)
80+
- [2-D advection with constant velocity field](./examples/Advection2D.md)
81+
- [Resolution test of 2-D advection](./examples/AdvectionRestest2D.md)
8282

83-
See the [examples documentation](./Examples.md) for further details.
8483

8584
## Exercises
8685

docs/src/man/DiffOneD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To solve Equation (3) numerically, the spatial domain must be discretized, assig
3232

3333
**Figure 1. 1D Discretization.** Conservative finite difference grid used to solve the 1D diffusive part of the temperature equation. Temperature is defined at centroids, while heat flux is defined at vertices. *Ghost nodes* are introduced to implement *Dirichlet* and *Neumann* boundary conditions.
3434

35-
The example script [Heat_1D_discretization.jl](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/1D/Heat_1D_discretization.jl) demonstrates various numerical schemes for solving the diffusive part of the temperature equation, including *explicit*, *implicit*, *Crank–Nicolson*, and *defect correction* methods. Below, these well-known schemes are briefly described and their respective strengths and limitations highlighted.
35+
The example script [Heat_1D_discretization.jl](./examples/GaussianDiffusion1D.md) demonstrates various numerical schemes for solving the diffusive part of the temperature equation, including *explicit*, *implicit*, *Crank–Nicolson*, and *defect correction* methods. Below, these well-known schemes are briefly described and their respective strengths and limitations highlighted.
3636

3737
## Explicit Finite Difference Scheme (FTCS; Forward Euler)
3838

docs/src/man/DiffTwoD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To numerically solve equation (3), the spatial domain must be discretized and th
3838

3939
**Figure 1. 2D Discretization.** *Conservative finite difference grid* for solving the 2D diffusive temperature equation. Temperature values are defined at the *centroids* (red circles), while heat fluxes are computed at the *vertices* (horizontal flux: blue crosses; vertical flux: green squares). *Ghost nodes* (grey circles) are used to implement *Dirichlet* and *Neumann* boundary conditions.
4040

41-
A detailed implementation of various numerical schemes is provided in the example script [Gaussian_Diffusion.jl](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/DiffusionEquation/2D/Gaussian_Diffusion.jl). This example demonstrates the application of several methods for solving the diffusive part of the 2D temperature equation:
41+
A detailed implementation of various numerical schemes is provided in the example script [Gaussian_Diffusion.jl](./examples/GaussianDiffusion2D.md). This example demonstrates the application of several methods for solving the diffusive part of the 2D temperature equation:
4242

4343
- **Explicit scheme**
4444
- **Fully implicit scheme**

docs/src/man/Ini.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ The input parameters are:
244244

245245
For more details please refer to the [source code](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/src/Tracers/2Dsolvers.jl).
246246

247-
>**Note:** Currently, temperature is not intended to be advected via tracers, as this would require the update of the tracer temperature via incremental changes rather than absolute value. Within the [2-D advection example](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection.jl) temperature advection is only used assuming non-diffusive process. Thus, no update of the tracer temperature is required!
247+
>**Note:** Currently, temperature is not intended to be advected via tracers, as this would require the update of the tracer temperature via incremental changes rather than absolute value. Within the [2-D advection example](./examples/Advection2D.md) temperature advection is only used assuming non-diffusive process. Thus, no update of the tracer temperature is required!
248248
249249
The advection of temperature and the update of the temperature field on the centroids is called, for example, like [here](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/AdvectionEquation/2D_Advection.jl):
250250

docs/src/man/MomentumMain.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,18 +85,17 @@ Together, the momentum and continuity equations allow solving for $v_x$, $v_y$,
8585

8686
The following examples demonstrate the application of the Stokes equations:
8787

88-
- [1D channel flow with constant and depth-dependent viscosity](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/1D/ChannelFlow_1D.jl)
89-
- [2D falling block benchmark](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/2D/FallingBlockBenchmark.jl)
90-
- [2D falling block with constant viscosity (defect correction)](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/2D/FallingBlockConstEta_DC.jl)
91-
- [2D falling block with variable viscosity (defect correction)](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/2D/FallingBlockVarEta_DC.jl)
92-
- [2D viscous inclusion problem](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/2D/ViscousInclusion.jl)
93-
- [2D Rayleigh–Taylor instability benchmark](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/StokesEquation/2D/RTI.jl)
88+
- [1D channel flow with constant and depth-dependent viscosity](./examples/ChannelFlow1D.md)
89+
- [2D falling block benchmark](./examples/FallingBlockBenchmark.md)
90+
- [2D falling block with constant viscosity (defect correction)](./examples/FallingBlockDC.md)
91+
- [2D falling block with variable viscosity (defect correction)](./examples/FallingBlockDC.md)
92+
- [2D viscous inclusion problem](./examples/ViscousInclusion.md)
93+
- [2D Rayleigh–Taylor instability benchmark](./examples/RTI_growth_rate.md)
9494

9595
Examples of coupled temperature–momentum systems (i.e., **convection models**) using **operator splitting** include:
9696

97-
- [Mixed heated convection models](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/examples/MixedHeatedConvection/)
97+
- [Mixed heated convection models](./examples/MixedHeatedConvection.md)
9898

99-
See the [examples documentation](./Examples.md) for further details.
10099

101100
## Exercises
102101

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# [01 - Euler Advection(1D)](https://github.com/GeoSci-FFM/GeoModBox.jl/blob/main/exercises/01_1D_Euler_Advection.ipynb)
2+
3+
This exercise focuses on starting programming with `Julia` and discretizing and solving a partial differential equation.
4+
5+
![Exercise1a](../../assets/01_1D_Euler.gif)
6+
7+
**Figure 1. 1-D Particle Advection.**

docs/src/man/exercises/02_1D_Heat_explicit.md

Whitespace-only changes.

0 commit comments

Comments
 (0)