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

This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal). More...

Public Member Functions

subroutine eye2 (A, ErrStat, ErrMsg)
 This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal). More...
 
subroutine eye2d (A, ErrStat, ErrMsg)
 This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal). More...
 
subroutine eye3 (A, ErrStat, ErrMsg)
 This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal).
 
subroutine eye3d (A, ErrStat, ErrMsg)
 This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal). More...
 

Detailed Description

This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal).

If the first two dimensions of A are not equal (i.e., matrix A(:,:,n) is non-square), this routine returns the pseudo-identity.

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

Parameters
[in,out]aArray to set to the identity matrix (nr,nc,n)
[out]errstatError level
[out]errmsgErrMsg corresponding to ErrStat

Member Function/Subroutine Documentation

◆ eye2()

subroutine nwtc_num::eye::eye2 ( real(reki), dimension (:,:), intent(inout)  A,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)

This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal).

If the first two dimensions of A are not equal (i.e., matrix A(:,:,n) is non-square), this routine returns the pseudo-identity.

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

Parameters
[in,out]aArray to set to the identity matrix (nr,nc,n)
[out]errstatError level
[out]errmsgErrMsg corresponding to ErrStat

◆ eye2d()

subroutine nwtc_num::eye::eye2d ( real(dbki), dimension (:,:), intent(inout)  A,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)

This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal).

If the first two dimensions of A are not equal (i.e., matrix A(:,:,n) is non-square), this routine returns the pseudo-identity.

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

Parameters
[in,out]aArray to set to the identity matrix (nr,nc,n)
[out]errstatError level
[out]errmsgErrMsg corresponding to ErrStat
[in,out]aArray to set to the identity matrix (nr,nc,n)
[out]errstatError level
[out]errmsgErrMsg corresponding to ErrStat

◆ eye3d()

subroutine nwtc_num::eye::eye3d ( real(dbki), dimension (:,:,:), intent(inout)  A,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)

This routine sets the matrices in the first two dimensions of A equal to the identity matrix (all zeros, with ones on the diagonal).

Parameters
[in,out]aArray to set to the identity matrix (nr,nc,n)
[out]errstatError level
[out]errmsgErrMsg corresponding to ErrStat

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