Adams Basic Package > Adams Solver > Welcome to Adams Solver Subroutines > Utility Subroutines > GET_FULL_MATRIX_DATA

GET_FULL_MATRIX_DATA

Returns the values entered in a dataset MATRIX statement (C++ or FORTRAN) of type full, given the statement identifier.

Use

Called By

Any user-written subroutine

Prerequisite

MATRIX statement in the dataset

Calling Sequence

GET_FULL_MATRIX_DATA(id, vals, size, ierr)

Input Arguments

 
id
An integer variable that specifies the ID of the corresponding MATRIX statement.
size
An integer variable that specifies the size of the MATRIX. GET_FULL_MATRIX_DATA uses this value to compare against the MATRIX’s true size; a check for a valid call.

Output Arguments

 
vals
A double-precision array of size ‘size’ contains the values from the MATRIX statement.
ierr
An integer variable that indicates the success of the call to GET_FULL_MATRIX_DATA:
■ierr=0
Successful
■ierr=1
Failed, no MATRIX having an identifier of ID exists in the dataset
■ierr=2
Failed, the value of ‘size’ does not match the size of the MATRIX
■ierr=3
Failed, the MATRIX type is sparse

Extended Definition

GET_FULL_MATRIX_DATA returns the values stored in a dataset MATRIX statement of type full. You can determine the  matrix ordering of the matrix data (row or column ordered), by the type that GET_MATRIX_INFO returns. The order may not be as entered in the MATRIX statement.