Skip to content

Commit c834939

Browse files
committed
update docs
1 parent 02e7c7a commit c834939

File tree

4 files changed

+21
-0
lines changed

4 files changed

+21
-0
lines changed

docs/make.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,9 @@ makedocs(;
120120
"Gravity code" => "man/gravity_code.md",
121121
"Numerical model setups" => "man/geodynamic_setups.md",
122122
"LaMEM" => "man/lamem.md",
123+
"pTatin" => "man/lamem.md",
123124
"Profile Processing" => "man/profile_processing.md",
125+
"Gmsh" => "man/gmsh.md",
124126
"Movies" => "man/movies.md"
125127
],
126128
"List of functions" => "man/listfunctions.md",

docs/src/man/datastructures.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ For plotting, we transfer this into the `ParaviewData` structure, which has cart
88
GeoData
99
CartData
1010
UTMData
11+
Q1Data
12+
FEData
1113
ParaviewData
1214
lonlatdepth_grid
1315
xyz_grid

docs/src/man/gmsh.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Gmsh
2+
3+
[Gmsh](https://gmsh.info) is a widely used 3D unstructured mesh generator that produces tetrahedral meshes which can be tagged by region. It is possible to import such meshes and use that to set region info in a `GMG` data set, or use it to generate pTatin input.
4+
5+
```@docs
6+
GeophysicalModelGenerator.import_Gmsh
7+
```

docs/src/man/ptatin.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# pTatin
2+
3+
We provide a few routines that allow exporting GMG input data sets to a format that can be read by the 3D geodynamic modelling software [pTatin](https://bitbucket.org/dmay/ptatin-total-dev.git/src), which is an open-source Cartesian code to perform crustal and lithospheric-scale simulations.
4+
5+
The `Q1Data` format can be saved directly to pTatin.
6+
7+
```@docs
8+
GeophysicalModelGenerator.write_pTatin_mesh
9+
GeophysicalModelGenerator.swap_yz_dims
10+
```

0 commit comments

Comments
 (0)