Warn about SArray output from embedded FEValues, closes #922

Ferrite-FEM · May 29, 2024 · 471ec03 · 471ec03
1 parent a12ae02
commit 471ec03
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/src/reference/fevalues.md b/docs/src/reference/fevalues.md
@@ -15,6 +15,12 @@ CellValues
 FacetValues
 ```
 
+!!! warning "Embedded API"
+    Currently, embedded `FEValues` returns `SArray`s, which behave differently
+    from the `Tensor`s for normal value. In the future, we expect to return
+    an `AbstractTensor`, this change may happen in a minor release, and the
+    API for embedded `FEValues` should therefore be considered experimental.
+
 ## Applicable functions
 The following functions are applicable to both `CellValues`
 and `FacetValues`.