You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
195 lines
5.1 KiB
HTML
195 lines
5.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
<!--Converted with LaTeX2HTML 2017.2 (Released Jan 23, 2017) -->
|
|
<HTML>
|
|
<HEAD>
|
|
<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">
|
|
|
|
<META NAME="Generator" CONTENT="LaTeX2HTML v2017.2">
|
|
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
|
|
|
|
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
|
|
|
<LINK REL="next" HREF="node128.html">
|
|
<LINK REL="previous" HREF="node126.html">
|
|
<LINK REL="up" HREF="node125.html">
|
|
<LINK REL="next" HREF="node128.html">
|
|
</HEAD>
|
|
|
|
<BODY >
|
|
|
|
<DIV CLASS="navigation"><!--Navigation Panel-->
|
|
<A NAME="tex2html1849"
|
|
HREF="node128.html">
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
|
<A NAME="tex2html1845"
|
|
HREF="node125.html">
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
|
<A NAME="tex2html1839"
|
|
HREF="node126.html">
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
|
<A NAME="tex2html1847"
|
|
HREF="node1.html">
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
<BR>
|
|
<B> Next:</B> <A NAME="tex2html1850"
|
|
HREF="node128.html">apply Preconditioner</A>
|
|
<B> Up:</B> <A NAME="tex2html1846"
|
|
HREF="node125.html">Preconditioner routines</A>
|
|
<B> Previous:</B> <A NAME="tex2html1840"
|
|
HREF="node126.html">init Initialize</A>
|
|
<B> <A NAME="tex2html1848"
|
|
HREF="node1.html">Contents</A></B>
|
|
<BR>
|
|
<BR></DIV>
|
|
<!--End of Navigation Panel-->
|
|
|
|
<H2><A NAME="SECTION000112000000000000000">
|
|
build -- Builds a preconditioner</A>
|
|
</H2>
|
|
|
|
<P>
|
|
<PRE>
|
|
call prec%build(a, desc_a, info[,amold,vmold,imold])
|
|
</PRE>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><STRONG>Type:</STRONG></DT>
|
|
<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>
|
|
<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>
|
|
<DL>
|
|
<DT><STRONG><B>On Return</B></STRONG></DT>
|
|
<DD>
|
|
</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>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>
|
|
|
|
<DIV CLASS="navigation"><HR>
|
|
<!--Navigation Panel-->
|
|
<A NAME="tex2html1849"
|
|
HREF="node128.html">
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
|
<A NAME="tex2html1845"
|
|
HREF="node125.html">
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
|
<A NAME="tex2html1839"
|
|
HREF="node126.html">
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
|
<A NAME="tex2html1847"
|
|
HREF="node1.html">
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
|
<BR>
|
|
<B> Next:</B> <A NAME="tex2html1850"
|
|
HREF="node128.html">apply Preconditioner</A>
|
|
<B> Up:</B> <A NAME="tex2html1846"
|
|
HREF="node125.html">Preconditioner routines</A>
|
|
<B> Previous:</B> <A NAME="tex2html1840"
|
|
HREF="node126.html">init Initialize</A>
|
|
<B> <A NAME="tex2html1848"
|
|
HREF="node1.html">Contents</A></B> </DIV>
|
|
<!--End of Navigation Panel-->
|
|
|
|
</BODY>
|
|
</HTML>
|