Solution Feature Information Methods
Some solver features, including Assemble, Modal, ModalReduction and StateSpace, create and store matrices and vectors. These are accessed by name using the following common methods.
General Information
Table 6-6:
General Matrix Information Methods
method
Description
isReal
Check if matrix is real
getM
Get number of rows
getN
Get number of columns
getNnz
Get number of nonzeros in sparse matrix
Matrix Data
Table 6-7:
Matrix access Methods
method
Description
getSparseMatrixVal
Get matrix values
getSparseMatrixValImag
Get the imaginary matrix values
getSparseMatrixCol
Get column indices of matrix values
getSparseMatrixRow
Get row indices of matrix values
getVector
Get the vector associated with the matrix type
getVectorImag
Get the imaginary part of the vector associated with the matrix type
getSparseMatrixValBlock
A blocked version of getSparseMatrixVal
getSparseMatrixValImagBlock
A blocked version of getSparseMatrixValImag
getSparseMatrixColBlock
A blocked version of getSparseMatrixCol
getSparseMatrixRowBlock
A blocked version of getSparseMatrixRow
getVectorBlock
A blocked version of getVector
getVectorImagBlock
A blocked version of getVectorImag
Matrix Creation
The InputMatrix solver feature allows declaring and defining input matrices using the following methods.
Table 6-8:
Matrix creation Methods
method
Description
createSparseMatrix
Create sparse matrix
addSparseMatrixVal
Add matrix values to the created matrix
addSparseMatrixValImag
Add imaginary matrix values to the created matrix
createVector
Create vector
setVector
Set the vector associated with the matrix type
setVectorImag
Set the imaginary part of the vector associated with the matrix type
setVectorBlock
A blocked version of setVector
setVectorImagBlock
A blocked version of setVectorImag