mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-07 23:16:45 +00:00
psblas3:
Updated docs.
This commit is contained in:
+33
-127
@@ -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_glob_to_loc -- Global to local indices convertion</TITLE>
|
||||
<META NAME="description" CONTENT="psb_glob_to_loc -- Global to local indices convertion">
|
||||
<TITLE>psb_gefree -- Frees a dense matrix</TITLE>
|
||||
<META NAME="description" CONTENT="psb_gefree -- Frees a dense matrix">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -20,101 +20,80 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node86.html">
|
||||
<LINK REL="previous" HREF="node84.html">
|
||||
<LINK REL="up" HREF="node68.html">
|
||||
<LINK REL="up" HREF="node70.html">
|
||||
<LINK REL="next" HREF="node86.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1310"
|
||||
<A NAME="tex2html1316"
|
||||
HREF="node86.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1306"
|
||||
HREF="node68.html">
|
||||
<A NAME="tex2html1312"
|
||||
HREF="node70.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1300"
|
||||
<A NAME="tex2html1306"
|
||||
HREF="node84.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1308"
|
||||
<A NAME="tex2html1314"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1311"
|
||||
HREF="node86.html">psb_loc_to_glob Local</A>
|
||||
<B> Up:</B> <A NAME="tex2html1307"
|
||||
HREF="node68.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1301"
|
||||
HREF="node84.html">psb_gelp Applies</A>
|
||||
<B> <A NAME="tex2html1309"
|
||||
<B> Next:</B> <A NAME="tex2html1317"
|
||||
HREF="node86.html">psb_gelp Applies</A>
|
||||
<B> Up:</B> <A NAME="tex2html1313"
|
||||
HREF="node70.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1307"
|
||||
HREF="node84.html">psb_geasb Assembly</A>
|
||||
<B> <A NAME="tex2html1315"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000717000000000000000">
|
||||
psb_glob_to_loc -- Global to local indices
|
||||
convertion</A>
|
||||
<H2><A NAME="SECTION000715000000000000000">
|
||||
psb_gefree -- Frees a dense matrix</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_glob_to_loc(x, y, desc_a, info, iact,owned)
|
||||
call psb_glob_to_loc(x, desc_a, info, iact,owned)
|
||||
call psb_gefree(x, desc_a, info)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
<DD>Synchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>An integer vector of indices to be converted.
|
||||
<DD>The dense matrix to
|
||||
be freed.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in, inout</B>.
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one integer array.
|
||||
<BR></DD>
|
||||
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.
|
||||
<DD>The communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
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>iact</STRONG></DT>
|
||||
<DD>specifies action to be taken in case of range errors.
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a character variable <code>I</code>gnore, <code>W</code>arning or
|
||||
<code>A</code>bort, default <code>I</code>gnore.
|
||||
</DD>
|
||||
<DT><STRONG>owned</STRONG></DT>
|
||||
<DD>Specfies valid range of input
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
If true, then only indices strictly owned by the current process are
|
||||
considered valid, if false then halo indices are also
|
||||
accepted. Default: false.
|
||||
</DD>
|
||||
Specified as: a variable of type descdata<TT>psb_desc_type</TT>.
|
||||
<BR></DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
@@ -122,44 +101,6 @@ accepted. Default: false.
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>If <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img21.png"
|
||||
ALT="$y$"> is not present,
|
||||
then <IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img20.png"
|
||||
ALT="$x$"> is overwritten with the translated integer indices.
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a rank one integer array.
|
||||
</DD>
|
||||
<DT><STRONG>y</STRONG></DT>
|
||||
<DD>If <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img21.png"
|
||||
ALT="$y$"> is present,
|
||||
then <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img21.png"
|
||||
ALT="$y$"> is overwritten with the translated integer indices, and <IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img20.png"
|
||||
ALT="$x$">
|
||||
is left unchanged.
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: a rank one integer array.
|
||||
</DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
@@ -174,42 +115,7 @@ An integer value; 0 means no error has been detected.
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>If an input index is out of range, then the corresponding output
|
||||
index is set to a negative number;
|
||||
</LI>
|
||||
<LI>The default <code>I</code>gnore means that the negative output is the
|
||||
only action taken on an out-of-range input.
|
||||
</LI>
|
||||
</OL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1310"
|
||||
HREF="node86.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1306"
|
||||
HREF="node68.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1300"
|
||||
HREF="node84.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1308"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1311"
|
||||
HREF="node86.html">psb_loc_to_glob Local</A>
|
||||
<B> Up:</B> <A NAME="tex2html1307"
|
||||
HREF="node68.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1301"
|
||||
HREF="node84.html">psb_gelp Applies</A>
|
||||
<B> <A NAME="tex2html1309"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
<BR><HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user