6.8 psb_spins — Insert a set of coefficients into a sparse matrix

Type:

Asynchronous.

On Entry

nz

the number of coefficients to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer scalar.

nr

the number of rows to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer scalar.

irw

the first row to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer scalar.

ia

the row indices of the coefficients to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer array of size nz.

irp

the row pointers of the coefficients to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer array of size nr + 1.

ja

the column indices of the coefficients to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an integer array of size nz.

val

the coefficients to be inserted.
Scope:local.
Type:required.
Intent: in.
Specified as: an array of size nz. Must be of the same type and kind of the coefficients of the sparse matrix a.

desc_a

The communication descriptor.
Scope: local.
Type: required.
Intent: inout.
Specified as: a variable of type psb_desc_type.

local

Whether the entries in the indices vectors ia, ja are already in local numbering.
Scope:local.
Type:optional.
Specified as: a logical value; default: .false..

On Return

a

the matrix into which coefficients will be inserted.
Scope:local
Type:required
Intent: inout.
Specified as: a structured data of type psb_Tspmat_type.

desc_a

The communication descriptor.
Scope: local.
Type: required.
Intent: inout.
Specified as: a variable of type psb_desc_type.

info

Error code.
Scope: local
Type: required
Intent: out.
An integer value; 0 means no error has been detected.

Notes

1. On entry to this routine the descriptor may be in either the build or assembled state.
2. On entry to this routine the sparse matrix may be in either the build or update state.
3. If the descriptor is in the build state, then the sparse matrix must also be in the build state; the action of the routine is to (implicitly) call psb_cdins to add entries to the sparsity pattern; each sparse matrix entry implicitly defines a graph edge, that is passed to the descriptor routine for the appropriate processing;
4. The input data can be passed in either COO or CSR formats;
5. In COO format the coefficients to be inserted are represented by the ordered triples ia(i),ja(i),val(i), for i = 1,…,nz; these triples should belong to the current process, i.e. ia(i) should be one of the local indices, but are otherwise arbitrary;
6. In CSR format the coefficients to be inserted for each input row i = 1,nr are represented by the ordered triples (i + irw - 1),ja(j),val(j), for j = irp(i),…,irp(i + 1) - 1; these triples should belong to the current process, i.e. i+irw-1 should be one of the local indices, but are otherwise arbitrary;
7. There is no requirement that a given row must be passed in its entirety to a single call to this routine: the buildup of a row may be split into as many calls as desired (even in the CSR format);
8. Coefficients from different rows may also be mixed up freely in a single call, according to the application needs;
9. Any coefficients from matrix rows not owned by the calling process are silently ignored;
10. If the descriptor is in the assembled state, then any entries in the sparse matrix that would generate additional communication requirements are ignored;
11. If the matrix is in the update state, any entries in positions that were not present in the original matrix are ignored.