mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-14 18:09:05 +00:00
psblas3:
Documentation changes. We have barely begun.....
This commit is contained in:
+121
-27
@@ -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_cdfree -- Frees a communication descriptor</TITLE>
|
||||
<META NAME="description" CONTENT="psb_cdfree -- Frees a communication descriptor">
|
||||
<TITLE>psb_cdbldext -- Build an extended communication descriptor</TITLE>
|
||||
<META NAME="description" CONTENT="psb_cdbldext -- Build an extended communication descriptor">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -20,47 +20,51 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="next" HREF="node51.html">
|
||||
<LINK REL="previous" HREF="node49.html">
|
||||
<LINK REL="up" HREF="node45.html">
|
||||
<LINK REL="up" HREF="node44.html">
|
||||
<LINK REL="next" HREF="node51.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html819"
|
||||
<A NAME="tex2html817"
|
||||
HREF="node51.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html815"
|
||||
HREF="node45.html">
|
||||
<A NAME="tex2html813"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html809"
|
||||
<A NAME="tex2html807"
|
||||
HREF="node49.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html817"
|
||||
<A NAME="tex2html815"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html820"
|
||||
HREF="node51.html">psb_cdbldext Build</A>
|
||||
<B> Up:</B> <A NAME="tex2html816"
|
||||
HREF="node45.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html810"
|
||||
HREF="node49.html">psb_cdcpy Copies</A>
|
||||
<B> <A NAME="tex2html818"
|
||||
<B> Next:</B> <A NAME="tex2html818"
|
||||
HREF="node51.html">psb_spall Allocates</A>
|
||||
<B> Up:</B> <A NAME="tex2html814"
|
||||
HREF="node44.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html808"
|
||||
HREF="node49.html">psb_cdfree Frees</A>
|
||||
<B> <A NAME="tex2html816"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00075000000000000000">
|
||||
psb_cdfree -- Frees a communication descriptor</A>
|
||||
<H2><A NAME="SECTION00076000000000000000">
|
||||
psb_cdbldext -- Build an extended communication
|
||||
descriptor</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_cdfree(desc_a, info)
|
||||
call psb_cdbldext(a,desc_a,nl,desc_out, info, extype)
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
This subroutine builds an extended communication descriptor, based on
|
||||
the input descriptor <code>desc_a</code> and on the stencil specified
|
||||
through the input sparse matrix <code>a</code>.
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Synchronous.
|
||||
@@ -68,8 +72,64 @@ call psb_cdfree(desc_a, info)
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>a</STRONG></DT>
|
||||
<DD>A sparse matrix
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a structured data type.
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>the communication descriptor to be freed.
|
||||
<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 spdata<TT>psb_spmat_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>nl</STRONG></DT>
|
||||
<DD>the number of additional layers desired.
|
||||
<BR>
|
||||
Scope:<B>global</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer value <IMG
|
||||
WIDTH="47" HEIGHT="30" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img101.png"
|
||||
ALT="$nl\ge 0$">.
|
||||
</DD>
|
||||
<DT><STRONG>extype</STRONG></DT>
|
||||
<DD>the kind of estension required.
|
||||
<BR>
|
||||
Scope:<B>global</B>.
|
||||
<BR>
|
||||
Type:<B>optional </B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer value
|
||||
<code>psb_ovt_xhal_</code>, <code>psb_ovt_asov_</code>, default: <code>psb_ovt_xhal_</code>
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>desc_out</STRONG></DT>
|
||||
<DD>the extended communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
@@ -79,13 +139,6 @@ Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
@@ -100,7 +153,48 @@ An integer value; 0 means no error has been detected.
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>Specifying <code>psb_ovt_xhal_</code> for the <code>extype</code> argument
|
||||
the user will obtain a descriptor for a domain partition in which
|
||||
the additional layers are fetched as part of an (extended) halo;
|
||||
however the index-to-process mapping is identical to that of the
|
||||
base descriptor;
|
||||
</LI>
|
||||
<LI>Specifying <code>psb_ovt_asov_</code> for the <code>extype</code> argument
|
||||
the user will obtain a descriptor with an overlapped decomposition:
|
||||
the additional layer is aggregated to the local subdomain (and thus
|
||||
is an overlap), and a new halo extending beyond the last additional
|
||||
layer is formed.
|
||||
</LI>
|
||||
</OL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html817"
|
||||
HREF="node51.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html813"
|
||||
HREF="node44.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html807"
|
||||
HREF="node49.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html815"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html818"
|
||||
HREF="node51.html">psb_spall Allocates</A>
|
||||
<B> Up:</B> <A NAME="tex2html814"
|
||||
HREF="node44.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html808"
|
||||
HREF="node49.html">psb_cdfree Frees</A>
|
||||
<B> <A NAME="tex2html816"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user