mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-07 07:04:57 +00:00
psblas3:
Updated docs with CLONE method.
This commit is contained in:
+143
-41
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>psb_gefree -- Frees a dense matrix</TITLE>
|
||||
<META NAME="description" CONTENT="psb_gefree -- Frees a dense matrix">
|
||||
<TITLE>psb_geins -- Dense matrix insertion routine</TITLE>
|
||||
<META NAME="description" CONTENT="psb_geins -- Dense matrix insertion routine">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -20,80 +20,136 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node72.html">
|
||||
<LINK REL="previous" HREF="node70.html">
|
||||
<LINK REL="up" HREF="node56.html">
|
||||
<LINK REL="up" HREF="node58.html">
|
||||
<LINK REL="next" HREF="node72.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1104"
|
||||
<A NAME="tex2html1106"
|
||||
HREF="node72.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1100"
|
||||
HREF="node56.html">
|
||||
<A NAME="tex2html1102"
|
||||
HREF="node58.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1094"
|
||||
<A NAME="tex2html1096"
|
||||
HREF="node70.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1102"
|
||||
<A NAME="tex2html1104"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1105"
|
||||
HREF="node72.html">psb_gelp Applies</A>
|
||||
<B> Up:</B> <A NAME="tex2html1101"
|
||||
HREF="node56.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1095"
|
||||
HREF="node70.html">psb_geasb Assembly</A>
|
||||
<B> <A NAME="tex2html1103"
|
||||
<B> Next:</B> <A NAME="tex2html1107"
|
||||
HREF="node72.html">psb_geasb Assembly</A>
|
||||
<B> Up:</B> <A NAME="tex2html1103"
|
||||
HREF="node58.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1097"
|
||||
HREF="node70.html">psb_geall Allocates</A>
|
||||
<B> <A NAME="tex2html1105"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000715000000000000000">
|
||||
psb_gefree -- Frees a dense matrix</A>
|
||||
<H2><A NAME="SECTION000713000000000000000">
|
||||
psb_geins -- Dense matrix insertion routine</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_gefree(x, desc_a, info)
|
||||
call psb_geins(m, irw, val, x, desc_a, info [,dupl,local])
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Synchronous.
|
||||
<DD>Asynchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>The dense matrix to
|
||||
be freed.
|
||||
<DT><STRONG>m</STRONG></DT>
|
||||
<DD>Number of rows in <IMG
|
||||
WIDTH="25" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img105.png"
|
||||
ALT="$val$"> to be inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array with the ALLOCATABLE or an
|
||||
object of type vdata<TT>psb_T_vect_type</TT>, of type real, complex or integer.
|
||||
<BR>
|
||||
<P>
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>The communication descriptor.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
||||
<BR></DD>
|
||||
Specified as: an integer value.
|
||||
</DD>
|
||||
<DT><STRONG>irw</STRONG></DT>
|
||||
<DD>Indices of the rows to be inserted. Specifically, row <IMG
|
||||
WIDTH="9" HEIGHT="17" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img4.png"
|
||||
ALT="$i$">
|
||||
of <IMG
|
||||
WIDTH="25" HEIGHT="15" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img105.png"
|
||||
ALT="$val$"> will be inserted into the local row corresponding to the
|
||||
global row index <IMG
|
||||
WIDTH="47" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img106.png"
|
||||
ALT="$irw(i)$">.
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer array.
|
||||
</DD>
|
||||
<DT><STRONG>val</STRONG></DT>
|
||||
<DD>the dense submatrix to be inserted.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a rank 1 or 2 array.
|
||||
Specified as: an integer value.
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>the communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>dupl</STRONG></DT>
|
||||
<DD>How to handle duplicate coefficients.
|
||||
<BR>
|
||||
Scope: <B>global</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: integer, possible values: <code>psb_dupl_ovwrt_</code>,
|
||||
<code>psb_dupl_add_</code>.
|
||||
</DD>
|
||||
<DT><STRONG>local</STRONG></DT>
|
||||
<DD>Whether the entries in the index vector <code>irw</code>,
|
||||
are already in local numbering.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>optional</B>.
|
||||
<BR>
|
||||
Specified as: a logical value; default: <code>.false.</code>.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
@@ -101,6 +157,18 @@ Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>the output dense matrix.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>, of
|
||||
type real, complex or integer.
|
||||
<BR></DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
@@ -115,7 +183,41 @@ An integer value; 0 means no error has been detected.
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>Dense vectors/matrices do not have an associated state;
|
||||
</LI>
|
||||
<LI>Duplicate entries are either overwritten or added, there is no
|
||||
provision for raising an error condition.
|
||||
</LI>
|
||||
</OL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1106"
|
||||
HREF="node72.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1102"
|
||||
HREF="node58.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1096"
|
||||
HREF="node70.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1104"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1107"
|
||||
HREF="node72.html">psb_geasb Assembly</A>
|
||||
<B> Up:</B> <A NAME="tex2html1103"
|
||||
HREF="node58.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1097"
|
||||
HREF="node70.html">psb_geall Allocates</A>
|
||||
<B> <A NAME="tex2html1105"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user