diff src/Grids/grid.jl @ 1461:455e6b4c8b02 feature/grids/boundary_indicies

Add a function declaration for boundary_indices
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 28 Nov 2023 08:42:00 +0100
parents 2ad518182b37
children de4e15924d26
line wrap: on
line diff
--- a/src/Grids/grid.jl	Wed Nov 22 17:52:03 2023 +0100
+++ b/src/Grids/grid.jl	Tue Nov 28 08:42:00 2023 +0100
@@ -100,3 +100,12 @@
 
 _ncomponents(::Type{<:Number}) = 1
 _ncomponents(T::Type{<:SVector}) = length(T)
+
+"""
+    boundary_indices(g::Grid, id::BoundaryIdentifier)
+
+A collection of indices corresponding to the boundary with given id. The
+collection should be usable to index grid functions on the grid to obtain grid
+functions on the boundary grid.
+"""
+function boundary_indices end