voxel_gravity.jl

Author: boriskaus

docs/src/man/gravity_code.md

@@ -1,7 +1,7 @@
 # Gravity code
 
-The `voxGrav` function allows for the voxel-based computation of Bouguer anomalies and gradients from a 3D density matrix.
+The `voxel_grav` function allows for the voxel-based computation of Bouguer anomalies and gradients from a 3D density matrix.
 
 ```@docs
-GeophysicalModelGenerator.voxGrav
+GeophysicalModelGenerator.voxel_grav
 ```

src/GeophysicalModelGenerator.jl

@@ -13,7 +13,7 @@ export
         km, m, cm, mm, Myrs, yr, s, MPa, Pa, Pas, K, C, kg, mol,
         isDimensional, Value, NumValue, Unit, UnitValue
 
-export ReadCSV_LatLon, meshgrid, voxGrav
+export ReadCSV_LatLon, meshgrid, voxel_grav
 
 abstract type AbstractGeneralGrid end                                    # general grid types
 

src/voxel_gravity.jl

@@ -7,30 +7,30 @@
 using Printf            # do we need this?
 using Statistics        # do we need that?
 
-export voxGrav
+export voxel_grav
 
 """
-    voxGrav(X::Array{Float64, 3}, Y::Array{Float64, 3}, Z::Array{Float64, 3}, RHO::Array{Float64, 3};
+    voxel_grav(X::Array{Float64, 3}, Y::Array{Float64, 3}, Z::Array{Float64, 3}, RHO::Array{Float64, 3};
     refMod="AVG", lengthUnit="m", rhoTol=1e-9, Topo=[], outName="Bouguer", printing=true)
 
-    Computes Bouguer anomalies and gradients
-
-    Required arguments:
-    X,Y,Z:       3D matrices with the coordinates of the grid (X should vary in the first dimension, Y in the second, Z (vertical) in the third)
-    RHO:         3D matrix with the density at each grid point [kg/m^3]
-
-    Optional arguments:
-    refMod:      1D vector with the reference density for each depth
-                 Alternatively, the strings "NE", "SE", "SW", "NW", "AVG" can be used.
-                 In that case, one of the corners of `RHO` is used as reference model.
-                 In case of "AVG" the reference model is the average of each depth slice.
-    lengthUnit:  The unit of the coordinates and topography file. Either "m" or "km"
-    rhoTol:      density differences smaller than rhoTol will be ignored [kg/m^3]
-    Topo:        2D matrix with the topography of the surface (only relevant for the paraview output)
-    outName:     name of the paraview output (do not include file type)
-    printing:    activate printing of additional information [true or false]
+Computes Bouguer anomalies and gradients
+
+Required arguments:
+===
+- `X`,`Y`,`Z`:       3D matrices with the coordinates of the grid (X should vary in the first dimension, Y in the second, Z (vertical) in the third)
+- `RHO`:         3D matrix with the density at each grid point [kg/m^3]
+
+
+Optional arguments:
+===
+- `refMod`:      1D vector with the reference density for each depth. Alternatively, the strings "NE", "SE", "SW", "NW", "AVG" can be used. In that case, one of the corners of `RHO` is used as reference model.In case of "AVG" the reference model is the average of each depth slice.
+- `lengthUnit`:  The unit of the coordinates and topography file. Either "m" or "km"
+- `rhoTol`:      density differences smaller than `rhoTol` will be ignored [kg/m^3]
+- `Topo`:        2D matrix with the topography of the surface (only relevant for the paraview output)
+- `outName`:     name of the paraview output (do not include file type)
+- `printing`:    activate printing of additional information [`true` or `false`]
 """
-function voxGrav(X::Array{Float64, 3}, Y::Array{Float64, 3}, Z::Array{Float64, 3}, RHO::Array{Float64, 3};
+function voxel_grav(X::Array{Float64, 3}, Y::Array{Float64, 3}, Z::Array{Float64, 3}, RHO::Array{Float64, 3};
                  refMod="AVG", lengthUnit="m", rhoTol=1e-9, Topo=[], outName="Bouguer", printing=true)
 
     ## check input

test/gmt.history

@@ -1,8 +1,4 @@
 # GMT 6 Session common arguments shelf
-BEGIN GMT 6.5.0
-B	afWSen
-J	X
-JX	X15c/0
+BEGIN GMT 6.6.0
 R	50/51/30/31
-@L	1
 END

test/test_voxel_gravity.jl

@@ -70,13 +70,13 @@ for iS = 1 : numSpheres
 end
 
 # Voxel Code
-dg1, gradX1, gradY1 = voxGrav(X, Y, Z, RHO, refMod = RefMod, outName = "Benchmark1", printing = false)
+dg1, gradX1, gradY1 = voxel_grav(X, Y, Z, RHO, refMod = RefMod, outName = "Benchmark1", printing = false)
 
 # Other options (same result)
-dg2, gradX2, gradY2 = voxGrav(X, Y, Z, RHO, rhoTol = 1, refMod = "SW", outName = "Benchmark2", printing = false)
+dg2, gradX2, gradY2 = voxel_grav(X, Y, Z, RHO, rhoTol = 1, refMod = "SW", outName = "Benchmark2", printing = false)
 
 # Other options (different result)
-dg3, gradX3, gradY3 = voxGrav(X, Y, Z, RHO, rhoTol = 70, refMod = "NW", outName = "Benchmark3", printing = false)
+dg3, gradX3, gradY3 = voxel_grav(X, Y, Z, RHO, rhoTol = 70, refMod = "NW", outName = "Benchmark3", printing = false)
 #################################
 
 ############# Test ##############