Skip to content

Commit f235619

Browse files
Mention hyphen/dash caveat for boundary symbols (#1866)
* Mention hyphen/dash caveat for boundary symbols * typo * elaborate
1 parent 1ca37cf commit f235619

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/src/meshes/p4est_mesh.md

+2
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,8 @@ By doing so, only nodesets with a label present in `boundary_symbols` are treate
256256
Other nodesets that could be used for diagnostics are not treated as external boundaries.
257257
Note that there is a leading colon `:` compared to the label in the `.inp` mesh file.
258258
This is required to turn the label into a [`Symbol`](https://docs.julialang.org/en/v1/manual/metaprogramming/#Symbols).
259+
**Important**: In Julia, a symbol _cannot_ contain a hyphen/dash `-`, i.e., `:BC-1` is _not_ a valid symbol.
260+
Keep this in mind when importing boundaries, you might have to convert hyphens/dashes `-` to underscores `_` in the `.inp` mesh file, i.e., `BC_1` instead of `BC-1`.
259261

260262
A 2D example for this mesh, which is read-in for an unstructured mesh file created with `gmsh`, is presented in
261263
`examples/p4est_2d_dgsem/elixir_euler_NACA6412airfoil_mach2.jl`.

0 commit comments

Comments
 (0)