Merge pull request #79 from ProjectTorreyPines/compathelper/new_version/2025-03-30-03-49-20-793-03778698867

CompatHelper: bump compat for IMASdd to 5, (keep existing compat)

Also fixed issue of interp function getting stuck during runtime due to very large union in vector element type.

Changed function get_subset_space to get_subset_space_objects

Some functions to not need space argument anymore as that can now be inferrred from grid_ggd or subset.

Author: anchal-physics

Project.toml

@@ -1,7 +1,7 @@
 name = "IMASggd"
 uuid = "b7b5e640-9b39-4803-84eb-376048795def"
 authors = ["Anchal Gupta <guptaa@fusion.gat.com>"]
-version = "3.1.0"
+version = "3.1.1"
 
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
@@ -17,7 +17,7 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 [compat]
 ArgParse = "1"
 ColorSchemes = "3"
-IMASdd = "2, 3, 4"
+IMASdd = "2, 3, 4, 5"
 Interpolations = "0.15"
 NearestNeighbors = "0.4"
 RecipesBase = "1"

docs/src/index.md

@@ -31,7 +31,7 @@ get_kdtree
 
 ```@docs
 add_subset_element!
-get_subset_space
+get_subset_space_objects
 get_grid_subset
 get_subset_boundary_inds
 get_subset_boundary

src/interpolations.jl

@@ -63,7 +63,7 @@ function interp(
         values = [prop_values[ii] for ii ∈ nearest_indices]
         weights = weighing.(distances)
         if any(isinf.(weights))
-            return values[distances.==0][1]
+            return values[distances .== 0][1]
         end
         return sum(weights .* values) / sum(weights)
     end
@@ -186,7 +186,7 @@ end
 """
     interp(
         prop_values::Vector{T},
-        space::all__space
+        space::all__space,
     ) where {T <: Real}
 
 If the whole space is provided instead of a kdtree, calculate the kdtree for whole
@@ -211,7 +211,7 @@ end
     interp(
         prop_values::Vector{Real},
         space::all__space,
-        subset::all__grid_subset
+        subset::all__grid_subset,
     )
 
 If a subset of the space is provided, calculate the kdtree for the subset. In this case
@@ -229,7 +229,7 @@ end
     interp(
         prop::all__grid_subset_prop,
         grid_ggd::all__grid_ggd,
-        value_field::Symbol=:values
+        value_field::Symbol=:values,
     )
 
 Example:
@@ -252,11 +252,11 @@ end
 
 """
     interp(
-        prop_arr::AbstractVector{T},
+        prop_arr::AbstractVector,
         space::all__space,
         subset::all__grid_subset,
-        value_field::Symbol=:values
-    ) where {T <: all__grid_subset_prop}
+        value_field::Symbol=:values,
+    )
 
 Example:
 
@@ -266,22 +266,22 @@ get_electron_density = interp(dd.edge_profiles.ggd[1].electrons.density, space,
 ```
 """
 function interp(
-    prop_arr::AbstractVector{T},
+    prop_arr::AbstractVector,
     space::all__space,
     subset::all__grid_subset,
     value_field::Symbol=:values,
-) where {T <: all__grid_subset_prop}
+)
     prop = get_prop_with_grid_subset_index(prop_arr, subset.identifier.index)
     return interp(getfield(prop, value_field), space, subset)
 end
 
 """
     interp(
-        prop_arr::AbstractVector{T},
+        prop_arr::AbstractVector,
         grid_ggd::all__grid_ggd,
         grid_subset_index::Int,
-        value_field::Symbol=:values
-    ) where {T <: all__grid_subset_prop}
+        value_field::Symbol=:values,
+    )
 
 Example:
 
@@ -290,11 +290,11 @@ get_n_e_sep = interp(dd.edge_profiles.ggd[1].electrons.density, grid_ggd, 16)
 ```
 """
 function interp(
-    prop_arr::AbstractVector{T},
+    prop_arr::AbstractVector,
     grid_ggd::all__grid_ggd,
     grid_subset_index::Int,
     value_field::Symbol=:values,
-) where {T <: all__grid_subset_prop}
+)
     prop = get_prop_with_grid_subset_index(prop_arr, grid_subset_index)
     subset = get_grid_subset(grid_ggd, grid_subset_index)
     space = grid_ggd.space[subset.element[1].object[1].space]
@@ -309,11 +309,11 @@ end
 
 """
     interp(
-        prop_arr::AbstractVector{T},
+        prop_arr::AbstractVector,
         TPS_mats::Tuple{Matrix{U}, Matrix{U}, Matrix{U}, Vector{Tuple{U, U}}},
         grid_subset_index::Int,
-        value_field::Val{V}=Val(:values),
-    ) where {T <: all__grid_subset_prop, U <: Real, V}
+        value_field::Symbol=:values,
+    ) where {U <: Real, V}
 
 Same use case as above but allows one to reuse previously calculated TPS matrices.
 
@@ -331,13 +331,13 @@ end
 This will run faster as heavy matrix calculations will happen only once.
 """
 function interp(
-    prop_arr::AbstractVector{T},
+    prop_arr::AbstractVector,
     TPS_mats::Tuple{Matrix{U}, Matrix{U}, Matrix{U}, Vector{Tuple{U, U}}},
     grid_subset_index::Int,
-    value_field::Val{V}=Val(:values),
-) where {T <: all__grid_subset_prop, U <: Real, V}
+    value_field::Symbol=:values,
+) where {U <: Real}
     prop = get_prop_with_grid_subset_index(prop_arr, grid_subset_index)
-    field = getfield(prop, V)
+    field = getfield(prop, value_field)
     return interp(field, TPS_mats)
 end
 

src/recipes.jl

@@ -3,7 +3,7 @@ using ColorSchemes: ColorSchemes
 import Statistics: norm, dot
 
 """
-    plot(space::all__space)
+    plot(space::all__space))
 
 Plot the grid_ggd space object. Defaults to size of [600, 900] and linecolor of :black,
 linewidth of 0.2, and no legend.
@@ -40,7 +40,7 @@ linewidth of 0.2, and no legend.
 end
 
 """
-    plot(space::all__space, subset::all__grid_subset)
+    plot(space::all__space, subset::all__grid_subset))
 
 Plot the a subset of a space. Defaults to size of [600, 900] and linecolor of :black,
 linewidth of 0.2, and no legend.
@@ -137,7 +137,7 @@ is the heatmap and b is the colorbar.
         val_min = minimum(prop.values)
         val_max = maximum(prop.values)
         function get_color(prop_value)
-            return color_grad[(log10(prop_value / val_min)/log10(val_max / val_min))]
+            return color_grad[(log10(prop_value/val_min)/log10(val_max/val_min))]
         end
 
         if :colorbar_title in keys(plotattributes)
@@ -178,7 +178,10 @@ is the heatmap and b is the colorbar.
 end
 
 """
-    plot(grid_ggd_arr::AbstractVector{<:all__grid_ggd}, prop::all__grid_subset_prop)
+    plot(
+        grid_ggd_arr::AbstractVector{<:all__grid_ggd},
+        prop::all__grid_subset_prop,
+    )
 
 Plot 2D heatmap of edge_profiles_ggd property on a grid_ggd space object. Defaults to
 size of [635, 900], xaxis of "R / m", yaxis of "Z / m", and no legend. If :seriescolor

src/subset_tools.jl

@@ -1,5 +1,5 @@
 export add_subset_element!
-export get_subset_space
+export get_subset_space_objects
 export get_grid_subset
 export get_subset_boundary_inds
 export get_subset_boundary
@@ -76,17 +76,28 @@ function add_subset_element!(
 end
 
 """
-    get_subset_space(space::all__space, subset::all__grid_subset)
+    get_subset_space_objects(space::all__space, subset::all__grid_subset)
 
 Returns an array of space object indices corresponding to the correct
 objects_per_dimension (nodes, edges or cells) for the subset elements.
 """
-function get_subset_space(space::all__space, subset::all__grid_subset)
+function get_subset_space_objects(space::all__space, subset::all__grid_subset)
     nD = subset.element[1].object[1].dimension
     nD_objects = space.objects_per_dimension[nD].object
     return [nD_objects[ele.object[1].index] for ele ∈ subset.element]
 end
 
+"""
+    get_subset_space_objects(subset::all__grid_subset)
+
+Returns an array of space object indices corresponding to the correct
+objects_per_dimension (nodes, edges or cells) for the subset elements.
+"""
+function get_subset_space_objects(subset::all__grid_subset)
+    space = get_space(subset)
+    return get_subset_space_objects(space, subset)
+end
+
 """
     get_grid_subset(grid_ggd::all__grid_ggd, grid_subset_index::Int)
 
@@ -102,11 +113,17 @@ function get_grid_subset(grid_ggd::all__grid_ggd, grid_subset_index::Int)
 end
 
 """
-    get_grid_subset(grid_ggd::all__grid_ggd, grid_subset_name::String)
+    get_grid_subset(
+        grid_ggd::all__grid_ggd,
+        grid_subset_name::String,
+    )
 
 Returns the grid_subset in a grid_ggd with the matching grid_subset_name
 """
-function get_grid_subset(grid_ggd::all__grid_ggd, grid_subset_name::String)
+function get_grid_subset(
+    grid_ggd::all__grid_ggd,
+    grid_subset_name::String,
+)
     for subset ∈ grid_ggd.grid_subset
         if subset.identifier.name == grid_subset_name
             return subset
@@ -174,7 +191,7 @@ function get_grid_ggd(subset::Union{all__grid_subset, all__space})::all__grid_gg
 end
 
 """
-    get_space_from_subset(subset::all__grid_subset)::all__space
+    get_space(subset::all__grid_subset)::all__space
 
 Get the corresponding space in parent grid_ggd for a grid_subset object.
 """
@@ -185,10 +202,11 @@ end
 
 """
     subset_do(
-        set_operator,
-        itrs::Vararg{all__grid_subset};
-        use_nodes=false,
-    )::all__grid_subset
+    set_operator,
+    itrs::Vararg{all__grid_subset};
+    use_nodes=false,
+
+)::all__grid_subset
 
 Function to perform any set operation (intersect, union, setdiff etc.) on
 subset.element to generate a list of elements to go to subset object. If use_nodes is
@@ -204,8 +222,8 @@ function subset_do(
         ele_inds = set_operator(
             [
                 union([
-                    obj.nodes for obj ∈ get_subset_space(space, subset)
-                ]...
+                        obj.nodes for obj ∈ get_subset_space_objects(space, subset)
+                    ]...
                 ) for subset ∈ itrs
             ]...,
         )
@@ -229,7 +247,7 @@ Returns an array of tuples corresponding to (r,z) coordinates of the center of
 cells or the center of edges in the subset space.
 """
 function get_subset_centers(space::all__space, subset::all__grid_subset)
-    subset_space = get_subset_space(space, subset)
+    subset_space = get_subset_space_objects(space, subset)
     if subset.element[1].object[1].dimension == 1
         return [Tuple(obj.geometry) for obj ∈ subset_space]
     end
@@ -240,13 +258,24 @@ function get_subset_centers(space::all__space, subset::all__grid_subset)
     ]
 end
 
+"""
+    get_subset_centers(subset::all__grid_subset)
+
+Returns an array of tuples corresponding to (r,z) coordinates of the center of
+cells or the center of edges in the subset space.
+"""
+function get_subset_centers(subset::all__grid_subset)
+    space = get_space(subset)
+    return get_subset_centers(space, subset)
+end
+
 """
     project_prop_on_subset!(
-        prop_arr::AbstractVector{<:all__grid_subset_prop},
-        from_subset::all__grid_subset,
-        to_subset::all__grid_subset,
+        prop_arr::AbstractVector{<:all__grid_subset_prop}),
+        from_subset::all__grid_subset),
+        to_subset::all__grid_subset),
         space::all__space,
-        value_field::Symbol=:values;
+        value_field::Symbol=:values,
         TPS_mats::Union{
             Nothing,
             Tuple{Matrix{U}, Matrix{U}, Matrix{U}, Vector{Tuple{U, U}}},
@@ -291,19 +320,19 @@ to_prop_values: The projected values of the properties added to prop object in a
 instance
 """
 function project_prop_on_subset!(
-    prop_arr::AbstractVector{<:all__grid_subset_prop},
+    prop_arr::IMASdd.IDSvector{<:all__grid_subset_prop},
     from_subset::all__grid_subset,
     to_subset::all__grid_subset,
     space::all__space,
-    value_field::Symbol=:values;
+    value_field::Symbol=:values,
     TPS_mats::Union{
         Nothing,
         Tuple{Matrix{U}, Matrix{U}, Matrix{U}, Vector{Tuple{U, U}}},
     }=nothing,
 ) where {U <: Real}
     if from_subset.element[1].object[1].dimension ==
        to_subset.element[1].object[1].dimension
-        return project_prop_on_subset!(prop, from_subset, to_subset)
+        return project_prop_on_subset!(prop_arr, from_subset, to_subset, value_field)
     elseif from_subset.element[1].object[1].dimension >
            to_subset.element[1].object[1].dimension
         if length(prop_arr) < 1
@@ -346,9 +375,9 @@ end
 
 """
     project_prop_on_subset!(
-        prop_arr::AbstractVector{<:all__grid_subset_prop},
-        from_subset::all__grid_subset,
-        to_subset::all__grid_subset,
+        prop_arr::AbstractVector{<:all__grid_subset_prop}),
+        from_subset::all__grid_subset),
+        to_subset::all__grid_subset),
         value_field::Symbol=:values,
     )
 
@@ -358,7 +387,7 @@ any interpolation or use of space object. The function returns a tuple of indice
 elements of to_subset and the values of the property in to_subset.
 """
 function project_prop_on_subset!(
-    prop_arr::AbstractVector{<:all__grid_subset_prop},
+    prop_arr::IMASdd.IDSvector{<:all__grid_subset_prop},
     from_subset::all__grid_subset,
     to_subset::all__grid_subset,
     value_field::Symbol=:values,
@@ -566,18 +595,18 @@ end
 
 """
     get_prop_with_grid_subset_index(
-        prop::AbstractVector{<:all__grid_subset_prop},
+        prop_arr::AbstractVector{<:all__grid_subset_prop}),
         grid_subset_index::Int,
     )
 
 Find the property instance in an array of properties that corresponds to
 the grid_subset_index provided.
 """
 function get_prop_with_grid_subset_index(
-    prop::AbstractVector{<:all__grid_subset_prop},
+    prop_arr::AbstractVector{<:all__grid_subset_prop},
     grid_subset_index::Int,
 )
-    for p ∈ prop
+    for p ∈ prop_arr
         if p.grid_subset_index == grid_subset_index
             return p
         end