GET_SPARSE_MATRIX_DATA

Use

The function can be called by any user subroutine. There is a separate function for a full Reference_Matrix element called GET_FULL_MATRIX_DATA.

Format

Fortran Calling Syntax

CALL GET_SPARSE_MATRIX_DATA(id, rows, cols, vals, size, ierr)

C/C++ Calling Syntax

c_get_sparse_matrix_data(id, rows, cols, vals, size, ierr)

Python Calling Syntax

[rows, cols, vals, ierr] = py_get_sparse_matrix_data(id, size)

MATLAB Calling Syntax

[rows, cols, vals, ierr] = m_get_sparse_matrix_data(id, size)

Attributes

id

[integer]

Specifies the ID of the Reference_Matrix element.

size

[integer]

Specifies the size of the Reference_Matrix element.

Output

rows

[integer]

A "size" array containing row indices for values stored in vals.

cols

[integer]

A "size" array containing column indices for values stored in vals.

vals

[double precision]

A double precision array containing data from the Reference_Matrix element.

ierr

[integer]

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

0

Normal return.

1

ID not found, call ignored.

2

Size does not equal the size of the Reference_Matrix.