You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
psblas3/docs/html/userhtmlsu54.html

210 lines
8.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html >
<head><title>psb_sp_getrow &#8212; Extract row(s) from a sparse matrix</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)">
<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)">
<!-- html,3 -->
<meta name="src" content="userhtml.tex">
<link rel="stylesheet" type="text/css" href="userhtml.css">
</head><body
>
<!--l. 1648--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu57.html" >next</a>] [<a
href="userhtmlsu53.html" >prev</a>] [<a
href="userhtmlsu53.html#tailuserhtmlsu53.html" >prev-tail</a>] [<a
href="userhtmlsu51.html#tailuserhtmlsu54.html">tail</a>] [<a
href="userhtmlsu32.html#userhtmlse7.html" >up</a>] </p></div>
<h4 class="subsectionHead"><span class="titlemark">6.25 </span> <a
id="x65-1020006.25"></a>psb_sp_getrow &#8212; Extract row(s) from a sparse matrix</h4>
<pre class="verbatim" id="verbatim-58">
call&#x00A0;psb_sp_getrow(row,&#x00A0;a,&#x00A0;nz,&#x00A0;ia,&#x00A0;ja,&#x00A0;val,&#x00A0;info,&#x00A0;&amp;
&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&#x00A0;&amp;&#x00A0;append,&#x00A0;nzin,&#x00A0;lrw)
</pre>
<!--l. 1654--><p class="nopar" >
<!--l. 1656--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">Type:</span> </dt><dd
class="description">Asynchronous.
</dd><dt class="description">
<span
class="cmbx-10">On Entry</span> </dt><dd
class="description">
</dd><dt class="description">
<span
class="cmbx-10">row</span> </dt><dd
class="description">The (first) row to be extracted.<br
class="newline" />Scope:<span
class="cmbx-10">local</span><br
class="newline" />Type:<span
class="cmbx-10">required</span><br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer <span
class="cmmi-10">&#x003E; </span>0.
</dd><dt class="description">
<span
class="cmbx-10">a</span> </dt><dd
class="description">the matrix from which to get rows.<br
class="newline" />Scope:<span
class="cmbx-10">local</span><br
class="newline" />Type:<span
class="cmbx-10">required</span><br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: a structured data of type <a
href="userhtmlsu6.html#spdata"><span
class="cmtt-10">psb</span><span
class="cmtt-10">_Tspmat</span><span
class="cmtt-10">_type</span></a>.
</dd><dt class="description">
<span
class="cmbx-10">append</span> </dt><dd
class="description">Whether to append or overwrite existing output.<br
class="newline" />Scope:<span
class="cmbx-10">local</span><br
class="newline" />Type:<span
class="cmbx-10">optional</span><br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: a logical value default: false (overwrite).
</dd><dt class="description">
<span
class="cmbx-10">nzin</span> </dt><dd
class="description">Input size to be appended to.<br
class="newline" />Scope:<span
class="cmbx-10">local</span><br
class="newline" />Type:<span
class="cmbx-10">optional</span><br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer <span
class="cmmi-10">&#x003E; </span>0. When append is true, specifies how many
entries in the output vectors are already filled.
</dd><dt class="description">
<span
class="cmbx-10">lrw</span> </dt><dd
class="description">The last row to be extracted.<br
class="newline" />Scope:<span
class="cmbx-10">local</span><br
class="newline" />Type:<span
class="cmbx-10">optional</span><br
class="newline" />Intent: <span
class="cmbx-10">in</span>.<br
class="newline" />Specified as: an integer <span
class="cmmi-10">&#x003E; </span>0, default: <span
class="cmmi-10">row</span>.
</dd></dl>
<!--l. 1696--><p class="indent" >
<dl class="description"><dt class="description">
<span
class="cmbx-10">On Return</span> </dt><dd
class="description">
</dd><dt class="description">
<span
class="cmbx-10">nz</span> </dt><dd
class="description">the number of elements returned by this call.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">out</span>.<br
class="newline" />Returned as: an integer scalar.
</dd><dt class="description">
<span
class="cmbx-10">ia</span> </dt><dd
class="description">the row indices.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />Specified as: an integer array with the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">ALLOCATABLE</span></span></span> attribute.
</dd><dt class="description">
<span
class="cmbx-10">ja</span> </dt><dd
class="description">the column indices of the elements to be inserted.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />Specified as: an integer array with the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">ALLOCATABLE</span></span></span> attribute.
</dd><dt class="description">
<span
class="cmbx-10">val</span> </dt><dd
class="description">the elements to be inserted.<br
class="newline" />Scope:<span
class="cmbx-10">local</span>.<br
class="newline" />Type:<span
class="cmbx-10">required</span>.<br
class="newline" />Intent: <span
class="cmbx-10">inout</span>.<br
class="newline" />Specified as: a real array with the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">ALLOCATABLE</span></span></span> attribute.
</dd><dt class="description">
<span
class="cmbx-10">info</span> </dt><dd
class="description">Error code.<br
class="newline" />Scope: <span
class="cmbx-10">local </span><br
class="newline" />Type: <span
class="cmbx-10">required </span><br
class="newline" />Intent: <span
class="cmbx-10">out</span>.<br
class="newline" />An integer value; 0 means no error has been detected.</dd></dl>
<!--l. 1725--><p class="noindent" ><span
class="cmbx-12">Notes</span>
<ol class="enumerate1" >
<li
class="enumerate" id="x65-102002x1">The output <span
class="cmmi-10">nz </span>is always the size of the output generated by the current
call; thus, if <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">append=.true.</span></span></span>, the total output size will be <span
class="cmmi-10">nzin </span>+ <span
class="cmmi-10">nz</span>, with
the newly extracted coefficients stored in entries <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">nzin+1:nzin+nz</span></span></span> of the
array arguments;
</li>
<li
class="enumerate" id="x65-102004x2">When <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">append=.true.</span></span></span> the output arrays are reallocated as necessary;
</li>
<li
class="enumerate" id="x65-102006x3">The row and column indices are returned in the local numbering
scheme; if the global numbering is desired, the user may employ the
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">psb_loc_to_glob</span></span></span> routine on the output.</li></ol>
<!--l. 1741--><div class="crosslinks"><p class="noindent">[<a
href="userhtmlsu57.html" >next</a>] [<a
href="userhtmlsu53.html" >prev</a>] [<a
href="userhtmlsu53.html#tailuserhtmlsu53.html" >prev-tail</a>] [<a
href="userhtmlsu54.html" >front</a>] [<a
href="userhtmlsu32.html#userhtmlse7.html" >up</a>] </p></div>
<!--l. 1741--><p class="indent" > <a
id="tailuserhtmlsu54.html"></a>
</body></html>