OpenFAST
Wind turbine multiphysics simulator
Public Member Functions | List of all members
nwtc_num::trace Interface Reference

This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\). More...

Public Member Functions

real(siki) function tracer4 (A)
 This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\). More...
 
real(r8ki) function tracer8 (A)
 This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\). More...
 
real(quki) function tracer16 (A)
 This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\). More...
 

Detailed Description

This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\).

The trace of \(A\), \(\mathrm{Tr}\left[ A \right]\), is the sum of the diagonal elements of \(A\):

\begin{equation} \mathrm{Tr}\left[ A \right] = \sum_{i=1}^{\min(m,n)} A(i,i) \end{equation}

Use trace (nwtc_num::trace) instead of directly calling a specific routine in the generic interface.

Parameters
[in]amatrix A
Returns
sum of the diagonal elements of A

Member Function/Subroutine Documentation

◆ tracer16()

real(quki) function nwtc_num::trace::tracer16 ( real(quki), dimension(:,:), intent(in)  A)

This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\).

The trace of \(A\), \(\mathrm{Tr}\left[ A \right]\), is the sum of the diagonal elements of \(A\):

\begin{equation} \mathrm{Tr}\left[ A \right] = \sum_{i=1}^{\min(m,n)} A(i,i) \end{equation}

Use trace (nwtc_num::trace) instead of directly calling a specific routine in the generic interface.

Parameters
[in]amatrix A
Returns
sum of the diagonal elements of A

◆ tracer4()

real(siki) function nwtc_num::trace::tracer4 ( real(siki), dimension(:,:), intent(in)  A)

This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\).

The trace of \(A\), \(\mathrm{Tr}\left[ A \right]\), is the sum of the diagonal elements of \(A\):

\begin{equation} \mathrm{Tr}\left[ A \right] = \sum_{i=1}^{\min(m,n)} A(i,i) \end{equation}

Use trace (nwtc_num::trace) instead of directly calling a specific routine in the generic interface.

Parameters
[in]amatrix A
Returns
sum of the diagonal elements of A

◆ tracer8()

real(r8ki) function nwtc_num::trace::tracer8 ( real(r8ki), dimension(:,:), intent(in)  A)

This function computes the trace of a matrix \(A \in \mathbb{R}^{m,n}\).

The trace of \(A\), \(\mathrm{Tr}\left[ A \right]\), is the sum of the diagonal elements of \(A\):

\begin{equation} \mathrm{Tr}\left[ A \right] = \sum_{i=1}^{\min(m,n)} A(i,i) \end{equation}

Use trace (nwtc_num::trace) instead of directly calling a specific routine in the generic interface.

Parameters
[in]amatrix A
Returns
sum of the diagonal elements of A
Parameters
[in]amatrix A
Returns
sum of the diagonal elements of A

The documentation for this interface was generated from the following file: