docs(quadrature): Add deprecation notices to old integration API

- Added DEPRECATED header comment explaining migration to new API (api.jl)
- Added deprecation notices to AbstractIntegration and IntegrationPoint docstrings
- Added migration example showing old vs new syntax (IntegrationPoint → QuadraturePoint)
- Documented field name changes: ip.ξ → qp.coords
This commit is contained in:
Jukka Aho
2025-11-21 00:29:48 +02:00
parent 3983e19bff
commit 15e9d71275
+17 -2
View File
@@ -1,9 +1,17 @@
# This file is a part of JuliaFEM.
# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md
# DEPRECATED: This file contains the old integration API.
# New code should use the types from api.jl:
# - AbstractQuadratureRule (replaces AbstractIntegration)
# - QuadraturePoint (replaces IntegrationPoint)
# - GaussLegendre{N} (replaces Gauss{N})
"""
AbstractIntegration
DEPRECATED: Use `AbstractQuadratureRule` instead.
Abstract base type for all numerical integration (quadrature) schemes.
An integration scheme defines how to numerically integrate over a reference element
@@ -31,15 +39,22 @@ abstract type AbstractIntegration end
"""
IntegrationPoint{D}
DEPRECATED: Use `QuadraturePoint{D,T}` instead.
Represents a single integration point in D-dimensional parametric space.
# Fields
- `ξ::Vec{D, Float64}`: Location in parametric coordinates
- `weight::Float64`: Integration weight
# Examples
# Migration
```julia
ip = IntegrationPoint(Vec(0.0, 0.0), 1.0) # 2D point at origin with weight 1
# Old:
ip = IntegrationPoint(Vec(0.0, 0.0), 1.0)
# New:
qp = QuadraturePoint(SVector(0.0, 0.0), 1.0)
# Access: qp.coords instead of ip.ξ
```
"""
struct IntegrationPoint{D}