mirror of
https://github.com/sfilippone/psblas3.git
synced 2026-10-19 20:32:12 +00:00
Added new getter routines.
This commit is contained in:
@@ -26,7 +26,9 @@ exchanged among processes.
|
||||
It is not necessary for the user to know the internal structure of
|
||||
\verb|psb_desc_type|, it is set in a transparent mode by the tools
|
||||
routines of Sec.~\ref{sec:toolsrout} while creating a new sparse
|
||||
matrix; nevertheless we include its description for the curious reader:
|
||||
matrix, and its fields may be accessed if necessary via appropriate
|
||||
routines; nevertheless we include its description for the curious
|
||||
reader:
|
||||
\begin{description}
|
||||
\item[{\bf matrix\_data}] includes general information about matrix and
|
||||
process grid. More precisely:
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
\section{Introduction}
|
||||
\section{Introduction}\label{sec:intro}
|
||||
|
||||
The PSBLAS library, developed with the aim to facilitate the
|
||||
parallelization of computationally intensive scientific applications,
|
||||
|
||||
@@ -965,6 +965,146 @@ Specified as: an integer variable.
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
\subroutine{psb\_cd\_get\_local\_rows}{Get number of local rows}
|
||||
|
||||
\syntax{nr = psb\_cd\_get\_local\_rows}{desc}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[desc] the communication descriptor.\\
|
||||
Scope:{\bf local}.\\
|
||||
Type:{\bf required}.\\
|
||||
Specified as: a structured data of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of local rows, i.e. the number of
|
||||
rows owned by the current process; as explained in~\ref{sec:intro},
|
||||
it is equal to $|{\cal I}_i| + |{\cal B}_i|$. The returned value is
|
||||
specific to the calling process.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subroutine{psb\_cd\_get\_local\_cols}{Get number of local cols}
|
||||
|
||||
\syntax{nc = psb\_cd\_get\_local\_cols}{desc}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[desc] the communication descriptor.\\
|
||||
Scope:{\bf local}.\\
|
||||
Type:{\bf required}.\\
|
||||
Specified as: a structured data of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of local cols, i.e. the number of
|
||||
indices used by the current process, including both local and halo
|
||||
indices; as explained in~\ref{sec:intro},
|
||||
it is equal to $|{\cal I}_i| + |{\cal B}_i| +|{\cal H}_i|$. The
|
||||
returned value is specific to the calling process.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subroutine{psb\_cd\_get\_global\_rows}{Get number of global rows}
|
||||
|
||||
\syntax{nr = psb\_cd\_get\_global\_rows}{desc}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[desc] the communication descriptor.\\
|
||||
Scope:{\bf local}.\\
|
||||
Type:{\bf required}.\\
|
||||
Specified as: a structured data of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of global rows in the mesh
|
||||
\end{description}
|
||||
|
||||
|
||||
\subroutine{psb\_cd\_get\_contex}{Get communication context}
|
||||
|
||||
\syntax{ictxt = psb\_cd\_get\_context}{desc}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[desc] the communication descriptor.\\
|
||||
Scope:{\bf local}.\\
|
||||
Type:{\bf required}.\\
|
||||
Specified as: a structured data of type \descdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The communication context.
|
||||
\end{description}
|
||||
|
||||
|
||||
|
||||
\subroutine{psb\_sp\_get\_nrows}{Get number of rows in a sparse matrix}
|
||||
|
||||
\syntax{nr = psb\_sp\_get\_nrows}{a}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[a] the sparse matrix\\
|
||||
Scope:{\bf local}\\
|
||||
Type:{\bf required}\\
|
||||
Specified as: a structured data of type \spdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of rows of sparse matrix \verb|a|.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subroutine{psb\_sp\_get\_ncols}{Get number of columns in a sparse matrix}
|
||||
|
||||
\syntax{nr = psb\_sp\_get\_ncols}{a}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[a] the sparse matrix\\
|
||||
Scope:{\bf local}\\
|
||||
Type:{\bf required}\\
|
||||
Specified as: a structured data of type \spdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of columns of sparse matrix \verb|a|.
|
||||
\end{description}
|
||||
|
||||
|
||||
\subroutine{psb\_sp\_get\_nnzeros}{Get number of nonzero elements in a sparse matrix}
|
||||
|
||||
\syntax{nr = psb\_sp\_get\_nnzeros}{a}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Entry]
|
||||
\item[a] the sparse matrix\\
|
||||
Scope:{\bf local}\\
|
||||
Type:{\bf required}\\
|
||||
Specified as: a structured data of type \spdata.
|
||||
\end{description}
|
||||
|
||||
\begin{description}
|
||||
\item[\bf On Return]
|
||||
\item[Function value] The number of nonzero elements stored in sparse matrix \verb|a|.
|
||||
\end{description}
|
||||
|
||||
\section*{Notes}
|
||||
\begin{enumerate}
|
||||
\item The function value is specific to the storage format of matrix
|
||||
\verb|a|; some storage formats employ padding, thus the returned
|
||||
value for the same matrix may be different for different storage choices.
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
|
||||
%%% Local Variables:
|
||||
|
||||
+12008
-9694
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user