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:
Salvatore Filippone
+91
-45
@@ -3,8 +3,8 @@
|
||||
<!--Converted with LaTeX2HTML 2018 (Released Feb 1, 2018) -->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>Preconditioner data structure</TITLE>
|
||||
<META NAME="description" CONTENT="Preconditioner data structure">
|
||||
<TITLE>set -- Set contents of the vector</TITLE>
|
||||
<META NAME="description" CONTENT="set -- Set contents of the vector">
|
||||
<META NAME="keywords" CONTENT="userhtml">
|
||||
<META NAME="resource-type" CONTENT="document">
|
||||
<META NAME="distribution" CONTENT="global">
|
||||
@@ -15,71 +15,117 @@
|
||||
<LINK REL="STYLESHEET" HREF="userhtml.css">
|
||||
|
||||
<LINK REL="next" HREF="node51.html">
|
||||
<LINK REL="previous" HREF="node43.html">
|
||||
<LINK REL="up" HREF="node9.html">
|
||||
<LINK REL="previous" HREF="node49.html">
|
||||
<LINK REL="up" HREF="node46.html">
|
||||
<LINK REL="next" HREF="node51.html">
|
||||
</HEAD>
|
||||
|
||||
<BODY >
|
||||
|
||||
<DIV CLASS="navigation"><!--Navigation Panel-->
|
||||
<A NAME="tex2html864"
|
||||
<A NAME="tex2html875"
|
||||
HREF="node51.html">
|
||||
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
|
||||
<A NAME="tex2html860"
|
||||
HREF="node9.html">
|
||||
<A NAME="tex2html871"
|
||||
HREF="node46.html">
|
||||
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
|
||||
<A NAME="tex2html854"
|
||||
<A NAME="tex2html865"
|
||||
HREF="node49.html">
|
||||
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
|
||||
<A NAME="tex2html862"
|
||||
<A NAME="tex2html873"
|
||||
HREF="node1.html">
|
||||
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
|
||||
<BR>
|
||||
<B> Next:</B> <A NAME="tex2html865"
|
||||
HREF="node51.html">Heap data structure</A>
|
||||
<B> Up:</B> <A NAME="tex2html861"
|
||||
HREF="node9.html">Data Structures and Classes</A>
|
||||
<B> Previous:</B> <A NAME="tex2html855"
|
||||
HREF="node49.html">clone Clone</A>
|
||||
<B> <A NAME="tex2html863"
|
||||
<B> Next:</B> <A NAME="tex2html876"
|
||||
HREF="node51.html">get_vect Get</A>
|
||||
<B> Up:</B> <A NAME="tex2html872"
|
||||
HREF="node46.html">Dense Vector Data Structure</A>
|
||||
<B> Previous:</B> <A NAME="tex2html866"
|
||||
HREF="node49.html">sizeof Get</A>
|
||||
<B> <A NAME="tex2html874"
|
||||
HREF="node1.html">Contents</A></B>
|
||||
<BR>
|
||||
<BR></DIV>
|
||||
<!--End of Navigation Panel-->
|
||||
|
||||
<H2><A NAME="SECTION00044000000000000000"></A>
|
||||
<A NAME="sec:prec"></A>
|
||||
<BR>
|
||||
Preconditioner data structure
|
||||
</H2>
|
||||
Our base library offers support for simple well known preconditioners
|
||||
like Diagonal Scaling or Block Jacobi with incomplete
|
||||
factorization ILU(0).
|
||||
<H3><A NAME="SECTION00043400000000000000">
|
||||
set -- Set contents of the vector</A>
|
||||
</H3>
|
||||
|
||||
<P>
|
||||
A preconditioner is held in the precdata<TT> psb_prec_type</TT> data structure reported in
|
||||
figure <A HREF="#fig:prectype">6</A>. The <code>psb_prec_type</code>
|
||||
data type may contain a simple preconditioning matrix with the
|
||||
associated communication descriptor.The internal preconditioner is allocated appropriately with the
|
||||
dynamic type corresponding to the desired preconditioner.
|
||||
|
||||
<DIV ALIGN="CENTER"><A NAME="fig:prectype"></A><A NAME="941"></A>
|
||||
<TABLE>
|
||||
<CAPTION ALIGN="BOTTOM"><STRONG>Figure 6:</STRONG>
|
||||
The PSBLAS defined data type that contains a preconditioner.</CAPTION>
|
||||
<TR><TD><SMALL CLASS="SMALL"> </SMALL>
|
||||
<DIV ALIGN="CENTER"></DIV><TABLE WIDTH="90%">
|
||||
<TR><TD>
|
||||
<PRE>
|
||||
type psb_Tprec_type
|
||||
class(psb_T_base_prec_type), allocatable :: prec
|
||||
end type psb_Tprec_type
|
||||
</PRE></TD></TR>
|
||||
</TABLE>
|
||||
<DIV ALIGN="CENTER"></DIV></TD></TR>
|
||||
</TABLE>
|
||||
</DIV>
|
||||
call v%set(alpha[,first,last])
|
||||
call v%set(vect[,first,last])
|
||||
call v%zero()
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG>Type:</STRONG></DT>
|
||||
<DD>Asynchronous.
|
||||
</DD>
|
||||
<DT><STRONG><B>On Entry</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>v</STRONG></DT>
|
||||
<DD>the dense vector
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR></DD>
|
||||
<DT><STRONG>alpha</STRONG></DT>
|
||||
<DD>A scalar value.
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data
|
||||
type indicated in Table <A HREF="#tab:f90axpby">1</A>.
|
||||
|
||||
<P>
|
||||
</DD>
|
||||
<DT><STRONG>first,last</STRONG></DT>
|
||||
<DD>Boundaries for setting in the vector.
|
||||
<BR>
|
||||
Scope: <B> local</B>
|
||||
<BR>
|
||||
Type: <B>optional</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified
|
||||
as: integers.
|
||||
</DD>
|
||||
<DT><STRONG>vect</STRONG></DT>
|
||||
<DD>An array
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR>
|
||||
Type: <B>required</B>
|
||||
<BR>
|
||||
Intent: <B>in</B>.
|
||||
<BR>
|
||||
Specified as: a number of the data
|
||||
type indicated in Table <A HREF="#tab:f90axpby">1</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
Note that a call to <code>v%zero()</code> is provided as a shorthand, but
|
||||
is equivalent to a call to <code>v%set(zero)</code> with the <code>zero</code>
|
||||
constant having the appropriate type and kind.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><STRONG><B>On Return</B></STRONG></DT>
|
||||
<DD>
|
||||
</DD>
|
||||
<DT><STRONG>v</STRONG></DT>
|
||||
<DD>the dense vector, with updated entries
|
||||
<BR>
|
||||
Scope: <B>local</B>
|
||||
<BR></DD>
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR><HR>
|
||||
|
||||
Reference in New Issue
Block a user