add docs

JuliaGeodynamics · Mar 2, 2024 · a178b6a · a178b6a
1 parent ff2a2f6
commit a178b6a
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -18,7 +18,9 @@ The following people contributed major additions or modifications to Geophysical
 are listed in alphabetical order:
 
 * Pascal Aellig
+* Albert De Montserrat
 * Luca De Siena
+* Lukas Fuchs
 * Andrea Piccolo
 * Hendrik Rachona
 * Christian Schuler

diff --git a/docs/make.jl b/docs/make.jl
@@ -105,6 +105,7 @@ makedocs(;
             "Data Structures" =>  "man/datastructures.md",
             "Data Import" =>  "man/dataimport.md",
             "Projection" =>  "man/projection.md",
+            "Surfaces" =>  "man/surfaces.md",
             "Paraview output" => "man/paraview_output.md",
             "Tools" => "man/tools.md",
             "Visualisation" => "man/visualise.md",

diff --git a/docs/src/man/surfaces.md b/docs/src/man/surfaces.md
@@ -0,0 +1,15 @@
+# Surfaces
+
+We have a number of functions to deal with horizontal surfaces, which are defined as `GeoData` or `CartData` structures that have 3 dimensional `flat` coordinate array. Flat implies that the resolution is `n` by `m` by `1`, which is required to correctly display them in paraview.
+The most straightforward surface is the topography (which you can obtain with `ImportTopo`).
+Surfaces can be added and subtracted.
+
+```@docs
+drape_on_topo
+fit_surface_to_points
+aboveSurface
+belowSurface
+interpolateDataOnSurface
+is_surface
+remove_NaN_Surface!
+```
diff --git a/src/surface_functions.jl b/src/surface_functions.jl
@@ -238,9 +238,9 @@ function aboveSurface(Data::GeoData, DataSurface::GeoData; above=true)
     DepthSurface = DepthSurface*unit(DataSurface.depth.val[1])
 
     if above
-        Above       =   Data.depth.val .> DepthSurface;
+        Above    =   Data.depth.val .> DepthSurface;
     else
-        Above       =   Data.depth.val .< DepthSurface;
+        Above    =   Data.depth.val .< DepthSurface;
     end
 
     return Above
@@ -323,8 +323,6 @@ function belowSurface(Data_Cart::CartData, DataSurface_Cart::CartData)
     return aboveSurface(Data_Cart::CartData, DataSurface_Cart::CartData; above=false)
 end
 
-
-
 """
     Surf_interp = interpolateDataOnSurface(V::ParaviewData, Surf::ParaviewData)