mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-13 17:39:08 +00:00
psblas3:
Documentation changes. We have barely begun.....
This commit is contained in:
+38
-62
@@ -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_loc_to_glob -- Local to global indices conversion</TITLE>
|
||||
<META NAME="description" CONTENT="psb_loc_to_glob -- Local to global indices conversion">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -20,46 +20,46 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node63.html">
|
||||
<LINK REL="previous" HREF="node61.html">
|
||||
<LINK REL="up" HREF="node45.html">
|
||||
<LINK REL="up" HREF="node44.html">
|
||||
<LINK REL="next" HREF="node63.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html963"
|
||||
<A NAME="tex2html961"
|
||||
HREF="node63.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html959"
|
||||
HREF="node45.html">
|
||||
<A NAME="tex2html957"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html953"
|
||||
<A NAME="tex2html951"
|
||||
HREF="node61.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html961"
|
||||
<A NAME="tex2html959"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html964"
|
||||
HREF="node63.html">psb_loc_to_glob Local</A>
|
||||
<B> Up:</B> <A NAME="tex2html960"
|
||||
HREF="node45.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html954"
|
||||
HREF="node61.html">psb_gelp Applies</A>
|
||||
<B> <A NAME="tex2html962"
|
||||
<B> Next:</B> <A NAME="tex2html962"
|
||||
HREF="node63.html">psb_is_owned</A>
|
||||
<B> Up:</B> <A NAME="tex2html958"
|
||||
HREF="node44.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html952"
|
||||
HREF="node61.html">psb_glob_to_loc Global</A>
|
||||
<B> <A NAME="tex2html960"
|
||||
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="SECTION000718000000000000000">
|
||||
psb_loc_to_glob -- Local to global indices
|
||||
conversion</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_loc_to_glob(x, y, desc_a, info, iact)
|
||||
call psb_loc_to_glob(x, desc_a, info, iact)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
@@ -103,18 +103,6 @@ Intent: <B>in</B>.
|
||||
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>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
@@ -125,11 +113,11 @@ accepted. Default: false.
|
||||
<DT><STRONG>x</STRONG></DT>
|
||||
<DD>If <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img29.png"
|
||||
SRC="img28.png"
|
||||
ALT="$y$"> is not present,
|
||||
then <IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img28.png"
|
||||
SRC="img27.png"
|
||||
ALT="$x$"> is overwritten with the translated integer indices.
|
||||
Scope: <B>global</B>
|
||||
<BR>
|
||||
@@ -142,14 +130,14 @@ Specified as: a rank one integer array.
|
||||
<DT><STRONG>y</STRONG></DT>
|
||||
<DD>If <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img29.png"
|
||||
ALT="$y$"> is present,
|
||||
SRC="img28.png"
|
||||
ALT="$y$"> is not present,
|
||||
then <IMG
|
||||
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img29.png"
|
||||
SRC="img28.png"
|
||||
ALT="$y$"> is overwritten with the translated integer indices, and <IMG
|
||||
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img28.png"
|
||||
SRC="img27.png"
|
||||
ALT="$x$">
|
||||
is left unchanged.
|
||||
Scope: <B>global</B>
|
||||
@@ -173,41 +161,29 @@ An integer value; 0 means no error has been detected.
|
||||
</DD>
|
||||
</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="tex2html963"
|
||||
<A NAME="tex2html961"
|
||||
HREF="node63.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html959"
|
||||
HREF="node45.html">
|
||||
<A NAME="tex2html957"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html953"
|
||||
<A NAME="tex2html951"
|
||||
HREF="node61.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html961"
|
||||
<A NAME="tex2html959"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html964"
|
||||
HREF="node63.html">psb_loc_to_glob Local</A>
|
||||
<B> Up:</B> <A NAME="tex2html960"
|
||||
HREF="node45.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html954"
|
||||
HREF="node61.html">psb_gelp Applies</A>
|
||||
<B> <A NAME="tex2html962"
|
||||
<B> Next:</B> <A NAME="tex2html962"
|
||||
HREF="node63.html">psb_is_owned</A>
|
||||
<B> Up:</B> <A NAME="tex2html958"
|
||||
HREF="node44.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html952"
|
||||
HREF="node61.html">psb_glob_to_loc Global</A>
|
||||
<B> <A NAME="tex2html960"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
|
||||
Reference in New Issue
Block a user