mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-16 10:52:08 +00:00
Updated docs with fnd_owner adn set_p_adjcncy
This commit is contained in:
+128
-26
@@ -3,8 +3,8 @@
|
||||
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>clone -- clone current preconditioner</TITLE>
|
||||
<META NAME="description" CONTENT="clone -- clone current preconditioner">
|
||||
<TITLE>build -- Builds a preconditioner</TITLE>
|
||||
<META NAME="description" CONTENT="build -- Builds a preconditioner">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -16,60 +16,119 @@
|
||||
|
||||
<LINK REL="next" HREF="node131.html">
|
||||
<LINK REL="previous" HREF="node129.html">
|
||||
<LINK REL="up" HREF="node125.html">
|
||||
<LINK REL="up" HREF="node128.html">
|
||||
<LINK REL="next" HREF="node131.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
|
||||
<DIV CLASS="navigation"><!--Navigation Panel-->
|
||||
<A NAME="tex2html1885"
|
||||
<A NAME="tex2html1894"
|
||||
HREF="node131.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1881"
|
||||
HREF="node125.html">
|
||||
<A NAME="tex2html1890"
|
||||
HREF="node128.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1875"
|
||||
<A NAME="tex2html1884"
|
||||
HREF="node129.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1883"
|
||||
<A NAME="tex2html1892"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1886"
|
||||
HREF="node131.html">free Free</A>
|
||||
<B> Up:</B> <A NAME="tex2html1882"
|
||||
HREF="node125.html">Preconditioner routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1876"
|
||||
HREF="node129.html">descr Prints</A>
|
||||
<B> <A NAME="tex2html1884"
|
||||
<B> Next:</B> <A NAME="tex2html1895"
|
||||
HREF="node131.html">apply Preconditioner</A>
|
||||
<B> Up:</B> <A NAME="tex2html1891"
|
||||
HREF="node128.html">Preconditioner routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1885"
|
||||
HREF="node129.html">init Initialize</A>
|
||||
<B> <A NAME="tex2html1893"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR></DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION000115000000000000000">
|
||||
clone -- clone current
|
||||
preconditioner</A>
|
||||
<H2><A NAME="SECTION000112000000000000000">
|
||||
build -- Builds a preconditioner</A>
|
||||
</H2>
|
||||
|
||||
<P>
|
||||
<PRE>
|
||||
call prec%clone(precout,info)
|
||||
call prec%build(a, desc_a, info[,amold,vmold,imold])
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
<DD>Synchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>a</STRONG></DT>
|
||||
<DD>the system sparse matrix.
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>, target.
|
||||
<BR>
|
||||
Specified as: a sparse matrix data structure spdata<TT>psb_Tspmat_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>prec</STRONG></DT>
|
||||
<DD>the preconditioner.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: an already initialized precondtioner data structure precdata<TT>psb_prec_type</TT>
|
||||
<BR></DD>
|
||||
<DT><STRONG>desc_a</STRONG></DT>
|
||||
<DD>the problem communication descriptor.
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>, target.
|
||||
<BR>
|
||||
Specified as: a communication descriptor data structure descdata<TT>psb_desc_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>amold</STRONG></DT>
|
||||
<DD>The desired dynamic type for the internal matrix storage.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an object of a class derived from spbasedata<TT>psb_T_base_sparse_mat</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>vmold</STRONG></DT>
|
||||
<DD>The desired dynamic type for the internal vector storage.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an object of a class derived from vbasedata<TT>psb_T_base_vect_type</TT>.
|
||||
</DD>
|
||||
<DT><STRONG>imold</STRONG></DT>
|
||||
<DD>The desired dynamic type for the internal integer vector storage.
|
||||
<BR>
|
||||
Scope: <B>local</B>.
|
||||
<BR>
|
||||
Type: <B>optional</B>.
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: an object of a class derived from (integer) vbasedata<TT>psb_T_base_vect_type</TT>.
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
@@ -77,16 +136,59 @@ Scope: <B>local</B>.
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>precout</STRONG></DT>
|
||||
<DD>A copy of the input object.
|
||||
</DD>
|
||||
<DT><STRONG>prec</STRONG></DT>
|
||||
<DD>the preconditioner.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>inout</B>.
|
||||
<BR>
|
||||
Specified as: a precondtioner data structure precdata<TT>psb_prec_type</TT>
|
||||
<BR></DD>
|
||||
<DT><STRONG>info</STRONG></DT>
|
||||
<DD>Return code.
|
||||
<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>
|
||||
</DL>
|
||||
The <code>amold</code>, <code>vmold</code> and <code>imold</code> arguments may be
|
||||
employed to interface with special devices, such as GPUs and other
|
||||
accelerators.
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
|
||||
<DIV CLASS="navigation"><HR>
|
||||
<!--Navigation Panel-->
|
||||
<A NAME="tex2html1894"
|
||||
HREF="node131.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html1890"
|
||||
HREF="node128.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html1884"
|
||||
HREF="node129.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html1892"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html1895"
|
||||
HREF="node131.html">apply Preconditioner</A>
|
||||
<B> Up:</B> <A NAME="tex2html1891"
|
||||
HREF="node128.html">Preconditioner routines</A>
|
||||
<B> Previous:</B> <A NAME="tex2html1885"
|
||||
HREF="node129.html">init Initialize</A>
|
||||
<B> <A NAME="tex2html1893"
|
||||
HREF="node1.html">Contents</A></B> </DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
Reference in New Issue
Block a user