Merge pull request #95 from WIAS-PDELib/feature/trim

Add trim! function

Author: pjaap

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## unreleased
+
+- add `trim!`/`trim` function to remove precomputed grid components for lightweight storage
+
 ## [1.13.2] - 2025-06-22
 - Allow Triangulate v3
 

Project.toml

@@ -1,7 +1,7 @@
 name = "ExtendableGrids"
 uuid = "cfc395e8-590f-11e8-1f13-43a2532b2fa8"
 authors = ["Juergen Fuhrmann <juergen.fuhrmann@wias-berlin.de>", "Christian Merdon  <christian.merdon@wias-berlin.de>", "Johannes Taraz  <johannes.taraz@gmail.com>", "Patrick Jaap <patrick.jaap@wias-berlin.de>"]
-version = "1.13.2"
+version = "1.14.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

src/ExtendableGrids.jl

@@ -78,6 +78,7 @@ export num_cellregions, num_bfaceregions, num_bedgeregions
 export gridcomponents
 export isconsistent, dangling_nodes
 export seemingly_equal, numbers_match
+export trim!, trim
 
 include("partitioning.jl")
 export PColorPartitions, PartitionCells, PartitionBFaces, PartitionNodes, NodePermutation, PartitionEdges

src/extendablegrid.jl

@@ -712,3 +712,90 @@ function bbox(grid)
     e = extrema(grid)
     return map(a -> a[1], e), map(a -> a[2], e)
 end
+
+
+"""
+    $(SIGNATURES)
+
+Remove precomputed grid components for lightweight storage of the grid.
+
+Use the `keep` list to exclude grid components from trimming.
+"""
+function trim!(grid::ExtendableGrid; keep = [])
+
+    components_for_trimming = [
+        BEdgeAssemblyGroups,
+        BEdgeEdges,
+        BEdgeGeometries,
+        BEdgeNodes,
+        BEdgeRegions,
+        BEdgeVolumes,
+        BFaceAssemblyGroups,
+        BFaceCellPos,
+        BFaceCells,
+        BFaceEdges,
+        BFaceFaces,
+        BFaceNormals,
+        BFaceVolumes,
+        CellAssemblyGroups,
+        CellEdges,
+        CellEdgeSigns,
+        CellFaceOrientations,
+        CellFaces,
+        CellFaceSigns,
+        CellVolumes,
+        EdgeAssemblyGroups,
+        EdgeCells,
+        EdgeGeometries,
+        EdgeNodes,
+        EdgeRegions,
+        EdgeTangents,
+        EdgeVolumes,
+        FaceAssemblyGroups,
+        FaceCells,
+        FaceEdges,
+        FaceEdgeSigns,
+        FaceGeometries,
+        FaceNodes,
+        FaceNormals,
+        FaceRegions,
+        FaceVolumes,
+        NodeCells,
+        NodeEdges,
+        NodeFaces,
+        NodePatchGroups,
+        NumBEdgeRegions,
+        NumBFaceRegions,
+        NumCellRegions,
+        UniqueBEdgeGeometries,
+        UniqueBFaceGeometries,
+        UniqueCellGeometries,
+        UniqueEdgeGeometries,
+        UniqueFaceGeometries,
+    ]
+
+    # filter out kept components
+    filter!(!in(keep), components_for_trimming)
+
+    for component in components_for_trimming
+        delete!(grid, component)
+    end
+
+    return nothing
+end
+
+
+"""
+    $(SIGNATURES)
+
+Variant of [`trim!`](@ref) without modification of the original grid.
+
+Returns a trimmed copy of the grid.
+"""
+function trim(grid::ExtendableGrid; keep = [])
+
+    grid_copy = deepcopy(grid)
+    trim!(grid_copy; keep)
+
+    return grid_copy
+end

test/runtests.jl

@@ -491,3 +491,76 @@ if VERSION < v"1.12.0-DEV.0"
         @testscripts(joinpath(@__DIR__, "..", "examples"), notebooks)
     end
 end
+
+
+@testset "trim!" begin
+
+    grid = grid_unitcube(Tetrahedron3D)
+
+    component_list = [
+        BEdgeAssemblyGroups,
+        BEdgeEdges,
+        BEdgeGeometries,
+        BEdgeNodes,
+        BEdgeRegions,
+        BEdgeVolumes,
+        BFaceAssemblyGroups,
+        BFaceCellPos,
+        BFaceCells,
+        BFaceEdges,
+        BFaceFaces,
+        BFaceNormals,
+        BFaceVolumes,
+        CellAssemblyGroups,
+        CellEdges,
+        CellEdgeSigns,
+        CellFaceOrientations,
+        CellFaces,
+        CellFaceSigns,
+        CellVolumes,
+        EdgeAssemblyGroups,
+        EdgeCells,
+        EdgeGeometries,
+        EdgeNodes,
+        EdgeRegions,
+        EdgeTangents,
+        EdgeVolumes,
+        FaceAssemblyGroups,
+        FaceCells,
+        FaceEdges,
+        FaceEdgeSigns,
+        FaceGeometries,
+        FaceNodes,
+        FaceNormals,
+        FaceRegions,
+        FaceVolumes,
+        NodeCells,
+        NodeEdges,
+        NodeFaces,
+        NodePatchGroups,
+        NumBEdgeRegions,
+        NumBFaceRegions,
+        NumCellRegions,
+        UniqueBEdgeGeometries,
+        UniqueBFaceGeometries,
+        UniqueCellGeometries,
+        UniqueEdgeGeometries,
+        UniqueFaceGeometries,
+    ]
+
+    # init components
+    for c in component_list
+        grid[c]
+    end
+
+    # trim all components, except a few
+    grid = ExtendableGrids.trim(grid, keep = [BFaceNormals, NodeCells])
+
+    @test haskey(grid, BFaceNormals)
+    @test haskey(grid, NodeCells)
+
+    # trim everything
+    grid = ExtendableGrids.trim(grid)
+
+    @test all([!haskey(grid, c) for c in component_list])
+end