Subroutine Type

Utility/Data Access

Definition

Returns the data from a sparse Reference_Matrix element.  There is a separate function for a full Reference_Matrix element called GET_FULL_MATRIX_DATA.

Use

The function can be called by any user subroutine.

Calling Syntax

Fortran

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

C

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

Python

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

MATLAB

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

Input Arguments

[integer]id

Specifies the ID of the Reference_Matrix element.

[integer] size

Specifies the size of the Reference_Matrix element.

Output Values

[integer]rows

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

[integer]cols

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

[double precision] vals

A double precision array containing data from the Reference_Matrix element.

[integer] ierr

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