mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-06 22:55:08 +00:00
psblas3:
Updated docs with CLONE method.
This commit is contained in:
Salvatore Filippone
+89
-218
@@ -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_cdins -- Communication descriptor insert routine</TITLE>
|
||||
<META NAME="description" CONTENT="psb_cdins -- Communication descriptor insert routine">
|
||||
<TITLE>Data management routines</TITLE>
|
||||
<META NAME="description" CONTENT="Data management routines">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -18,243 +18,114 @@ original version by: Nikos Drakos, CBLU, University of Leeds
|
||||
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node59.html">
|
||||
<LINK REL="previous" HREF="node57.html">
|
||||
<LINK REL="up" HREF="node56.html">
|
||||
<LINK REL="next" HREF="node86.html">
|
||||
<LINK REL="previous" HREF="node53.html">
|
||||
<LINK REL="up" HREF="userhtml.html">
|
||||
<LINK REL="next" HREF="node59.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html948"
|
||||
<A NAME="tex2html923"
|
||||
HREF="node59.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html944"
|
||||
HREF="node56.html">
|
||||
<A NAME="tex2html919"
|
||||
HREF="userhtml.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html938"
|
||||
<A NAME="tex2html913"
|
||||
HREF="node57.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html946"
|
||||
<A NAME="tex2html921"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html949"
|
||||
HREF="node59.html">psb_cdasb Communication</A>
|
||||
<B> Up:</B> <A NAME="tex2html945"
|
||||
HREF="node56.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html939"
|
||||
HREF="node57.html">psb_cdall Allocates</A>
|
||||
<B> <A NAME="tex2html947"
|
||||
<B> Next:</B> <A NAME="tex2html924"
|
||||
HREF="node59.html">psb_cdall Allocates</A>
|
||||
<B> Up:</B> <A NAME="tex2html920"
|
||||
HREF="userhtml.html">userhtml</A>
|
||||
<B> Previous:</B> <A NAME="tex2html914"
|
||||
HREF="node57.html">psb_scatter Scatter</A>
|
||||
<B> <A NAME="tex2html922"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00072000000000000000">
|
||||
psb_cdins -- Communication descriptor insert routine</A>
|
||||
</H2>
|
||||
<H1><A NAME="SECTION00070000000000000000"></A>
|
||||
<A NAME="sec:toolsrout"></A>
|
||||
<BR>
|
||||
Data management routines
|
||||
</H1>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call psb_cdins(nz, ia, ja, desc_a, info [,ila,jla])
|
||||
call psb_cdins(nz,ja,desc,info[,jla,mask,lidx])
|
||||
</PRE>
|
||||
<BR><HR>
|
||||
<!--Table of Child-Links-->
|
||||
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
|
||||
|
||||
<P>
|
||||
This subroutine examines the edges of the graph associated with the
|
||||
discretization mesh (and isomorphic to the sparsity pattern of a
|
||||
linear system coefficient matrix), storing them as necessary into the
|
||||
communication descriptor. In the first form the edges are specified as
|
||||
pairs of indices <IMG
|
||||
WIDTH="77" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img95.png"
|
||||
ALT="$ia(i),ja(i)$">; the starting index <IMG
|
||||
WIDTH="35" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img96.png"
|
||||
ALT="$ia(i)$"> should
|
||||
belong to the current process.
|
||||
In the second form only the remote indices <IMG
|
||||
WIDTH="38" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
|
||||
SRC="img97.png"
|
||||
ALT="$ja(i)$"> are specified.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>nz</STRONG></DT>
|
||||
<DD>the number of points being inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer value.
|
||||
</DD>
|
||||
<DT><STRONG>ia</STRONG></DT>
|
||||
<DD>the indices of the starting vertex of the edges being inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">.
|
||||
</DD>
|
||||
<DT><STRONG>ja</STRONG></DT>
|
||||
<DD>the indices of the end vertex of the edges being inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">.
|
||||
</DD>
|
||||
<DT><STRONG>mask</STRONG></DT>
|
||||
<DD>Mask entries in <code>ja</code>, they are inserted only when the
|
||||
corresponding <code>mask</code> entries are <code>.true.</code>
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a logical array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">, default <code>.true.</code>.
|
||||
</DD>
|
||||
<DT><STRONG>lidx</STRONG></DT>
|
||||
<DD>User defined local indices for <code>ja</code>.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an integer array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>the updated communication descriptor.
|
||||
<BR>
|
||||
Scope:<B>local</B>.
|
||||
<BR>
|
||||
Type:<B>required</B>.
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a structured data of type descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Error code.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
An integer value; 0 means no error has been detected.
|
||||
</DD>
|
||||
<DT><STRONG>ila</STRONG></DT>
|
||||
<DD>the local indices of the starting vertex of the edges being inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: an integer array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">.
|
||||
</DD>
|
||||
<DT><STRONG>jla</STRONG></DT>
|
||||
<DD>the local indices of the end vertex of the edges being inserted.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>out</B>.
|
||||
<BR>
|
||||
Specified as: an integer array of length <IMG
|
||||
WIDTH="21" HEIGHT="14" ALIGN="BOTTOM" BORDER="0"
|
||||
SRC="img98.png"
|
||||
ALT="$nz$">.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
</DL>
|
||||
<FONT SIZE="+1"><B>Notes</B></FONT>
|
||||
|
||||
<OL>
|
||||
<LI>This routine may only be called if the descriptor is in the
|
||||
build state;
|
||||
</LI>
|
||||
<LI>This routine automatically ignores edges that do not
|
||||
insist on the current process, i.e. edges for which neither the starting
|
||||
nor the end vertex belong to the current process.
|
||||
</LI>
|
||||
<LI>The second form of this routine will be useful when dealing with
|
||||
user-specified index mappings; see also <A HREF="node7.html#sec:usermaps">2.3.1</A>.
|
||||
</LI>
|
||||
</OL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html948"
|
||||
HREF="node59.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html944"
|
||||
HREF="node56.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html938"
|
||||
HREF="node57.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html946"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html949"
|
||||
HREF="node59.html">psb_cdasb Communication</A>
|
||||
<B> Up:</B> <A NAME="tex2html945"
|
||||
HREF="node56.html">Data management routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html939"
|
||||
HREF="node57.html">psb_cdall Allocates</A>
|
||||
<B> <A NAME="tex2html947"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<!--End of Navigation Panel-->
|
||||
<UL>
|
||||
<LI><A NAME="tex2html925"
|
||||
HREF="node59.html">psb_cdall -- Allocates a communication descriptor</A>
|
||||
<LI><A NAME="tex2html926"
|
||||
HREF="node60.html">psb_cdins -- Communication descriptor insert routine</A>
|
||||
<LI><A NAME="tex2html927"
|
||||
HREF="node61.html">psb_cdasb -- Communication descriptor assembly routine</A>
|
||||
<LI><A NAME="tex2html928"
|
||||
HREF="node62.html">psb_cdcpy -- Copies a communication descriptor</A>
|
||||
<LI><A NAME="tex2html929"
|
||||
HREF="node63.html">psb_cdfree -- Frees a communication descriptor</A>
|
||||
<LI><A NAME="tex2html930"
|
||||
HREF="node64.html">psb_cdbldext -- Build an extended communication
|
||||
descriptor</A>
|
||||
<LI><A NAME="tex2html931"
|
||||
HREF="node65.html">psb_spall -- Allocates a sparse matrix</A>
|
||||
<LI><A NAME="tex2html932"
|
||||
HREF="node66.html">psb_spins -- Insert a cloud of elements into a sparse
|
||||
matrix</A>
|
||||
<LI><A NAME="tex2html933"
|
||||
HREF="node67.html">psb_spasb -- Sparse matrix assembly routine</A>
|
||||
<LI><A NAME="tex2html934"
|
||||
HREF="node68.html">psb_spfree -- Frees a sparse matrix</A>
|
||||
<LI><A NAME="tex2html935"
|
||||
HREF="node69.html">psb_sprn -- Reinit sparse matrix structure for psblas
|
||||
routines.</A>
|
||||
<LI><A NAME="tex2html936"
|
||||
HREF="node70.html">psb_geall -- Allocates a dense matrix</A>
|
||||
<LI><A NAME="tex2html937"
|
||||
HREF="node71.html">psb_geins -- Dense matrix insertion routine</A>
|
||||
<LI><A NAME="tex2html938"
|
||||
HREF="node72.html">psb_geasb -- Assembly a dense matrix</A>
|
||||
<LI><A NAME="tex2html939"
|
||||
HREF="node73.html">psb_gefree -- Frees a dense matrix</A>
|
||||
<LI><A NAME="tex2html940"
|
||||
HREF="node74.html">psb_gelp -- Applies a left permutation to a dense
|
||||
matrix</A>
|
||||
<LI><A NAME="tex2html941"
|
||||
HREF="node75.html">psb_glob_to_loc -- Global to local indices
|
||||
convertion</A>
|
||||
<LI><A NAME="tex2html942"
|
||||
HREF="node76.html">psb_loc_to_glob -- Local to global indices
|
||||
conversion</A>
|
||||
<LI><A NAME="tex2html943"
|
||||
HREF="node77.html">psb_is_owned </A>
|
||||
<LI><A NAME="tex2html944"
|
||||
HREF="node78.html">psb_owned_index </A>
|
||||
<LI><A NAME="tex2html945"
|
||||
HREF="node79.html">psb_is_local </A>
|
||||
<LI><A NAME="tex2html946"
|
||||
HREF="node80.html">psb_local_index </A>
|
||||
<LI><A NAME="tex2html947"
|
||||
HREF="node81.html">psb_get_boundary -- Extract list of boundary elements</A>
|
||||
<LI><A NAME="tex2html948"
|
||||
HREF="node82.html">psb_get_overlap -- Extract list of overlap elements</A>
|
||||
<LI><A NAME="tex2html949"
|
||||
HREF="node83.html">psb_sp_getrow -- Extract row(s) from a sparse matrix</A>
|
||||
<LI><A NAME="tex2html950"
|
||||
HREF="node84.html">psb_sizeof -- Memory occupation</A>
|
||||
<LI><A NAME="tex2html951"
|
||||
HREF="node85.html">Sorting utilities</A>
|
||||
</UL>
|
||||
<!--End of Table of Child-Links-->
|
||||
<BR><HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user