Skip to content

Commit 18af0a4

Browse files
committed
update tutorials
1 parent ff6c38e commit 18af0a4

20 files changed

+139
-139
lines changed

docs/src/man/Tutorial_Basic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,10 @@ In creating this image, I used the `Clip` tool of Paraview to only show topograp
204204
### 4. Cartesian data
205205
As you can see, the curvature or the Earth is taken into account here. Yet, for many applications it is more convenient to work in Cartesian coordinates (kilometers) rather then in geographic coordinates.
206206
`GeophysicalModelGenerator` has a number of tools for this.
207-
First we need do define a `ProjectionPoint` around which we project the data
207+
First we need do define a `projectionPoint` around which we project the data
208208

209209
```julia
210-
proj = ProjectionPoint(Lon=12.0,Lat =43)
210+
proj = projectionPoint(Lon=12.0,Lat =43)
211211

212212
Topo_cart = convert2CartData(Topo_Alps, proj)
213213
```

docs/src/man/Tutorial_Jura.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ Moreover, the resolution of the grids is different. Whereas the `TopoGeology` ha
100100
It is often useful to have them on exactly the same size grid
101101

102102
We can do this in two steps:
103-
First, we define a `ProjectionPoint` along which we perform the projection
103+
First, we define a `projectionPoint` along which we perform the projection
104104

105105
```julia
106-
proj = ProjectionPoint(Lon=6, Lat=46.5)
106+
proj = projectionPoint(Lon=6, Lat=46.5)
107107
```
108108

109109
We can simply transfer the TopoGeology map to Cartesian values with:

docs/src/man/Tutorial_LaPalma.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ In order to create model setups, it is helpful to first transfer the data to Car
6565
This requires us to first determine a *projection point*, that is fixed. Often, it is helpful to use the center of the topography for this. In the present example, we will center the model around La Palma itself:
6666

6767
```julia
68-
proj = ProjectionPoint(Lon=-17.84, Lat=28.56)
68+
proj = projectionPoint(Lon=-17.84, Lat=28.56)
6969
```
7070

7171
Once this is done you can convert the topographic data to the cartesian reference frame

docs/src/man/Tutorial_NumericalModel_2D.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ using GeophysicalModelGenerator
1717
nx,nz = 512,128
1818
x = range(-1000,1000, nx);
1919
z = range(-660,0, nz);
20-
Grid2D = CartData(XYZGrid(x,0,z))
20+
Grid2D = CartData(xyzGrid(x,0,z))
2121
```
2222

2323
````
@@ -47,13 +47,13 @@ Temp = fill(1350.0, nx, 1, nz);
4747
We will start with a simple subduction setup, which consists of a horizontal part:
4848

4949
```julia
50-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = ConstantPhase(1));
50+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = ConstantPhase(1));
5151
```
5252

5353
And with the inclined part:
5454

5555
```julia
56-
AddBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = ConstantPhase(1), DipAngle=30);
56+
addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = ConstantPhase(1), DipAngle=30);
5757
```
5858

5959
Add them to the `CartData` dataset:
@@ -75,7 +75,7 @@ CartData
7575
Which looks like
7676

7777
```julia
78-
Write_Paraview(Grid2D,"Grid2D_SubductionMechanical");
78+
write_Paraview(Grid2D,"Grid2D_SubductionMechanical");
7979
```
8080

8181
````
@@ -100,15 +100,15 @@ LithosphericPhases([15 55], [1 2], nothing)
100100
and set the slab again:
101101

102102
```julia
103-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith);
104-
AddBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, DipAngle=30);
103+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith);
104+
addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, DipAngle=30);
105105
```
106106

107107
Which looks like:
108108

109109
```julia
110110
Grid2D = addField(Grid2D,(;Phases, Temp))
111-
Write_Paraview(Grid2D,"Grid2D_SubductionMechanicalLayered");
111+
write_Paraview(Grid2D,"Grid2D_SubductionMechanicalLayered");
112112
```
113113

114114
````
@@ -124,15 +124,15 @@ We can do that by specifying a thermal structure. For example, we can use the ha
124124

125125
```julia
126126
therm = HalfspaceCoolingTemp(Age=40)
127-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=therm);
128-
AddBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, T = therm, DipAngle=30);
127+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=therm);
128+
addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, T = therm, DipAngle=30);
129129
```
130130

131131
Which looks like:
132132

133133
```julia
134134
Grid2D = addField(Grid2D,(;Phases, Temp))
135-
Write_Paraview(Grid2D,"Grid2D_SubductionHalfspaceCooling");
135+
write_Paraview(Grid2D,"Grid2D_SubductionHalfspaceCooling");
136136
```
137137

138138
````
@@ -159,13 +159,13 @@ a spreading velocity (note that this simply relates to the thermal structure and
159159

160160
```julia
161161
lith = LithosphericPhases(Layers=[15 55], Phases=[1 2], Tlab=1250)
162-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
162+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
163163
```
164164

165165
For the subduction we use a thermal structure of a slab heated by hot asthenosphere
166166

167167
```julia
168-
AddBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, T = McKenzie_subducting_slab(Tsurface=0,v_cm_yr=3), DipAngle=30);
168+
addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, T = McKenzie_subducting_slab(Tsurface=0,v_cm_yr=3), DipAngle=30);
169169
```
170170

171171
We can set the mantle lithosphere that is hotter > 1250 C to mantle:
@@ -175,7 +175,7 @@ ind = findall(Temp .> 1250 .&& Phases .==2);
175175
Phases[ind] .= 0;
176176

177177
Grid2D = addField(Grid2D,(;Phases, Temp))
178-
Write_Paraview(Grid2D,"Grid2D_SubductionRidge");
178+
write_Paraview(Grid2D,"Grid2D_SubductionRidge");
179179
```
180180

181181
````
@@ -190,21 +190,21 @@ Ok, lets add an overriding slab as well. For this, we use the `AddLayer!` functi
190190

191191
```julia
192192
lith = LithosphericPhases(Layers=[15 20 55], Phases=[3 4 5], Tlab=1250)
193-
AddBox!(Phases, Temp, Grid2D; xlim=(0,1000), zlim=(-80.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
193+
addBox!(Phases, Temp, Grid2D; xlim=(0,1000), zlim=(-80.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
194194
```
195195

196196
The oceanic plate is as before
197197

198198
```julia
199199
lith = LithosphericPhases(Layers=[15 55], Phases=[1 2], Tlab=1250)
200-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
200+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
201201
```
202202

203203
For the inclined part, we set a layer above the slab (the "weak" layer to facilitate subduction initiation )
204204

205205
```julia
206206
lith = LithosphericPhases(Layers=[10 15 55], Phases=[6 1 2], Tlab=1250)
207-
AddBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 10.0), phase = lith, T = McKenzie_subducting_slab(Tsurface=0,v_cm_yr=3), DipAngle=30);
207+
addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 10.0), phase = lith, T = McKenzie_subducting_slab(Tsurface=0,v_cm_yr=3), DipAngle=30);
208208
```
209209

210210
Lithosphere-asthenosphere boundary:
@@ -214,7 +214,7 @@ ind = findall(Temp .> 1250 .&& Phases .==2);
214214
Phases[ind] .= 0;
215215

216216
Grid2D = addField(Grid2D,(;Phases, Temp))
217-
Write_Paraview(Grid2D,"Grid2D_SubductionOverriding");
217+
write_Paraview(Grid2D,"Grid2D_SubductionOverriding");
218218
```
219219

220220
````
@@ -225,18 +225,18 @@ Saved file: Grid2D_SubductionOverriding.vts
225225
![Mechanical2D_Tutorial_5](../assets/img/Mechanical2D_Tutorial_5.png)
226226

227227
#### Curved slab - mechanics
228-
So far, the subducting part of the slab was always straight. We can also create a curved slab by using the `AddSlab!` function. This uses a parametric representation of the slab and is a bit more involved than the `AddBox!` function.
228+
So far, the subducting part of the slab was always straight. We can also create a curved slab by using the `addSlab!` function. This uses a parametric representation of the slab and is a bit more involved than the `addBox!` function.
229229

230230
We start with the horizontal part:
231231

232232
```julia
233233
nx,nz = 512,128
234234
x = range(-1000,1000, nx);
235235
z = range(-660,0, nz);
236-
Grid2D = CartData(XYZGrid(x,0,z))
236+
Grid2D = CartData(xyzGrid(x,0,z))
237237
Phases = zeros(Int64, nx, 1, nz);
238238
Temp = fill(1350.0, nx, 1, nz);
239-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = ConstantPhase(1));
239+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-80.0, 0.0), phase = ConstantPhase(1));
240240
```
241241

242242
Next, we should define a `Trench` structure, which contains info about the trench which goes in 3D from `Start` - `End` coordinates (`x`,`y`)-coordinates respectively. As we are dealing with a 2D model, we set the `y`-coordinates to -100.0 and 100.0 respectively.
@@ -251,7 +251,7 @@ Add them to the `CartData` dataset:
251251

252252
```julia
253253
Grid2D = addField(Grid2D,(;Phases, Temp))
254-
Write_Paraview(Grid2D,"Grid2D_SubductionCurvedMechanical");
254+
write_Paraview(Grid2D,"Grid2D_SubductionCurvedMechanical");
255255
```
256256

257257
````
@@ -271,7 +271,7 @@ Our starting basis is the example above with ridge and overriding slab
271271
nx,nz = 512,128
272272
x = range(-1000,1000, nx);
273273
z = range(-660,0, nz);
274-
Grid2D = CartData(XYZGrid(x,0,z))
274+
Grid2D = CartData(xyzGrid(x,0,z))
275275
Phases = zeros(Int64, nx, 1, nz);
276276
Temp = fill(1350.0, nx, 1, nz);
277277
lith = LithosphericPhases(Layers=[15 20 55], Phases=[3 4 5], Tlab=1250)
@@ -284,16 +284,16 @@ LithosphericPhases([15 20 55], [3 4 5], 1250)
284284
Lets start with defining the horizontal part of the overriding plate. Note that we define this twice with different thickness to deal with the bending subduction area:
285285

286286
```julia
287-
AddBox!(Phases, Temp, Grid2D; xlim=(200,1000), zlim=(-150.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
288-
AddBox!(Phases, Temp, Grid2D; xlim=(0,200), zlim=(-50.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
287+
addBox!(Phases, Temp, Grid2D; xlim=(200,1000), zlim=(-150.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
288+
addBox!(Phases, Temp, Grid2D; xlim=(0,200), zlim=(-50.0, 0.0), phase = lith, T=HalfspaceCoolingTemp(Age=80));
289289
```
290290

291291
The horizontal part of the oceanic plate is as before:
292292

293293
```julia
294294
v_spread_cm_yr = 3 #spreading velocity
295295
lith = LithosphericPhases(Layers=[15 55], Phases=[1 2], Tlab=1250)
296-
AddBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-150.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=v_spread_cm_yr));
296+
addBox!(Phases, Temp, Grid2D; xlim=(-800,0.0), zlim=(-150.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=v_spread_cm_yr));
297297
```
298298

299299
Yet, now we add a trench as well. The starting thermal age at the trench is that of the horizontal part of the oceanic plate:
@@ -331,7 +331,7 @@ ind = findall(Temp .> 1250 .&& (Phases.==2 .|| Phases.==5));
331331
Phases[ind] .= 0;
332332

333333
Grid2D = addField(Grid2D,(;Phases, Temp))
334-
Write_Paraview(Grid2D,"Grid2D_SubductionCurvedOverriding");
334+
write_Paraview(Grid2D,"Grid2D_SubductionCurvedOverriding");
335335
```
336336

337337
````

docs/src/man/Tutorial_NumericalModel_3D.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ nx,ny,nz = 512,512,128
1818
x = range(-1000,1000, nx);
1919
y = range(-1000,1000, ny);
2020
z = range(-660,0, nz);
21-
Grid = CartData(XYZGrid(x,y,z));
21+
Grid = CartData(xyzGrid(x,y,z));
2222
```
2323

2424
Now we create an integer array that will hold the `Phases` information (which usually refers to the material or rock type in the simulation)
@@ -43,15 +43,15 @@ Note that if the lowermost layer has the same phase as the mantle, you can defin
4343

4444
```julia
4545
lith = LithosphericPhases(Layers=[15 45 10], Phases=[0 1 2], Tlab=1250)
46-
AddBox!(Phases, Temp, Grid; xlim=(-800,0.0), ylim=(-400, 400.0), zlim=(-80.0, 0.0), phase = lith,
46+
addBox!(Phases, Temp, Grid; xlim=(-800,0.0), ylim=(-400, 400.0), zlim=(-80.0, 0.0), phase = lith,
4747
Origin=(-0,0,0),
4848
T=SpreadingRateTemp(SpreadingVel=3, MORside="right"), StrikeAngle=30);
4949
```
5050

5151
And an an inclined part:
5252

5353
```julia
54-
AddBox!(Phases, Temp, Grid; xlim=(0,300), ylim=(-400, 400.0), zlim=(-80.0, 0.0), phase = lith,
54+
addBox!(Phases, Temp, Grid; xlim=(0,300), ylim=(-400, 400.0), zlim=(-80.0, 0.0), phase = lith,
5555
Origin=(-0,0,0),
5656
T=McKenzie_subducting_slab(Tsurface=0,v_cm_yr=3), DipAngle=30, StrikeAngle=30);
5757
```
@@ -75,7 +75,7 @@ CartData
7575
Which looks like
7676

7777
```julia
78-
Write_Paraview(Grid,"Grid3D_FreeSubduction");
78+
write_Paraview(Grid,"Grid3D_FreeSubduction");
7979
```
8080

8181
````
@@ -94,7 +94,7 @@ nx,ny,nz = 512,512,128
9494
x = range(-1000,1000, nx);
9595
y = range(-1000,1000, ny);
9696
z = range(-660,0, nz);
97-
Grid = CartData(XYZGrid(x,y,z));
97+
Grid = CartData(xyzGrid(x,y,z));
9898

9999
Phases = fill(2,nx,ny,nz);
100100
Temp = fill(1350.0, nx,ny,nz);
@@ -104,27 +104,27 @@ Overriding plate with a 30 km crust and mantle lithosphere that where T<1250 cel
104104

105105
```julia
106106
lith_cont = LithosphericPhases(Layers=[30 200 50], Phases=[3 4 2], Tlab=1250)
107-
AddBox!(Phases, Temp, Grid; xlim=(400,1000), ylim=(-1000, 0.0), zlim=(-240.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=150));
108-
AddBox!(Phases, Temp, Grid; xlim=(200,1000), ylim=(-1000, 0.0), zlim=(-80.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=150));
107+
addBox!(Phases, Temp, Grid; xlim=(400,1000), ylim=(-1000, 0.0), zlim=(-240.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=150));
108+
addBox!(Phases, Temp, Grid; xlim=(200,1000), ylim=(-1000, 0.0), zlim=(-80.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=150));
109109

110110
lith_cont = LithosphericPhases(Layers=[30 200 10], Phases=[5 6 2], Tlab=1250)
111-
AddBox!(Phases, Temp, Grid; xlim=(400,1000), ylim=(0, 1000), zlim=(-240.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=200));
112-
AddBox!(Phases, Temp, Grid; xlim=(200,1000), ylim=(0, 1000), zlim=( -80.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=200));
111+
addBox!(Phases, Temp, Grid; xlim=(400,1000), ylim=(0, 1000), zlim=(-240.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=200));
112+
addBox!(Phases, Temp, Grid; xlim=(200,1000), ylim=(0, 1000), zlim=( -80.0, 0.0), phase = lith_cont, T=HalfspaceCoolingTemp(Age=200));
113113
```
114114

115115
Define an oceanic plate with ridge
116116

117117
```julia
118118
v_spread_cm_yr = 3 #spreading velocity
119119
lith = LithosphericPhases(Layers=[15 45 10], Phases=[0 1 2], Tlab=1250)
120-
AddBox!(Phases, Temp, Grid; xlim=(-800 , 200), ylim=(-1000, -400.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
121-
AddBox!(Phases, Temp, Grid; xlim=(-1000,-800), ylim=(-1000, -400.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
120+
addBox!(Phases, Temp, Grid; xlim=(-800 , 200), ylim=(-1000, -400.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
121+
addBox!(Phases, Temp, Grid; xlim=(-1000,-800), ylim=(-1000, -400.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
122122

123-
AddBox!(Phases, Temp, Grid; xlim=(-700, 200), ylim=(-400, 200.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
124-
AddBox!(Phases, Temp, Grid; xlim=(-1000,-700), ylim=(-400, 200.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
123+
addBox!(Phases, Temp, Grid; xlim=(-700, 200), ylim=(-400, 200.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
124+
addBox!(Phases, Temp, Grid; xlim=(-1000,-700), ylim=(-400, 200.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
125125

126-
AddBox!(Phases, Temp, Grid; xlim=(-650, 200), ylim=(200, 1000.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
127-
AddBox!(Phases, Temp, Grid; xlim=(-1000,-650), ylim=(200, 1000.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
126+
addBox!(Phases, Temp, Grid; xlim=(-650, 200), ylim=(200, 1000.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3));
127+
addBox!(Phases, Temp, Grid; xlim=(-1000,-650), ylim=(200, 1000.0), zlim=(-80.0, 0.0), phase = lith, T=SpreadingRateTemp(SpreadingVel=3,MORside="right"));
128128
```
129129

130130
Subducting parts of the oceanic plate
@@ -163,7 +163,7 @@ Finally, we can add all this to the `CartData` dataset:
163163

164164
```julia
165165
Grid = addField(Grid,(;Phases, Temp))
166-
Write_Paraview(Grid,"Grid3D_Ridges");
166+
write_Paraview(Grid,"Grid3D_Ridges");
167167
```
168168

169169
````

docs/src/man/datastructures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Data structures
22

33
The main data structure used in GeophysicalModelGenerator.jl is `GeoData`, which contains info about the `longitude`,`latitude`, and `depth` of a data set, as well as several data sets itself.
4-
We also provide a `UTMData`, which is essentially the same but with UTM coordinates, and a `CartData` structure, which has Cartesian coordinates in kilometers (as used in many geodynamic codes). If one wishes to transfer `GeoData` to `CartData`, one needs to provide a `ProjectionPoint`.
4+
We also provide a `UTMData`, which is essentially the same but with UTM coordinates, and a `CartData` structure, which has Cartesian coordinates in kilometers (as used in many geodynamic codes). If one wishes to transfer `GeoData` to `CartData`, one needs to provide a `projectionPoint`.
55
For plotting, we transfer this into the `ParaviewData` structure, which has cartesian coordinates centered around the center of the Earth. We employ the `wgs84` reference ellipsoid as provided by the [Geodesy.jl](https://github.com/JuliaGeo/Geodesy.jl) package to perform this transformation.
66

77
```@docs
@@ -11,5 +11,5 @@ UTMData
1111
ParaviewData
1212
lonlatdepthGrid
1313
xyzGrid
14-
ProjectionPoint
14+
projectionPoint
1515
```

docs/src/man/projection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Typically, you load a dataset by reading it into julia and either generating a `
44

55
If you write the data to `Paraview`, it is internally converted to a Paraview structure (which involves `x,y,z` Cartesian Earth-Centered-Earth-Fixed (ECEF) coordinates using the `wgs84` ellipsoid).
66

7-
Yet, if you do geodynamic calculations the chances are that the geodynamic code does not operate in spherical coordinates, but rather use cartesian ones. In that case you should transfer your data to the `CartData` structure, which requires you to specify a `ProjectionPoint` that is a point on the map that will later have the coordinates `(0,0)` in the `CartData` structure.
7+
Yet, if you do geodynamic calculations the chances are that the geodynamic code does not operate in spherical coordinates, but rather use cartesian ones. In that case you should transfer your data to the `CartData` structure, which requires you to specify a `projectionPoint` that is a point on the map that will later have the coordinates `(0,0)` in the `CartData` structure.
88

99

1010
#### 1. Converting
@@ -41,8 +41,8 @@ As the area is large, it covers a range of `UTM` zones (and every point has a UT
4141
Yet, what we could do instead is show all data with respect to a single UTM zone. For this, we have to select a point around which we project (in this case more or less in the center):
4242

4343
```julia
44-
julia> p=ProjectionPoint(Lon=17.3, Lat=37.5)
45-
ProjectionPoint(37.5, 17.3, 703311.4380385976, 4.152826288024972e6, 33, true)
44+
julia> p=projectionPoint(Lon=17.3, Lat=37.5)
45+
projectionPoint(37.5, 17.3, 703311.4380385976, 4.152826288024972e6, 33, true)
4646
```
4747

4848
Projecting the `GeoData` set using this projection point is done with:

docs/src/man/visualise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Which will look like:
3636

3737
This is an example where we used `GeoData` to visualize results. Alternatively, we can also visualize results in km (often more useful for numerical modelling setups). For `Visualize` to work with this, we however need orthogonal cartesian data, which can be obtained by projecting both the data.
3838
```julia
39-
julia> p=ProjectionPoint(Lon=10, Lat=45)
40-
ProjectionPoint(45.0, 10.0, 578815.302916711, 4.983436768349297e6, 32, true)
39+
julia> p=projectionPoint(Lon=10, Lat=45)
40+
projectionPoint(45.0, 10.0, 578815.302916711, 4.983436768349297e6, 32, true)
4141
julia> Data_Cart = CartData(xyzGrid(-600:10:600,-600:10:600,-1000:10:-1));
4242
julia> Topo_Cart = CartData(xyzGrid(-600:10:600,-600:10:600,0));
4343
julia> Topo_Cart = projectCartData(Topo_Cart, Topo, p)

src/Setup_geometry.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ julia> write_Paraview(Model3D,"LaMEM_ModelSetup") # Save model to para
174174
175175
Example 2) Box with halfspace cooling profile
176176
```julia
177-
julia> Grid = CartData(XYZGrid(-1000:10:1000,0,-660:10:0))
177+
julia> Grid = CartData(xyzGrid(-1000:10:1000,0,-660:10:0))
178178
julia> Phases = zeros(Int32, size(Grid));
179179
julia> Temp = zeros(Float64, size(Grid));
180180
julia> addBox!(Phases,Temp,Grid, xlim=(0,500), zlim=(-50,0), phase=ConstantPhase(3), DipAngle=10, T=HalfspaceCoolingTemp(Age=30))

0 commit comments

Comments
 (0)