Next: Preconditioner routines Up: userhtml Previous: Error handling Contents

Utilities

We have some utitlities available for input and output of sparsematrices; the interfaces to these routines are available in the module psb_util_mod.

ifstarsubroutinesubroutinehb_readRead a sparse matrix from a file in the Harwell-Boeing format

$\begin{lstlisting} call hb_read(a, iret, iunit, filename, b, mtitle) \end{lstlisting}$

Type:: Asynchronous.
On Entry
filename: The name of the file to be read.
Type:optional.
Specified as: a character variable containing a valid file name, or -, in which case the default input unit 5 (i.e. standard input in Unix jargon) is used. Default: -.
iunit: The Fortran file unit number.
Type:optional.
Specified as: an integer value. Only meaningful if filename is not -.

On Return
a: the sparse matrix read from file.
Type:required.
Specified as: a structured data of type spdatapsb_Tspmat_type.
b: Rigth hand side(s).
Type: Optional
An array of type real or complex, rank 2 and having the ALLOCATABLE attribute; will be allocated and filled in if the input file contains a right hand side, otherwise will be left in the UNALLOCATED state.
mtitle: Matrix title.
Type: Optional
A charachter variable of length 72 holding a copy of the matrix title as specified by the Harwell-Boeing format and contained in the input file.
iret: Error code.
Type: required
An integer value; 0 means no error has been detected.

ifstarsubroutinesubroutinehb_writeWrite a sparse matrix to a file in the Harwell-Boeing format

$\begin{lstlisting} call hb_write(a, iret, iunit, filename, key, rhs, mtitle) \end{lstlisting}$

Type:: Asynchronous.
On Entry
a: the sparse matrix to be written.
Type:required.
Specified as: a structured data of type spdatapsb_Tspmat_type.
b: Rigth hand side.
Type: Optional
An array of type real or complex, rank 1 and having the ALLOCATABLE attribute; will be allocated and filled in if the input file contains a right hand side.
filename: The name of the file to be written to.
Type:optional.
Specified as: a character variable containing a valid file name, or -, in which case the default output unit 6 (i.e. standard output in Unix jargon) is used. Default: -.
iunit: The Fortran file unit number.
Type:optional.
Specified as: an integer value. Only meaningful if filename is not -.
key: Matrix key.
Type: Optional
A charachter variable of length 8 holding the matrix key as specified by the Harwell-Boeing format and to be written to file.
mtitle: Matrix title.
Type: Optional
A charachter variable of length 72 holding the matrix title as specified by the Harwell-Boeing format and to be written to file.

On Return
iret: Error code.
Type: required
An integer value; 0 means no error has been detected.

ifstarsubroutinesubroutinemm_mat_readRead a sparse matrix from a file in the MatrixMarket format

$\begin{lstlisting} call mm_mat_read(a, iret, iunit, filename) \end{lstlisting}$

Type:: Asynchronous.
On Entry
filename: The name of the file to be read.
Type:optional.
Specified as: a character variable containing a valid file name, or -, in which case the default input unit 5 (i.e. standard input in Unix jargon) is used. Default: -.
iunit: The Fortran file unit number.
Type:optional.
Specified as: an integer value. Only meaningful if filename is not -.

On Return
a: the sparse matrix read from file.
Type:required.
Specified as: a structured data of type spdatapsb_Tspmat_type.
iret: Error code.
Type: required
An integer value; 0 means no error has been detected.

ifstarsubroutinesubroutinemm_vet_readRead a dense vector from a file in the MatrixMarket format
$\begin{lstlisting} call mm_vet_read(b, iret, iunit, filename) \end{lstlisting}$

Type:: Asynchronous.
On Entry
filename: The name of the file to be read.
Type:optional.
Specified as: a character variable containing a valid file name, or -, in which case the default input unit 5 (i.e. standard input in Unix jargon) is used. Default: -.
iunit: The Fortran file unit number.
Type:optional.
Specified as: an integer value. Only meaningful if filename is not -.

On Return
b: Rigth hand side(s).
Type: required
An array of type real or complex, rank 2 and having the ALLOCATABLE attribute; will be allocated and filled in if the input file contains a right hand side, otherwise will be left in the UNALLOCATED state.
iret: Error code.
Type: required
An integer value; 0 means no error has been detected.

ifstarsubroutinesubroutinemm_mat_writeWrite a sparse matrix to a file in the MatrixMarket format
$\begin{lstlisting} call mm_mat_write(a, mtitle, iret, iunit, filename) \end{lstlisting}$

Type:: Asynchronous.
On Entry
a: the sparse matrix to be written.
Type:required.
Specified as: a structured data of type spdatapsb_Tspmat_type.
mtitle: Matrix title.
Type: required
A charachter variable holding a descriptive title for the matrix to be written to file.
filename: The name of the file to be written to.
Type:optional.
Specified as: a character variable containing a valid file name, or -, in which case the default output unit 6 (i.e. standard output in Unix jargon) is used. Default: -.
iunit: The Fortran file unit number.
Type:optional.
Specified as: an integer value. Only meaningful if filename is not -.

On Return
iret: Error code.
Type: required
An integer value; 0 means no error has been detected.

Next: Preconditioner routines Up: userhtml Previous: Error handling Contents