Updated docs with CLONE method.
This commit is contained in:
Salvatore Filippone
2013-04-01 14:34:41 +00:00
parent db2daa7ab9
commit 8ba8f2b213
260 changed files with 21161 additions and 21017 deletions
+45 -50
View File
@@ -7,8 +7,8 @@ original version by: Nikos Drakos, CBLU, University of Leeds
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Named Constants</TITLE>
<META NAME="description" CONTENT="Named Constants">
<TITLE>psb_cd_set_large_threshold -- Set threshold for index mapping switch</TITLE>
<META NAME="description" CONTENT="psb_cd_set_large_threshold -- Set threshold for index mapping switch">
<META NAME="keywords" CONTENT="userhtml">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
@@ -18,78 +18,73 @@ original version by: Nikos Drakos, CBLU, University of Leeds
<LINK REL="STYLESHEET" HREF="userhtml.css">
<LINK REL="next" HREF="node20.html">
<LINK REL="previous" HREF="node18.html">
<LINK REL="up" HREF="node16.html">
<LINK REL="up" HREF="node17.html">
<LINK REL="next" HREF="node20.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html432"
<A NAME="tex2html439"
HREF="node20.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html428"
HREF="node16.html">
<A NAME="tex2html435"
HREF="node17.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html424"
<A NAME="tex2html429"
HREF="node18.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html430"
<A NAME="tex2html437"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html433"
HREF="node20.html">Sparse Matrix class</A>
<B> Up:</B> <A NAME="tex2html429"
HREF="node16.html">get_context Get communication context</A>
<B> Previous:</B> <A NAME="tex2html425"
HREF="node18.html">psb_cd_set_large_threshold Set</A>
&nbsp; <B> <A NAME="tex2html431"
<B> Next:</B> <A NAME="tex2html440"
HREF="node20.html">Named Constants</A>
<B> Up:</B> <A NAME="tex2html436"
HREF="node17.html">clone Clone current object</A>
<B> Previous:</B> <A NAME="tex2html430"
HREF="node18.html">psb_cd_get_large_threshold Get</A>
&nbsp; <B> <A NAME="tex2html438"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION00042300000000000000"></A>
<A NAME="sec:cd_constants"></A>
<BR>
Named Constants
<H3><A NAME="SECTION00043200000000000000">
psb_cd_set_large_threshold -- Set threshold for
index mapping switch</A>
</H3>
<DL>
<DT><STRONG>psb_none_</STRONG></DT>
<DD>Generic no-op;
</DD>
<DT><STRONG>psb_nohalo_</STRONG></DT>
<DD>Do not fetch halo elements;
</DD>
<DT><STRONG>psb_halo_</STRONG></DT>
<DD>Fetch halo elements from neighbouring processes;
</DD>
<DT><STRONG>psb_sum_</STRONG></DT>
<DD>Sum overlapped elements
</DD>
<DT><STRONG>psb_avg_</STRONG></DT>
<DD>Average overlapped elements
</DD>
<DT><STRONG>psb_comm_halo_</STRONG></DT>
<DD>Exchange data based on the <code>halo_index</code>
list;
</DD>
<DT><STRONG>psb_comm_ext_</STRONG></DT>
<DD>Exchange data based on the <code>ext_index</code>
list;
</DD>
<DT><STRONG>psb_comm_ovr_</STRONG></DT>
<DD>Exchange data based on the <code>ovrlap_index</code>
list;
</DD>
<DT><STRONG>psb_comm_mov_</STRONG></DT>
<DD>Exchange data based on the <code>ovr_mst_idx</code>
list;
<PRE>
call psb_cd_set_large_threshold(ith)
</PRE>
<P>
<DL>
<DT><STRONG>Type:</STRONG></DT>
<DD>Synchronous.
</DD>
<DT><STRONG><B>On Entry</B></STRONG></DT>
<DD>
</DD>
<DT><STRONG>ith</STRONG></DT>
<DD>the new threshold for communication descriptors.
<BR>
Scope: <B>global</B>.
<BR>
Type: <B>required</B>.
<BR>
Intent: <B>in</B>.
<BR>
Specified as: an integer value greater than zero.
</DD>
</DL>
Note: the threshold value is only queried by the library at the time a
call to <code>psb_cdall</code> is executed, therefore changing the threshold
has no effect on communication descriptors that have already been
initialized. Moreover the threshold must have the same value on all
processes.
<P>
<BR><HR>