Skip to content

Commit 2f038c2

Browse files
committed
Added documentation to the Setup_Geometry file
1 parent 9c08e12 commit 2f038c2

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

src/Setup_geometry.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,8 @@ end
757757
"""
758758
add_plate!(Phase, Temp, Grid::AbstractGeneralGrid; xlim=(), ylim=(), zlim::Tuple = (0.0,0.8), phase = ConstantPhase(1), T=nothing, segments=nothing, cell=false )
759759
760-
Adds a polygon with phase & temperature structure to a 3D model setup in the xy plane. This function extends the capabilities of `add_polygon!` by allowing the creation of polygons in the xy plane and projecting them along the z-axis, making it particularly useful for creating tectonic plates with varying geometries.
760+
Adds a tectonic plate with phase and temperature structure to a 3D model setup.
761+
This function enables the definition of tectonic plates in the xy plane and projects them along the z-axis, providing a flexible approach to model complex plate geometries.
761762
762763
Parameters
763764
==========
@@ -767,15 +768,15 @@ Parameters
767768
- `xlim` - `x`-coordinate of the polygon points, same ordering as ylim, number of points unlimited
768769
- `ylim` - `y`-coordinate of the polygon points, same ordering as xlim, number of points unlimited
769770
- `zlim` - `z`-coordinate range for projecting the polygon (start and stop, two values)
770-
- `phase` - Specifies the phase of the polygon. See `ConstantPhase()`
771-
- `T` - Specifies the temperature of the polygon. See `ConstantTemp()`, `LinearTemp()`, `HalfspaceCoolingTemp()`, `SpreadingRateTemp()`
771+
- `phase` - Specifies the phase of the plate. See `ConstantPhase()`
772+
- `T` - Specifies the temperature of the plate. See `ConstantTemp()`, `LinearTemp()`, `HalfspaceCoolingTemp()`, `SpreadingRateTemp()`
772773
- `segments` - Optional. Allows for thermal segmentation within the polygon. Useful for ridge systems or complex thermal structures.
773774
- `cell` - If true, `Phase` and `Temp` are defined on cell centers
774775
775776
Example
776777
========
777778
778-
Polygon in the xy plane with constant phase and temperature:
779+
Tectonic plate in the xy plane with phase and temperature structure:
779780
780781
```julia-repl
781782
julia> Grid = CartData(xyz_grid(x, y, z))

test/runtests.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ using Test
7878
include("test/test_ridge_segments.jl")
7979
end
8080

81+
@testset "Plate Tests" begin
82+
include("test/test_plate.jl")
83+
end
84+
8185
@testset "Waterflow" begin
8286
include("test_WaterFlow.jl")
8387
end

test/test_plate.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ using Test
3434

3535
# Add and save results
3636
Grid = addfield(Grid, (; Phases, Temp))
37-
write_paraview(Grid, "Plate")
37+
#write_paraview(Grid, "Plate")
3838

3939
@test minimum(Temp) >= 0.0 # Minimum temperature
4040
@test maximum(Temp) <= 1350.0 # Maximum temperature

0 commit comments

Comments
 (0)