Integration with Chmy.jl

Project.toml

@@ -1,7 +1,7 @@
 name = "GeophysicalModelGenerator"
 uuid = "3700c31b-fa53-48a6-808a-ef22d5a84742"
 authors = ["Boris Kaus", "Marcel Thielmann"]
-version = "0.7.7"
+version = "0.7.8"
 
 [deps]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
@@ -32,23 +32,26 @@ WhereTheWaterFlows = "ea906314-1493-4d22-a0af-f886a20c9fba"
 WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"
 
 [weakdeps]
+Chmy = "33a72cf0-4690-46d7-b987-06506c2248b9"
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 GMT = "5752ebe1-31b9-557e-87aa-f909b540aa54"
 GridapGmsh = "3025c34a-b394-11e9-2a55-3fee550c04c8"
 
 [extensions]
+Chmy_utils = "Chmy"
 GLMakie_Visualisation = "GLMakie"
 GMT_utils = "GMT"
 Gmsh_utils = "GridapGmsh"
 
 [compat]
+Chmy = "0.1.20"
 Colors = "0.9 - 0.12"
 Downloads = "1"
 FFMPEG = "0.4"
 FileIO = "1"
-GDAL_jll = "300.900.0 - 301.900.0"
-GLMakie = "0.10"
-GMT = "1"
+GDAL_jll = "300.900.0 - 301.901.0"
+GLMakie = "0.8, 0.9, 0.10"
+GMT = "1.0 - 1.14"
 GeoParams = "0.2 - 0.6"
 Geodesy = "1"
 GeometryBasics = "0.1 - 0.4"
@@ -63,15 +66,17 @@ NearestNeighbors = "0.2 - 0.4"
 Parameters = "0.9 - 0.12"
 SpecialFunctions = "1.0, 2"
 StaticArrays = "1"
-WhereTheWaterFlows = "0.10"
+WhereTheWaterFlows = "0.10, 0.11"
 WriteVTK = "1"
 julia = "1.9"
 
 [extras]
+Chmy = "33a72cf0-4690-46d7-b987-06506c2248b9"
 GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
 GMT = "5752ebe1-31b9-557e-87aa-f909b540aa54"
+KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
 StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "GMT", "StableRNGs", "GridapGmsh"]
+test = ["Test", "GMT", "StableRNGs", "GridapGmsh", "Chmy","KernelAbstractions"]

ext/Chmy_utils.jl

@@ -0,0 +1,108 @@
+#helper functions to make GMG work with Chmy grids and fields
+module Chmy_utils
+
+using Chmy, Chmy.Grids, Chmy.Fields
+
+import GeophysicalModelGenerator: create_CartGrid, CartGrid, CartData
+import GeophysicalModelGenerator: add_box!, add_sphere!, add_ellipsoid!, add_cylinder!
+import GeophysicalModelGenerator: add_layer!, add_polygon!, add_slab!, add_stripes!, add_volcano!
+import GeophysicalModelGenerator: above_surface, below_surface
+
+println("Loading Chmy-GMG tools")
+
+"""
+    CartGrid = create_CartGrid(grid::StructuredGrid; ylevel=0.0)
+
+Creates a GMG `CartGrid` data structure from a `Chmy` grid object
+"""
+function create_CartGrid(grid::StructuredGrid; ylevel=0.0)
+
+    coord1D     = Vector.(coords(grid, Vertex()))
+    coord1D_cen = Vector.(coords(grid, Center()))
+    N           = length.(coord1D)
+    L           = extent(grid, Vertex())
+    X₁          = origin(grid, Vertex())  
+    Δ           = spacing(grid)
+    ConstantΔ   = false;
+    if isa(grid, UniformGrid)
+        ConstantΔ = true
+    end
+    if ndims(grid)==2
+        # we need a special treatment of this, as all GMG routines work with 3D coordinates
+        X₁  = (X₁[1], ylevel, X₁[2]) 
+        L   = (L[1], 0.0, L[2]) 
+        Δ   = (Δ[1], 0.0, Δ[2])
+        N   = (N[1],1,N[2])
+        coord1D = (coord1D[1], [0.0], coord1D[2])
+        coord1D_cen = (coord1D_cen[1], [0.0], coord1D_cen[2])
+    end
+    Xₙ          = X₁ .+ L
+
+
+    return CartGrid(ConstantΔ,N,Δ,L,X₁,Xₙ,coord1D, coord1D_cen)
+end
+
+# all functions to be ported
+function_names = (:add_box!, :add_sphere!, :add_ellipsoid!, :add_cylinder!, :add_layer!, :add_polygon!, :add_slab!, :add_stripes!, :add_volcano!)
+
+for fn in function_names
+
+    @eval begin 
+        """
+            $($fn)( Phase::Field, 
+                    Temp::Field,
+                    Grid::StructuredGrid;      # required input
+                    kwargs...) 
+
+        Sets `$($fn)` function for `Chmy` fields and grids.           
+        """
+        function $fn(  Phase::Field, 
+                            Temp::Field,
+                            Grid::StructuredGrid;      # required input
+                            kwargs...)  
+
+            CartGrid = create_CartGrid(Grid)
+
+            cell = false
+            if all(location(Phase).==Center()) 
+                cell = true
+            end
+
+            return ($fn)(Phase, Temp, CartGrid; cell=cell, kwargs...)
+        end
+    end
+
+end
+
+
+# all functions to be ported
+function_names = (:above_surface, :below_surface)
+
+for fn in function_names
+
+    @eval begin 
+        """
+            $($fn)( Grid::StructuredGrid, field::Field, DataSurface_Cart::CartData; kwargs...) 
+
+        Sets `$($fn)` function for `Chmy` grids and the field `field` which can be either on vertices or centers           
+        """
+        function $fn( Grid::StructuredGrid,
+                      field::Field, 
+                      DataSurface_Cart::CartData;     
+                      kwargs...)  
+
+            CartGrid = create_CartGrid(Grid)
+
+            cell = false
+            if all(location(field).==Center()) 
+                cell = true
+            end
+
+            return ($fn)(CartGrid, DataSurface_Cart; cell=cell, kwargs...)
+        end
+    end
+
+end
+
+
+end # end of module