Skip to content

Throw informative error if cell vector is type unstable #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jipolanco wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Throw informative error if cell vector is type unstable #156

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca607a7
Allow passing cells in non-concrete container type
jipolanco Nov 5, 2024
4ce22f3
Use identity.(cells)
jipolanco Nov 6, 2024
890a794
Show error if cells element type is not concrete
jipolanco Nov 6, 2024
bd8b593
We don't need `string`
jipolanco Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/gridtypes/unstructured/unstructured.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,26 @@ function vtk_grid(dtype::VTKUnstructuredGrid, filename::AbstractString,
vtk
end

# If the type of `cells` is not concrete, throw an error describing the proper (type stable)
# way of initialising a vector of cells to be passed to vtk_grid.
function check_cells(cells::AbstractVector)
isconcretetype(eltype(cells)) && return nothing
s = if isempty(cells)
"" # we can't guess the cell type
else
CellType = typeof(first(cells)) # try guessing cell type from first cell
"""
Try initialising it as:

cells = $(CellType)[]

before appending cells to it.
"""
end
s = replace(s, "VTKBase." => "") # e.g. VTKBase.PolyData.Polys => PolyData.Polys
throw(ArgumentError("The concrete cell type cannot be inferred from the given `cells` vector.$s"))
end

# Variant of vtk_grid with 2-D array "points".
# size(points) = (dim, num_points), with dim ∈ {1, 2, 3}
"""
Expand All @@ -159,6 +179,7 @@ Create an unstructured mesh image data (`.vtu`) file.
function vtk_grid(filename::AbstractString, points::AbstractArray{T,2},
cells::CellVector, args...; kwargs...) where T
dim, Npts = size(points)
check_cells(cells)
gtype = grid_type(eltype(cells))

if dim == 3
Expand Down Expand Up @@ -205,6 +226,7 @@ function vtk_grid(filename::AbstractString, x::AbstractVector{T},
throw(DimensionMismatch("length of x, y and z arrays must be the same."))
end
points = (x, y, z)
check_cells(cells)
gtype = grid_type(eltype(cells))
vtk_grid(gtype, filename, points, cells, args...; kwargs...)
end
Expand Down Expand Up @@ -237,6 +259,7 @@ Create an unstructured mesh image data (`.vtu`) file.
"""
function vtk_grid(filename::AbstractString, xs::AbstractVector,
cells::CellVector, args...; kwargs...)
check_cells(cells)
gtype = grid_type(eltype(cells))
vtk_grid(gtype, filename, xs, cells, args...; kwargs...)
end
Expand All @@ -247,6 +270,7 @@ function vtk_grid(filename::AbstractString, points::AbstractArray{T,4},
cells::CellVector, args...; kwargs...) where T
dim, Ni, Nj, Nk = size(points)
points_r = reshape(points, dim, Ni * Nj * Nk)
check_cells(cells)
gtype = grid_type(eltype(cells))
vtk_grid(gtype, filename, points_r, cells, args...; kwargs...)
end