docs(topology): clarify pyramid support and dedupe nnodes/export

Point readers at missing higher-order pyramids, adopt `LICENSE.md`, drop the
redundant `nnodes` method, and remove duplicate exports.

- Remove `nnodes(::Pyramid{N})` and `export Pyr5` (manifest handles exports).
This commit is contained in:
Jukka Aho
2026-05-09 18:22:16 +03:00
parent 4f8c6b493c
commit fa34183676
+3 -4
View File
@@ -1,5 +1,5 @@
# This file is a part of JuliaFEM.
# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE
# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md
"""
Pyramid{N} <: AbstractTopology{N}
@@ -8,13 +8,13 @@ Pyramidal topology with N nodes.
# Node Count Variants
- `Pyramid{5}` (alias `Pyr5`): Linear pyramid (P1)
- `Pyramid{13}` (alias `Pyr13`): Quadratic pyramid (P2)
Higher-order pyramid variants (e.g. quadratic Pyramid{13}) are not implemented yet.
"""
struct Pyramid{N} <: AbstractTopology{N} end
const Pyr5 = Pyramid{5}
nnodes(::Pyramid{N}) where {N} = N
dim(::Pyramid{N}) where {N} = 3
function reference_coordinates(::Pyramid{5})
@@ -56,4 +56,3 @@ nvertices(::Pyramid) = 5
nedges(::Pyramid) = 8
nfaces(::Pyramid) = 5
export Pyr5