fix 2839, document symmetric requirement of tensor expressions and need to transpose result of eigenvector expr
@@ -668,6 +668,24 @@ Cylindrical Radius : ``cylindrical_radius(expr)``
Tensor Expressions
""""""""""""""""""
+Eigenvalue: ``eigenvalue(expr)``
+ The ``expr`` must evaluate to a 3x3 *symmetric* tensor. The eigenvalue
+ expression returns the eigenvalues of the 3x3 matrix *symmetric* argument
+ as a vector valued expression where each eigenvalue is a component of
+ the vector. Use the component index operator ('[]') to access individual
+ eigenvalues.
+
+Eigenvector: ``eigenvector(expr)``
+ The ``expr`` must evaluate to a 3x3 *symmetric* tensor. The eigenvector
+ expression returns the eigenvectors of the 3x3 matrix argument as a tensor
+ (3x3 matrix) valued expression where each column in the tensor is one of
+ the eigenvectors. In order to use the component index operator (``[]``)
+ to access individual eigenvectors, you must transpose the result with the
+ ``transpose()`` expression function. For example, if
+ ``evecs = transpose(eigenvector(tensor))``, the expression ``evecs[1]``
+ will return the second eigenvector.
+
+
Array Expressions
"""""""""""""""""
@@ -1125,24 +1143,6 @@ Time Iteration Expressions
| | | *Example: effective_tensor(tensor1)* |
| | | |
+-----------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eigenvalue | Eigenvalue | **eigenvalue(expr)** |
-| | | |
-| | | |
-| | | expr must evaluate to a 3x3 tensor. The eigenvalue expression returns the eigenvalues of the 3x3 matrix argument as a vector valued expression where each eigenvalue is a component of the vector. Use the component index operator ('[]') to access individual eigenvalues. |
-| | | |
-| | | |
-| | | *Example: evals = eigenvalue(tensor), evals[0]* |
-| | | |
-+-----------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eigenvector | Eigenvector | **eigenvector(expr)** |
-| | | |
-| | | |
-| | | expr must evaluate to a 3x3 tensor. The eigenvector expression returns the eigenvectors of the 3x3 matrix argument as a tensor (3x3 matrix) valued expression where each column in the tensor is one of the eigenvectors. In order to use the component index operator ('[]') to access individual eigenvectors, you must transpose the result with the ``transpose()`` expression function. |
-| | | |
-| | | |
-| | | *Example: evecs = eigenvector(tensor), evecs[1]* |
-| | | |
-+-----------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eq, equal, equals | Equality | **equal(expr** |
| | | 1 |
| | | **, expr** |
