mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-20 21:02:26 +00:00
psblas3:
Updated docs with CLONE method.
This commit is contained in:
+66
-4
@@ -297,6 +297,27 @@ Scope: {\bf local}.\\
|
||||
\item[Function value] The communication context.
|
||||
\end{description}
|
||||
|
||||
\subsubroutine{clone}{Clone current object}
|
||||
\begin{verbatim}
|
||||
call desc%clone(descout,info)
|
||||
\end{verbatim}
|
||||
|
||||
\begin{description}
|
||||
\item[Type:] Asynchronous.
|
||||
\item[\bf On Entry]
|
||||
\item[desc] the communication descriptor.\\
|
||||
Scope: {\bf local}.\\
|
||||
% Type: {\bf required}.\\
|
||||
% Intent: {\bf in}.\\
|
||||
% Specified as: a object of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[descout] A copy of the input object.
|
||||
\item[info] Return code.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsubsection*{psb\_cd\_get\_large\_threshold --- Get threshold for
|
||||
index mapping switch}
|
||||
@@ -612,6 +633,28 @@ Scope: {\bf local}\\
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsubroutine{clone}{Clone current object}
|
||||
\begin{verbatim}
|
||||
call a%clone(b,info)
|
||||
\end{verbatim}
|
||||
|
||||
\begin{description}
|
||||
\item[Type:] Asynchronous.
|
||||
\item[\bf On Entry]
|
||||
\item[a] the sparse matrix.\\
|
||||
Scope: {\bf local}.\\
|
||||
% Type: {\bf required}.\\
|
||||
% Intent: {\bf in}.\\
|
||||
% Specified as: a object of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[b] A copy of the input object.
|
||||
\item[info] Return code.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsubsection{Named Constants}
|
||||
\label{sec:sp_constants}
|
||||
\begin{description}
|
||||
@@ -704,14 +747,12 @@ Scope: {\bf local}\\
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of rows of sparse matrix \verb|a|.
|
||||
\item[Function value] The number of rows of dense vector \verb|v|.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsubsection*{get\_ncols --- Get number of columns in a sparse matrix}
|
||||
|
||||
\subsubsection*{sizeof --- Get memory occupation in bytes
|
||||
of a dense vector matrix}
|
||||
of a dense vector}
|
||||
\addcontentsline{toc}{subsubsection}{v\_sizeof}
|
||||
|
||||
\begin{verbatim}
|
||||
@@ -757,6 +798,27 @@ Scope: {\bf local}\\
|
||||
vector contents.
|
||||
\end{description}
|
||||
|
||||
\subsubroutine{clone}{Clone current object}
|
||||
\begin{verbatim}
|
||||
call x%clone(y,info)
|
||||
\end{verbatim}
|
||||
|
||||
\begin{description}
|
||||
\item[Type:] Asynchronous.
|
||||
\item[\bf On Entry]
|
||||
\item[x] the dense vector.\\
|
||||
Scope: {\bf local}.\\
|
||||
% Type: {\bf required}.\\
|
||||
% Intent: {\bf in}.\\
|
||||
% Specified as: a object of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[y] A copy of the input object.
|
||||
\item[info] Return code.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsection{Preconditioner data structure}
|
||||
\label{sec:prec}
|
||||
|
||||
+24
-1
@@ -23,7 +23,6 @@ module \verb|psb_prec_mod|.
|
||||
|
||||
|
||||
|
||||
|
||||
\clearpage\subsection*{psb\_precinit --- Initialize a preconditioner}
|
||||
\addcontentsline{toc}{subsection}{psb\_precinit}
|
||||
|
||||
@@ -220,6 +219,30 @@ Specified as: an integer number.
|
||||
|
||||
|
||||
|
||||
\clearpage\subsection*{clone --- clone current
|
||||
preconditioner}
|
||||
\addcontentsline{toc}{subsection}{clone}
|
||||
\begin{verbatim}
|
||||
call prec%clone(precout,info)
|
||||
\end{verbatim}
|
||||
|
||||
\begin{description}
|
||||
\item[Type:] Asynchronous.
|
||||
\item[\bf On Entry]
|
||||
\item[prec] the preconditioner.\\
|
||||
Scope: {\bf local}.\\
|
||||
% Type: {\bf required}.\\
|
||||
% Intent: {\bf in}.\\
|
||||
% Specified as: a object of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[precout] A copy of the input object.
|
||||
\item[info] Return code.
|
||||
\end{description}
|
||||
|
||||
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: "userguide"
|
||||
|
||||
Reference in New Issue
Block a user