Updated docs with fnd_owner adn set_p_adjcncy

This commit is contained in:
Salvatore Filippone
2019-12-12 17:37:31 +00:00
parent acae5f9278
commit db2458dd29
327 changed files with 25044 additions and 24405 deletions
+135 -138
View File
@@ -3,8 +3,8 @@
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
<HTML>
<HEAD>
<TITLE>psb_normi -- Infinity-Norm of Vector</TITLE>
<META NAME="description" CONTENT="psb_normi -- Infinity-Norm of Vector">
<TITLE>psb_geaxpby -- General Dense Matrix Sum</TITLE>
<META NAME="description" CONTENT="psb_geaxpby -- General Dense Matrix Sum">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -16,129 +16,101 @@
<LINK REL="next" HREF="node57.html">
<LINK REL="previous" HREF="node55.html">
<LINK REL="up" HREF="node52.html">
<LINK REL="up" HREF="node55.html">
<LINK REL="next" HREF="node57.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html947"
<A NAME="tex2html956"
HREF="node57.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html943"
HREF="node52.html">
<A NAME="tex2html952"
HREF="node55.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html937"
<A NAME="tex2html946"
HREF="node55.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html945"
<A NAME="tex2html954"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html948"
HREF="node57.html">psb_geamaxs Generalized</A>
<B> Up:</B> <A NAME="tex2html944"
HREF="node52.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html938"
HREF="node55.html">psb_gedots Generalized</A>
&nbsp; <B> <A NAME="tex2html946"
<B> Next:</B> <A NAME="tex2html957"
HREF="node57.html">psb_gedot Dot</A>
<B> Up:</B> <A NAME="tex2html953"
HREF="node55.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html947"
HREF="node55.html">Computational routines</A>
&nbsp; <B> <A NAME="tex2html955"
HREF="node1.html">Contents</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION00054000000000000000">
psb_normi -- Infinity-Norm of Vector</A>
<H2><A NAME="SECTION00051000000000000000">
psb_geaxpby -- General Dense Matrix Sum</A>
</H2>
<P>
This function computes
the infinity-norm of a vector <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN>.
<BR>
If <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN> is a real vector
it computes infinity norm as:
This subroutine is an interface to the computational kernel for
dense matrix sum:
<BR><P></P>
<DIV ALIGN="CENTER" CLASS="mathdisplay">
<!-- MATH
\begin{displaymath}
amax \leftarrow \max_i |x_i|
y \leftarrow \alpha\> x+ \beta y
\end{displaymath}
-->
<IMG
WIDTH="118" HEIGHT="36" BORDER="0"
SRC="img30.png"
ALT="\begin{displaymath}amax \leftarrow \max_i \vert x_i\vert\end{displaymath}">
WIDTH="93" HEIGHT="27" BORDER="0"
SRC="img19.png"
ALT="\begin{displaymath}y \leftarrow \alpha\&gt; x+ \beta y \end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
else if <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN> is a complex vector then it computes the infinity-norm as:
<BR><P></P>
<DIV ALIGN="CENTER" CLASS="mathdisplay">
<!-- MATH
\begin{displaymath}
amax \leftarrow \max_i {(|re(x_i)| + |im(x_i)|)}
\end{displaymath}
-->
<IMG
WIDTH="232" HEIGHT="36" BORDER="0"
SRC="img31.png"
ALT="\begin{displaymath}amax \leftarrow \max_i {(\vert re(x_i)\vert + \vert im(x_i)\vert)}\end{displaymath}">
</DIV>
<BR CLEAR="ALL">
<P></P>
<P></P>
<P>
<PRE>
psb_geamax(x, desc_a, info [,global])
psb_normi(x, desc_a, info [,global])
call psb_geaxpby(alpha, x, beta, y, desc_a, info)
</PRE>
<P>
<BR><P></P>
<DIV ALIGN="CENTER"><A NAME="2026"></A>
<DIV ALIGN="CENTER"><A NAME="2102"></A>
<TABLE>
<CAPTION><STRONG>Table 4:</STRONG>
<CAPTION><STRONG>Table 1:</STRONG>
Data types</CAPTION>
<TR><TD>
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3 BORDER="1" ALIGN="CENTER">
<TR><TD ALIGN="LEFT"><SPAN CLASS="MATH"><IMG
WIDTH="43" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img32.png"
ALT="$amax$"></SPAN></TD>
<TD ALIGN="LEFT"><SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN></TD>
<TD ALIGN="LEFT"><B>Function</B></TD>
ALT="$x$"></SPAN>, <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN>, <SPAN CLASS="MATH"><IMG
WIDTH="14" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img22.png"
ALT="$\alpha$"></SPAN>, <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img23.png"
ALT="$\beta$"></SPAN></TD>
<TD ALIGN="LEFT"><B>Subroutine</B></TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
<TD ALIGN="LEFT">psb_geaxpby</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
<TD ALIGN="LEFT">psb_geaxpby</TD>
</TR>
<TR><TD ALIGN="LEFT">Short Precision Real</TD>
<TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
<TR><TD ALIGN="LEFT">Short Precision Complex</TD>
<TD ALIGN="LEFT">psb_geaxpby</TD>
</TR>
<TR><TD ALIGN="LEFT">Long Precision Real</TD>
<TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_geamax</TD>
<TR><TD ALIGN="LEFT">Long Precision Complex</TD>
<TD ALIGN="LEFT">psb_geaxpby</TD>
</TR>
</TABLE>
</DIV>
@@ -155,13 +127,27 @@ Data types</CAPTION>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>alpha</STRONG></DT>
<DD>the scalar <SPAN CLASS="MATH"><IMG
WIDTH="14" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img22.png"
ALT="$\alpha$"></SPAN>.
<BR>
Scope: <B>global</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a number of the data
type indicated in Table&nbsp;<A HREF="#tab:f90axpby">1</A>.
</DD>
<DT><STRONG>x</STRONG></DT>
<DD>the local portion of global dense matrix
<SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN>.
ALT="$x$"></SPAN>.
<BR>
Scope: <B>local</B>
<BR>
@@ -169,9 +155,51 @@ Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>
containing numbers of type specified in
Table&nbsp;<A HREF="#tab:f90amax">4</A>.
Specified as: a rank one or two array or an object of type vdata<TT>psb_T_vect_type</TT>
containing numbers of type
specified in Table&nbsp;<A HREF="#tab:f90axpby">1</A>. The rank of <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN> must be the same of <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN>.
</DD>
<DT><STRONG>beta</STRONG></DT>
<DD>the scalar <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
SRC="img23.png"
ALT="$\beta$"></SPAN>.
<BR>
Scope: <B>global</B>
<BR>
Type: <B>required</B>
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a number of the data type indicated in Table&nbsp;<A HREF="#tab:f90axpby">1</A>.
</DD>
<DT><STRONG>y</STRONG></DT>
<DD>the local portion of the global dense matrix
<SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN>.
<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> containing numbers of the type
indicated in Table&nbsp;<A HREF="#tab:f90axpby">1</A>. The rank of <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN> must be the same of <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN>.
</DD>
<DT><STRONG>desc_a</STRONG></DT>
<DD>contains data structures for communications.
@@ -183,36 +211,30 @@ Type: <B>required</B>
Intent: <B>in</B>.
<BR>
Specified as: an object of type descdata<TT>psb_desc_type</TT>.
</DD>
<DT><STRONG>global</STRONG></DT>
<DD>Specifies whether the computation should include the
global reduction across all processes.
<BR>
Scope: <B>global</B>
<BR>
Type: <B>optional</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: a logical scalar.
Default: <code>global=.true.</code>
<BR>
<P>
</DD>
</DL>
<P>
<DL>
<DT><STRONG><B>On Return</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>Function value</STRONG></DT>
<DD>is the infinity norm of vector <SPAN CLASS="MATH"><IMG
WIDTH="13" HEIGHT="13" ALIGN="BOTTOM" BORDER="0"
SRC="img20.png"
ALT="$x$"></SPAN>.
<DT><STRONG>y</STRONG></DT>
<DD>the local portion of result submatrix <SPAN CLASS="MATH"><IMG
WIDTH="12" HEIGHT="29" ALIGN="MIDDLE" BORDER="0"
SRC="img21.png"
ALT="$y$"></SPAN>.
<BR>
Scope: <B>global</B> unless the optional variable
<code>global=.false.</code> has been specified
Scope: <B>local</B>
<BR>
Specified as: a long precision real number.
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> containing numbers of the type
indicated in Table&nbsp;<A HREF="#tab:f90axpby">1</A>.
</DD>
<DT><STRONG>info</STRONG></DT>
<DD>Error code.
@@ -227,55 +249,30 @@ An integer value; 0 means no error has been detected.
</DD>
</DL>
<P>
<BIG CLASS="LARGE"><B>Notes</B></BIG>
<OL>
<LI>The computation of a global result requires a global
communication, which entails a significant overhead. It may be
necessary and/or advisable to compute multiple norms at the same
time; in this case, it is possible to improve the runtime efficiency
by using the following scheme:
<BR>
<IMG
WIDTH="480" HEIGHT="73" ALIGN="BOTTOM" BORDER="0"
SRC="img33.png"
ALT="\begin{lstlisting}
vres(1) = psb_geamax(x1,desc_a,info,global=.false.)
vres(2)...
...(x3,desc_a,info,global=.false.)
call psb_amx(ictxt,vres(1:3))
\end{lstlisting}">
<BR>
In this way the global communication, which for small sizes is a
latency-bound operation, is invoked only once.
</LI>
</OL>
<P>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html947"
<A NAME="tex2html956"
HREF="node57.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html943"
HREF="node52.html">
<A NAME="tex2html952"
HREF="node55.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html937"
<A NAME="tex2html946"
HREF="node55.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html945"
<A NAME="tex2html954"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html948"
HREF="node57.html">psb_geamaxs Generalized</A>
<B> Up:</B> <A NAME="tex2html944"
HREF="node52.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html938"
HREF="node55.html">psb_gedots Generalized</A>
&nbsp; <B> <A NAME="tex2html946"
<B> Next:</B> <A NAME="tex2html957"
HREF="node57.html">psb_gedot Dot</A>
<B> Up:</B> <A NAME="tex2html953"
HREF="node55.html">Computational routines</A>
<B> Previous:</B> <A NAME="tex2html947"
HREF="node55.html">Computational routines</A>
&nbsp; <B> <A NAME="tex2html955"
HREF="node1.html">Contents</A></B> </DIV>
<!--End of Navigation Panel-->