Subroutine Type

Utility/Data Access

Definition

Returns information about a Reference_Matrix element.

Use

The function can be called by any user subroutine.

Calling Syntax

Fortran

CALL GET_MATRIX_INFO(id, type, nrows, ncols, size, ierr)

C

c_get_matrix_info(id, type, nrows, ncols, size, ierr)

Python

[type, nrows, ncols, size, ierr] = py_get_matrix_info(id)

MATLAB

[type, nrows, ncols, size, ierr] = m_get_matrix_info(id)

Input Arguments

[integer]id

The ID of the Reference_Matrix element.

Output Values

[integer] type

The type of Reference_Matrix as follows:

[integer] nrows

The number of rows.

[integer] ncols

The number of columns.

[integer] size

The total number of entries.  For sparse matrix, it is the number of non-zero entries.  For full matrix, it is nrows*ncols.

[integer] ierr

An integer that specifies the status of the call to the GET_MATRIX_INFO as follows: