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.
262 lines
18 KiB
HTML
262 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
<html >
|
|
<head><title></title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)">
|
|
<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)">
|
|
<!-- html,3 -->
|
|
<meta name="src" content="userhtml.tex">
|
|
<link rel="stylesheet" type="text/css" href="userhtml.css">
|
|
</head><body
|
|
>
|
|
<!--l. 90--><p class="noindent" ><span
|
|
class="cmbx-12x-x-144">PSBLAS</span><br
|
|
class="newline" /> <span
|
|
class="cmbx-12x-x-144">User’s and Reference Guide</span><br
|
|
class="newline" /> <span
|
|
class="cmti-12">A reference guide for the Parallel Sparse BLAS library</span><br
|
|
class="newline" /> <span
|
|
class="cmbx-10">Salvatore Filippone</span><br
|
|
class="newline" /><span
|
|
class="cmbx-10">Alfredo Buttari </span><br
|
|
class="newline" />Software version: 3.7.0.1<br
|
|
class="newline" />May 11th, 2021
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="tableofcontents">
|
|
<span class="likesectionToc" ><a
|
|
href="userhtmlli1.html#x2-1000" id="QQ2-2-1">Contents</a></span>
|
|
<br /> <span class="sectionToc" >1 <a
|
|
href="userhtmlse1.html#x3-20001" id="QQ2-3-2">Introduction</a></span>
|
|
<br /> <span class="sectionToc" >2 <a
|
|
href="userhtmlse2.html#x4-30002" id="QQ2-4-3">General overview</a></span>
|
|
<br />  <span class="subsectionToc" >2.1 <a
|
|
href="userhtmlsu1.html#x6-40002.1" id="QQ2-6-5">Basic Nomenclature</a></span>
|
|
<br />  <span class="subsectionToc" >2.2 <a
|
|
href="userhtmlsu2.html#x8-50002.2" id="QQ2-8-7">Library contents</a></span>
|
|
<br />  <span class="subsectionToc" >2.3 <a
|
|
href="userhtmlsu3.html#x9-60002.3" id="QQ2-9-8">Application structure</a></span>
|
|
<br />  <span class="subsectionToc" >2.4 <a
|
|
href="userhtmlsu4.html#x11-80002.4" id="QQ2-11-10">Programming model</a></span>
|
|
<br /> <span class="sectionToc" >3 <a
|
|
href="userhtmlse3.html#x12-90003" id="QQ2-12-11">Data Structures and Classes</a></span>
|
|
<br />  <span class="subsectionToc" >3.1 <a
|
|
href="userhtmlsu5.html#x13-100003.1" id="QQ2-13-12">Descriptor data structure</a></span>
|
|
<br />  <span class="subsectionToc" >3.2 <a
|
|
href="userhtmlsu6.html#x14-260003.2" id="QQ2-14-29">Sparse Matrix class</a></span>
|
|
<br />  <span class="subsectionToc" >3.3 <a
|
|
href="userhtmlsu7.html#x15-460003.3" id="QQ2-15-50">Dense Vector Data Structure</a></span>
|
|
<br />  <span class="subsectionToc" >3.4 <a
|
|
href="userhtmlsu8.html#x16-530003.4" id="QQ2-16-58">Preconditioner data structure</a></span>
|
|
<br />  <span class="subsectionToc" >3.5 <a
|
|
href="userhtmlsu9.html#x17-540003.5" id="QQ2-17-60">Heap data structure</a></span>
|
|
<br /> <span class="sectionToc" >4 <a
|
|
href="userhtmlse4.html#x18-550004" id="QQ2-18-61">Computational routines</a></span>
|
|
<br />  <span class="subsectionToc" >4.1 <a
|
|
href="userhtmlsu10.html#x19-560004.1" id="QQ2-19-62">psb_geaxpby — General Dense Matrix Sum</a></span>
|
|
<br />  <span class="subsectionToc" >4.2 <a
|
|
href="userhtmlsu11.html#x20-570004.2" id="QQ2-20-64">psb_gedot — Dot Product</a></span>
|
|
<br />  <span class="subsectionToc" >4.3 <a
|
|
href="userhtmlsu12.html#x21-580004.3" id="QQ2-21-66">psb_gedots — Generalized Dot Product</a></span>
|
|
<br />  <span class="subsectionToc" >4.4 <a
|
|
href="userhtmlsu13.html#x22-590004.4" id="QQ2-22-68">psb_normi — Infinity-Norm of Vector</a></span>
|
|
<br />  <span class="subsectionToc" >4.5 <a
|
|
href="userhtmlsu14.html#x23-600004.5" id="QQ2-23-70">psb_geamaxs — Generalized Infinity Norm</a></span>
|
|
<br />  <span class="subsectionToc" >4.6 <a
|
|
href="userhtmlsu15.html#x24-610004.6" id="QQ2-24-72">psb_norm1 — 1-Norm of Vector</a></span>
|
|
<br />  <span class="subsectionToc" >4.7 <a
|
|
href="userhtmlsu16.html#x25-620004.7" id="QQ2-25-74">psb_geasums — Generalized 1-Norm of Vector</a></span>
|
|
<br />  <span class="subsectionToc" >4.8 <a
|
|
href="userhtmlsu17.html#x26-630004.8" id="QQ2-26-76">psb_norm2 — 2-Norm of Vector</a></span>
|
|
<br />  <span class="subsectionToc" >4.9 <a
|
|
href="userhtmlsu18.html#x27-640004.9" id="QQ2-27-78">psb_genrm2s — Generalized 2-Norm of Vector</a></span>
|
|
<br />  <span class="subsectionToc" >4.10 <a
|
|
href="userhtmlsu19.html#x28-650004.10" id="QQ2-28-80">psb_norm1 — 1-Norm of Sparse Matrix</a></span>
|
|
<br />  <span class="subsectionToc" >4.11 <a
|
|
href="userhtmlsu20.html#x29-660004.11" id="QQ2-29-82">psb_normi — Infinity Norm of Sparse Matrix</a></span>
|
|
<br />  <span class="subsectionToc" >4.12 <a
|
|
href="userhtmlsu21.html#x30-670004.12" id="QQ2-30-84">psb_spmm — Sparse Matrix by Dense Matrix Product</a></span>
|
|
<br />  <span class="subsectionToc" >4.13 <a
|
|
href="userhtmlsu22.html#x31-680004.13" id="QQ2-31-86">psb_spsm — Triangular System Solve</a></span>
|
|
<br />  <span class="subsectionToc" >4.14 <a
|
|
href="userhtmlsu23.html#x32-690004.14" id="QQ2-32-88">psb_gemlt — Entrywise Product</a></span>
|
|
<br />  <span class="subsectionToc" >4.15 <a
|
|
href="userhtmlsu24.html#x33-700004.15" id="QQ2-33-90">psb_gediv — Entrywise Division</a></span>
|
|
<br />  <span class="subsectionToc" >4.16 <a
|
|
href="userhtmlsu25.html#x34-710004.16" id="QQ2-34-92">psb_geinv — Entrywise Inversion</a></span>
|
|
<br /> <span class="sectionToc" >5 <a
|
|
href="userhtmlse5.html#x35-720005" id="QQ2-35-94">Communication routines</a></span>
|
|
<br />  <span class="subsectionToc" >5.1 <a
|
|
href="userhtmlsu26.html#x36-730005.1" id="QQ2-36-95">psb_halo — Halo Data Communication</a></span>
|
|
<br />  <span class="subsectionToc" >5.2 <a
|
|
href="userhtmlsu27.html#x37-740005.2" id="QQ2-37-98">psb_ovrl — Overlap Update</a></span>
|
|
<br />  <span class="subsectionToc" >5.3 <a
|
|
href="userhtmlsu28.html#x38-750005.3" id="QQ2-38-101">psb_gather — Gather Global Dense Matrix</a></span>
|
|
<br />  <span class="subsectionToc" >5.4 <a
|
|
href="userhtmlsu29.html#x39-760005.4" id="QQ2-39-103">psb_scatter — Scatter Global Dense Matrix</a></span>
|
|
<br /> <span class="sectionToc" >6 <a
|
|
href="userhtmlse6.html#x40-770006" id="QQ2-40-105">Data management routines</a></span>
|
|
<br />  <span class="subsectionToc" >6.1 <a
|
|
href="userhtmlsu30.html#x41-780006.1" id="QQ2-41-106">psb_cdall — Allocates a communication descriptor</a></span>
|
|
<br />  <span class="subsectionToc" >6.2 <a
|
|
href="userhtmlsu31.html#x42-790006.2" id="QQ2-42-107">psb_cdins — Communication descriptor insert routine</a></span>
|
|
<br />  <span class="subsectionToc" >6.3 <a
|
|
href="userhtmlsu32.html#x43-800006.3" id="QQ2-43-108">psb_cdasb — Communication descriptor assembly routine</a></span>
|
|
<br />  <span class="subsectionToc" >6.4 <a
|
|
href="userhtmlsu33.html#x44-810006.4" id="QQ2-44-109">psb_cdcpy — Copies a communication descriptor</a></span>
|
|
<br />  <span class="subsectionToc" >6.5 <a
|
|
href="userhtmlsu34.html#x45-820006.5" id="QQ2-45-110">psb_cdfree — Frees a communication descriptor</a></span>
|
|
<br />  <span class="subsectionToc" >6.6 <a
|
|
href="userhtmlsu35.html#x46-830006.6" id="QQ2-46-111">psb_cdbldext — Build an extended communication descriptor</a></span>
|
|
<br />  <span class="subsectionToc" >6.7 <a
|
|
href="userhtmlsu36.html#x47-840006.7" id="QQ2-47-112">psb_spall — Allocates a sparse matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.8 <a
|
|
href="userhtmlsu37.html#x48-850006.8" id="QQ2-48-113">psb_spins — Insert a set of coefficients into a sparse matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.9 <a
|
|
href="userhtmlsu38.html#x49-860006.9" id="QQ2-49-114">psb_spasb — Sparse matrix assembly routine</a></span>
|
|
<br />  <span class="subsectionToc" >6.10 <a
|
|
href="userhtmlsu39.html#x50-870006.10" id="QQ2-50-115">psb_spfree — Frees a sparse matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.11 <a
|
|
href="userhtmlsu40.html#x51-880006.11" id="QQ2-51-116">psb_sprn — Reinit sparse matrix structure for psblas routines.</a></span>
|
|
<br />  <span class="subsectionToc" >6.12 <a
|
|
href="userhtmlsu41.html#x52-890006.12" id="QQ2-52-117">psb_geall — Allocates a dense matrix</a></span>
|
|
|
|
|
|
|
|
<br />  <span class="subsectionToc" >6.13 <a
|
|
href="userhtmlsu42.html#x53-900006.13" id="QQ2-53-118">psb_geins — Dense matrix insertion routine</a></span>
|
|
<br />  <span class="subsectionToc" >6.14 <a
|
|
href="userhtmlsu43.html#x54-910006.14" id="QQ2-54-119">psb_geasb — Assembly a dense matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.15 <a
|
|
href="userhtmlsu44.html#x55-920006.15" id="QQ2-55-120">psb_gefree — Frees a dense matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.16 <a
|
|
href="userhtmlsu45.html#x56-930006.16" id="QQ2-56-121">psb_gelp — Applies a left permutation to a dense matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.17 <a
|
|
href="userhtmlsu46.html#x57-940006.17" id="QQ2-57-122">psb_glob_to_loc — Global to local indices convertion</a></span>
|
|
<br />  <span class="subsectionToc" >6.18 <a
|
|
href="userhtmlsu47.html#x58-950006.18" id="QQ2-58-123">psb_loc_to_glob — Local to global indices conversion</a></span>
|
|
<br />  <span class="subsectionToc" >6.19 <a
|
|
href="userhtmlsu48.html#x59-960006.19" id="QQ2-59-124">psb_is_owned — </a></span>
|
|
<br />  <span class="subsectionToc" >6.20 <a
|
|
href="userhtmlsu49.html#x60-970006.20" id="QQ2-60-125">psb_owned_index — </a></span>
|
|
<br />  <span class="subsectionToc" >6.21 <a
|
|
href="userhtmlsu50.html#x61-980006.21" id="QQ2-61-126">psb_is_local — </a></span>
|
|
<br />  <span class="subsectionToc" >6.22 <a
|
|
href="userhtmlsu51.html#x62-990006.22" id="QQ2-62-127">psb_local_index — </a></span>
|
|
<br />  <span class="subsectionToc" >6.23 <a
|
|
href="userhtmlsu52.html#x63-1000006.23" id="QQ2-63-128">psb_get_boundary — Extract list of boundary elements</a></span>
|
|
<br />  <span class="subsectionToc" >6.24 <a
|
|
href="userhtmlsu53.html#x64-1010006.24" id="QQ2-64-129">psb_get_overlap — Extract list of overlap elements</a></span>
|
|
<br />  <span class="subsectionToc" >6.25 <a
|
|
href="userhtmlsu54.html#x65-1020006.25" id="QQ2-65-130">psb_sp_getrow — Extract row(s) from a sparse matrix</a></span>
|
|
<br />  <span class="subsectionToc" >6.26 <a
|
|
href="userhtmlsu55.html#x66-1030006.26" id="QQ2-66-131">psb_sizeof — Memory occupation</a></span>
|
|
<br />  <span class="subsectionToc" >6.27 <a
|
|
href="userhtmlsu56.html#x67-1040006.27" id="QQ2-67-132">Sorting utilities — </a></span>
|
|
<br /> <span class="sectionToc" >7 <a
|
|
href="userhtmlse7.html#x68-1050007" id="QQ2-68-133">Parallel environment routines</a></span>
|
|
<br />  <span class="subsectionToc" >7.1 <a
|
|
href="userhtmlsu57.html#x69-1060007.1" id="QQ2-69-134">psb_init — Initializes PSBLAS parallel environment</a></span>
|
|
<br />  <span class="subsectionToc" >7.2 <a
|
|
href="userhtmlsu58.html#x70-1070007.2" id="QQ2-70-135">psb_info — Return information about PSBLAS parallel environment</a></span>
|
|
<br />  <span class="subsectionToc" >7.3 <a
|
|
href="userhtmlsu59.html#x71-1080007.3" id="QQ2-71-136">psb_exit — Exit from PSBLAS parallel environment</a></span>
|
|
<br />  <span class="subsectionToc" >7.4 <a
|
|
href="userhtmlsu60.html#x72-1090007.4" id="QQ2-72-137">psb_get_mpi_comm — Get the MPI communicator</a></span>
|
|
<br />  <span class="subsectionToc" >7.5 <a
|
|
href="userhtmlsu61.html#x73-1100007.5" id="QQ2-73-138">psb_get_mpi_rank — Get the MPI rank</a></span>
|
|
<br />  <span class="subsectionToc" >7.6 <a
|
|
href="userhtmlsu62.html#x74-1110007.6" id="QQ2-74-139">psb_wtime — Wall clock timing</a></span>
|
|
<br />  <span class="subsectionToc" >7.7 <a
|
|
href="userhtmlsu63.html#x75-1120007.7" id="QQ2-75-140">psb_barrier — Sinchronization point parallel environment</a></span>
|
|
<br />  <span class="subsectionToc" >7.8 <a
|
|
href="userhtmlsu64.html#x76-1130007.8" id="QQ2-76-141">psb_abort — Abort a computation</a></span>
|
|
<br />  <span class="subsectionToc" >7.9 <a
|
|
href="userhtmlsu65.html#x77-1140007.9" id="QQ2-77-142">psb_bcast — Broadcast data</a></span>
|
|
<br />  <span class="subsectionToc" >7.10 <a
|
|
href="userhtmlsu66.html#x78-1150007.10" id="QQ2-78-143">psb_sum — Global sum</a></span>
|
|
<br />  <span class="subsectionToc" >7.11 <a
|
|
href="userhtmlsu67.html#x79-1160007.11" id="QQ2-79-144">psb_max — Global maximum</a></span>
|
|
<br />  <span class="subsectionToc" >7.12 <a
|
|
href="userhtmlsu68.html#x80-1170007.12" id="QQ2-80-145">psb_min — Global minimum</a></span>
|
|
<br />  <span class="subsectionToc" >7.13 <a
|
|
href="userhtmlsu69.html#x81-1180007.13" id="QQ2-81-146">psb_amx — Global maximum absolute value</a></span>
|
|
<br />  <span class="subsectionToc" >7.14 <a
|
|
href="userhtmlsu70.html#x82-1190007.14" id="QQ2-82-147">psb_amn — Global minimum absolute value</a></span>
|
|
<br />  <span class="subsectionToc" >7.15 <a
|
|
href="userhtmlsu71.html#x83-1200007.15" id="QQ2-83-148">psb_nrm2 — Global 2-norm reduction</a></span>
|
|
<br />  <span class="subsectionToc" >7.16 <a
|
|
href="userhtmlsu72.html#x84-1210007.16" id="QQ2-84-149">psb_snd — Send data</a></span>
|
|
<br />  <span class="subsectionToc" >7.17 <a
|
|
href="userhtmlsu73.html#x85-1220007.17" id="QQ2-85-150">psb_rcv — Receive data</a></span>
|
|
<br /> <span class="sectionToc" >8 <a
|
|
href="userhtmlse8.html#x86-1230008" id="QQ2-86-151">Error handling</a></span>
|
|
<br />  <span class="subsectionToc" >8.1 <a
|
|
href="userhtmlsu74.html#x87-1240008.1" id="QQ2-87-154">psb_errpush — Pushes an error code onto the error stack</a></span>
|
|
<br />  <span class="subsectionToc" >8.2 <a
|
|
href="userhtmlsu75.html#x88-1250008.2" id="QQ2-88-155">psb_error — Prints the error stack content and aborts execution</a></span>
|
|
<br />  <span class="subsectionToc" >8.3 <a
|
|
href="userhtmlsu76.html#x89-1260008.3" id="QQ2-89-156">psb_set_errverbosity — Sets the verbosity of error messages</a></span>
|
|
<br />  <span class="subsectionToc" >8.4 <a
|
|
href="userhtmlsu77.html#x90-1270008.4" id="QQ2-90-157">psb_set_erraction — Set the type of action to be taken upon error condition</a></span>
|
|
<br /> <span class="sectionToc" >9 <a
|
|
href="userhtmlse9.html#x91-1280009" id="QQ2-91-158">Utilities</a></span>
|
|
<br />  <span class="subsectionToc" >9.1 <a
|
|
href="userhtmlsu78.html#x92-1290009.1" id="QQ2-92-159"> hb_read — Read a sparse matrix from a file in the Harwell–Boeing format</a></span>
|
|
<br />  <span class="subsectionToc" >9.2 <a
|
|
href="userhtmlsu79.html#x93-1300009.2" id="QQ2-93-160">hb_write — Write a sparse matrix to a file in the Harwell–Boeing format</a></span>
|
|
<br />  <span class="subsectionToc" >9.3 <a
|
|
href="userhtmlsu80.html#x94-1310009.3" id="QQ2-94-161">mm_mat_read — Read a sparse matrix from a file in the MatrixMarket format</a></span>
|
|
<br />  <span class="subsectionToc" >9.4 <a
|
|
href="userhtmlsu81.html#x95-1320009.4" id="QQ2-95-162">mm_array_read — Read a dense array from a file in the MatrixMarket format</a></span>
|
|
<br />  <span class="subsectionToc" >9.5 <a
|
|
href="userhtmlsu82.html#x96-1330009.5" id="QQ2-96-163">mm_mat_write — Write a sparse matrix to a file in the MatrixMarket format</a></span>
|
|
<br />  <span class="subsectionToc" >9.6 <a
|
|
href="userhtmlsu83.html#x97-1340009.6" id="QQ2-97-164">mm_array_write — Write a dense array from a file in the MatrixMarket format</a></span>
|
|
<br /> <span class="sectionToc" >10 <a
|
|
href="userhtmlse10.html#x98-13500010" id="QQ2-98-165">Preconditioner routines</a></span>
|
|
<br />  <span class="subsectionToc" >10.1 <a
|
|
href="userhtmlsu84.html#x99-13600010.1" id="QQ2-99-166">init — Initialize a preconditioner</a></span>
|
|
<br />  <span class="subsectionToc" >10.2 <a
|
|
href="userhtmlsu85.html#x101-13700010.2" id="QQ2-101-167">build — Builds a preconditioner</a></span>
|
|
<br />  <span class="subsectionToc" >10.3 <a
|
|
href="userhtmlsu86.html#x102-13800010.3" id="QQ2-102-168">apply — Preconditioner application routine</a></span>
|
|
<br />  <span class="subsectionToc" >10.4 <a
|
|
href="userhtmlsu87.html#x103-13900010.4" id="QQ2-103-169">descr — Prints a description of current preconditioner</a></span>
|
|
|
|
|
|
|
|
<br />  <span class="subsectionToc" >10.5 <a
|
|
href="userhtmlsu88.html#x104-14000010.5" id="QQ2-104-170">clone — clone current preconditioner</a></span>
|
|
<br />  <span class="subsectionToc" >10.6 <a
|
|
href="userhtmlsu89.html#x105-14100010.6" id="QQ2-105-171">free — Free a preconditioner</a></span>
|
|
<br /> <span class="sectionToc" >11 <a
|
|
href="userhtmlse11.html#x106-14200011" id="QQ2-106-172">Iterative Methods</a></span>
|
|
<br />  <span class="subsectionToc" >11.1 <a
|
|
href="userhtmlsu90.html#x107-14300011.1" id="QQ2-107-173">psb_krylov — Krylov Methods Driver Routine</a></span>
|
|
<br /> <span class="likesectionToc" ><a
|
|
href="userhtmlli2.html#x109-14400011.1" id="QQ2-109-174">References</a></span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|
|
|
|
|
|
|