Skip to content

Commit ee0402d

Browse files
committed
🙌🏼 Remove outdated documentation files
1 parent 0003c89 commit ee0402d

26 files changed

Lines changed: 89 additions & 749 deletions

docs/make.jl

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,19 @@ makedocs(
1515
"introduction/getstarted.md",
1616
"introduction/why.md",
1717
"introduction/ecosystem.md",
18-
"introduction/tips.md",
1918
],
20-
# "Interface" => Any[
21-
# "interface/structs.md",
22-
# "interface/backendagnostic.md",
23-
# "interface/kernelfunctions.md",
24-
# "interface/mpmprocess.md",
25-
# "interface/workflow.md",
26-
# "interface/imexport.md",
27-
# ],
28-
# "Tutorials" => Any[
29-
# "tutorials/example1.md",
30-
# "tutorials/example2.md",
31-
# "tutorials/example3.md"
32-
# ],
33-
# "Advanced Topics" => Any[
34-
# "advancedtopics/customkernel.md",
35-
# "advancedtopics/customconstitutive.md",
36-
# "advancedtopics/custommpmprocess.md",
37-
# "advancedtopics/customextension.md",
38-
# "advancedtopics/customfriction.md"
39-
# ],
40-
# "Useful Tools" => Any[
41-
# "utils/debug.md",
42-
# ]
19+
"DataType System" => Any[
20+
"datatype/backgroundgrid.md",
21+
],
22+
"Advanced Topics" => Any[
23+
"advancedtopics/plugin.md",
24+
],
25+
"Examples" => Any[
26+
"examples/example1.md",
27+
],
28+
"Others" => Any[
29+
"others/gpu.md",
30+
]
4331
],
4432
warnonly = [:missing_docs, :cross_references],
4533
)

docs/src/advancedtopics/customconstitutive.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/advancedtopics/customextension.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/advancedtopics/customfriction.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/advancedtopics/customkernel.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/advancedtopics/custommpmprocess.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/advancedtopics/plugin.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Plugin System
2+
3+
... todo
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Backgroud Grid

docs/src/examples/example1.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 2D Soil Collapse Test
2+
3+
!!! note
4+
5+
1) We use a classic example: 2D & 3D granular collapse[^1], to demonstrate how to establish computational models and solve them.
6+
2) To successfully run the code, we will install the dependencies at the beginning of the code provided below. If you are already familiar with the Julia Pkg ENV and have installed the necessary packages, you can ignore this part.
7+
3) We default to using Nvidia's GPU or x86/ARM CPUs. If you want to use other acceleration backends, please make modifications in the appropriate places in the code.
8+
4) We use Unicode to enhance readability (when comparing formulas), but sometimes it may be confused with regular letters, such as ``\nu`` and `v`. If you are using VSCode, you can enable the following in the settings:
9+
10+
```json
11+
"editor.unicodeHighlight.ambiguousCharacters": true,
12+
```
13+
14+
5) You can copy and save it in the `your_file.jl` and run the file directly using Julia in `REPL`:
15+
16+
```julia-repl
17+
julia> include("path/to/your_file.jl")
18+
```
19+
20+
Or run this file in the terminal:
21+
22+
```bash
23+
bash> julia path/to/your_file.jl
24+
```
25+
26+
[^1]: Bui, H.H., Fukagawa, R., Sako, K., Ohno, S., 2008. Lagrangian meshfree particles method (SPH) for large deformation and failure flows of geomaterial using elastic–plastic soil constitutive model. Int. J. Numer. Anal. Methods Geomech. 32, 1537–1570. https://doi.org/10.1002/nag.688
27+
28+
::: details Here is the complete 2D code
29+
30+
```julia
31+
using Pkg
32+
Pkg.add(["MaterialPointSolver", "MaterialPointGenerator", "CairoMakie", "CUDA"])
33+
using MaterialPointSolver
34+
using MaterialPointGenerator
35+
using CairoMakie
36+
using CUDA
37+
```
38+
39+
:::
40+
41+
## 2D model description
42+
43+
```@raw html
44+
<br>
45+
<img src="./figures/exp_model.png" width=50%>
46+
<br>
47+
```
48+
49+
In this example, aluminum bars are used to model the non-cohesive soil collapse. We use uGIMP to simulate the failure process of soil collapse. The geometry of the numerical model is depicted in the figure, with a length ``l`` of ``0.2\ m`` and a height ``h`` of ``0.1\ m``. The parameters of the numerical model are provided in the Table.
50+
51+
| Parameter | Value | Unit | Description |
52+
|:-----------:|:----------------:|:----------:|:----------------------:|
53+
| ``\rho`` | ``2650`` | ``kg/m^3`` | density |
54+
| ``\mu`` | ``0.3`` | - | Poisson's ratio |
55+
| ``K`` | ``7\times 10^5`` | ``Pa`` | bulk modulus |
56+
| ``t_{sim}`` | ``1.0`` | second | simulation time |
57+
| ``\phi`` | ``19.8`` | degree | friction angle |
58+
| ``\alpha`` | ``1.0`` | - | FLIP-PIC mixing factor |
59+
60+
## 2D code explaination

0 commit comments

Comments
 (0)