Skip to content

Commit

Permalink
Update operators.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adtzlr committed Jan 2, 2024
1 parent 12fa7a4 commit 09fcba9
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/api/operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@ This module uses derived data types where the default operators are overloaded w
- Multiplication by scalar `A*5.`
- Dot-Product (single contraction) `A*B`
- Double-Dot-Product (double contraction) `A**B`
- Dyadic Product `A.dya.B`
- Symmetric Crossed-dyadic Product `A.cdya.B` to perform `C(i,j,k,l) = (A(i,k)*B(j,l) + A(i,l)*B(j,k) + B(i,k)*A(j,l) + B(i,l)*A(j,k)) / 4.`

{: .note }
> See Also
>
> There are also functions available for the dyadic product `A.dya.B` and the symmetric crossed-dyadic product `A.cdya.B` to perform `C(i,j,k,l) = (A(i,k)*B(j,l) + A(i,l)*B(j,k) + B(i,k)*A(j,l) + B(i,l)*A(j,k)) / 4.`.
{: .warning }
> Be sure to use brackets around functions which should be evaluated first because the double contraction has the highest priority as it is replaced by the conventional power function. This leads to wrong results in combination with crossed-dyadic products as they must be evaluated first. Always use brackets like `A**(B.cdya.B)`. Unfortunately this is a limitation of Fortran.

0 comments on commit 09fcba9

Please sign in to comment.