File: drivers.tex

package info (click to toggle)
spooles 2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 19,012 kB
  • sloc: ansic: 146,834; csh: 3,615; makefile: 2,040; perl: 74
file content (777 lines) | stat: -rw-r--r-- 28,911 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
\par
\section{Driver programs}
\label{section:MPI:drivers}
\par
%=======================================================================
\begin{enumerate}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
allInOne msglvl msgFile type symmetryflag pivotingflag seed
\end{verbatim}
This driver program is an example program for reading in a linear
system and right hand side, ordering the matrix, 
factoring the matrix, and solving the system.
Use the script file {\tt do\_AllInOne} for testing.
\par
The files names for the matrix and right hand side entries are
hardcoded.
Processor $q$ reads in matrix entries from file 
$\mbox{\tt matrix.}q\mbox{\tt .input}$
and right hand side entries from file
$\mbox{\tt rhs.}q\mbox{\tt .input}$.
The format for the matrix files is as follows:
\begin{verbatim}
neqns neqns nent
irow jcol entry
...  ...  ...
\end{verbatim}
where {\tt neqns} is the global number of equations and {\tt nent}
is the number of entries in this file.
There follows {\tt nent} lines, each containing a row index, a
column index and one or two floating point numbers, one if real,
two if complex.
The format for the right hand side file is similar:
\begin{verbatim}
nrow nrhs
irow entry ... entry
...  ...   ... ...
\end{verbatim}
where {\tt nrow} is the number of rows in this file
and {\tt nrhs} is the number of rigght and sides.
There follows {\tt nrow} lines, each containing a row index
and either {\tt nrhs} or {\tt 2*nrhs} floating point numbers, 
the first if real, the second if complex.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt type} parameter specifies whether the linear system is
real ({\tt type} = 1) or complex ({\tt type} = 2).
\item
The {\tt symmetryflag} parameter specifies whether the matrix is
symmetric ({\tt symmetryflag} = 0),
Hermitian ({\tt symmetryflag} = 1) or
nonsymmetric ({\tt symmetryflag} = 2)
\item
The {\tt pivotingflag} parameter specifies whether pivoting will be
performed during the factorization,
yes ({\tt symmetryflag} = 0) or
no ({\tt symmetryflag} = 2).
The pivot tolerance is hardcoded as {\tt tau = 100.0}.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
patchAndGoMPI msglvl msgFile type symmetryflag patchAndGoFlag 
              fudge toosmall storeids storevalues seed 
\end{verbatim}
This driver program is used to test the ``patch-and-go''
functionality for a factorization without pivoting.
When small diagonal pivot elements are found, 
one of three actions are taken.
See the {\tt PatchAndGoInfo} object for more information.
\par
The program reads in a matrix $A$ and right hand side $B$,
generates the graph for $A$ and orders the matrix,
factors $A$ and solves the linear system $AX = B$ for $X$.
\par
The files names for the matrix and right hand side entries are
hardcoded.
Processor $q$ reads in matrix entries from file 
$\mbox{\tt patchMatrix.}q\mbox{\tt .input}$
and right hand side entries from file
$\mbox{\tt patchRhs.}q\mbox{\tt .input}$.
The format for the matrix files is as follows:
\begin{verbatim}
neqns neqns nent
irow jcol entry
...  ...  ...
\end{verbatim}
where {\tt neqns} is the global number of equations and {\tt nent}
is the number of entries in this file.
There follows {\tt nent} lines, each containing a row index, a
column index and one or two floating point numbers, one if real,
two if complex.
The format for the right hand side file is similar:
\begin{verbatim}
nrow nrhs
irow entry ... entry
...  ...   ... ...
\end{verbatim}
where {\tt nrow} is the number of rows in this file
and {\tt nrhs} is the number of rigght and sides.
There follows {\tt nrow} lines, each containing a row index
and either {\tt nrhs} or {\tt 2*nrhs} floating point numbers, 
the first if real, the second if complex.
Use the script file {\tt do\_patchAndGo} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt type} parameter specifies a real or complex linear system.
\begin{itemize}
\item
{\tt type = 1 (SPOOLES\_REAL)} for real,
\item
{\tt type = 2 (SPOOLES\_COMPLEX)} for complex.
\end{itemize}
\item
The {\tt symmetryflag} parameter specifies the symmetry of the matrix.
\begin{itemize}
\item
{\tt type = 0 (SPOOLES\_SYMMETRIC)} for $A$ real or complex symmetric,
\item
{\tt type = 1 (SPOOLES\_HERMITIAN)} for $A$ complex Hermitian,
\item
{\tt type = 2 (SPOOLES\_NONSYMMETRIC)}
\end{itemize}
for $A$ real or complex nonsymmetric.
\item
The {\tt patchAndGoFlag} specifies the ``patch-and-go'' strategy.
\begin{itemize}
\item
{\tt patchAndGoFlag = 0} --- if a zero pivot is detected, stop
computing the factorization, set the error flag and return.
\item
{\tt patchAndGoFlag = 1} --- if a small or zero pivot is detected,
set the diagonal entry to 1 and the offdiagonal entries to zero.
\item
{\tt patchAndGoFlag = 2} --- if a small or zero pivot is detected,
perturb the diagonal entry.
\end{itemize}
\item
The {\tt fudge} parameter is used to perturb a diagonal entry.
\item
The {\tt toosmall} parameter is judge when a diagonal entry is small.
\item
If {\tt storeids = 1}, then the locations where action was taken is
stored in an {\tt IV} object.
\item
If {\tt storevalues = 1}, then the perturbations are
stored in an {\tt DV} object.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testGather msglvl msgFile type nrow ncol inc1 inc2 seed
\end{verbatim}
This driver program test the {\tt DenseMtx\_MPI\_gatherRows()} method.
Each processor creates part of a distributed matrix $X$ and fills
its entries with entries known to all processors.
($X_{j,k} = j + k*\mbox{nproc}$ if real and
$X_{j,k} = j + k*\mbox{nproc} +
i*2*(j + k*\mbox{nproc})$) if complex.
The mapping from rows of $X$ to processors is random.
Each processor then generates a random vector that contains its rows
in a local $Y$, which will be filled with the corresponding rows of
$X$.
The rows of $X$ are then gathered into $Y$, and the local errors
are computed.
The global error is written to the results file by processor zero.
\par
Use the script file {\tt do\_gather} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt type} parameter specifies whether the linear system is
real ({\tt type} = 1) or complex ({\tt type} = 2).
\item
{\tt nrow} is the number of rows in {\tt X}.
\item
{\tt ncol} is the number of columns in {\tt X}.
\item
{\tt inc1} is the row increment for {\tt X}.
\item
{\tt inc2} is the column increment for {\tt X}.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testGraph_Bcast msglvl msgFile type nvtx nitem root seed 
\end{verbatim}
This driver program tests the distributed 
{\tt Graph\_MPI\_Bcast()} method.
Processor {\tt root} generates a random graph of type {\tt type}
(see the documentation for the {\tt Graph} object in
chapter~\ref{chapter:Graph}) with {\tt nvtx} vertices.
The random graph is constructed via an {\tt InpMtx} object
using {\tt nitem} edges.
Processor {\tt root} then sends its {\tt Graph} object to the other
processors.
Each processor computes a checksum for its object, and the error
are collected on processor 0.
Use the script file {\tt do\_Graph\_Bcast} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt type} parameter specifies the type of the graph,
unweighted, weighted vertices, weighted edges, and combinations.
\item
The {\tt nvtx} parameter specifies the number of vertices in the
graph.
\item
The {\tt nitem} parameter is used to specify the number of edges
that form the graph. An upper bound on the number of edges is
{\tt nvtx + 2*nitem}.
\item
{\tt root} is the root processor for the broadcast.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testGridMPI msglvl msgFile n1 n2 n3 maxzeros maxsize seed type
   symmetryflag sparsityflag pivotingflag tau droptol lookahead 
   nrhs maptype cutoff
\end{verbatim}
This driver program creates and solves the linear system $AX = Y$
where the structure of $A$ is from a 
${\tt n1} \times {\tt n2} \times {\tt n3}$ 
regular grid operator and is
ordered using nested dissection.
The front tree is formed allowing {\tt maxzeros} in a front with a
maximum of {\tt maxsize} vertices in a non-leaf front.
Process {\tt 0} generates the linear system and broadcasts the front
tree to the other processes.
Using {\tt maptype}, the processes generate the owners map 
for the factorization in parallel.
The $A$, $X$ and $Y$ matrices are then distributed among the
processes.
The symbolic factorization is then computed in parallel,
the front matrix is initialized, and the factorization is computed
in parallel.
If pivoting has taken place, the solution and right hand side
matrices are redistributed as necessary.
The matrix is post-processed where it is converted 
to a submatrix storage format.
Each processor computes the identical solve map, and the front
matrix is split among the processes.
The linear system is then solved in parallel and the error is
computed.
Use the script file {\tt do\_gridMPI} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt n1} parameter is the number of grid points in the first
direction.
\item
The {\tt n2} parameter is the number of grid points in the second
direction.
\item
The {\tt n3} parameter is the number of grid points in the third
direction.
\item
The {\tt maxzeros} parameter is the maximum number of zero entries
allowed in a front.
\item
The {\tt maxsize} parameter is the maximum number of internal rows 
and columns allowed in a front.
\item
The {\tt seed} parameter is a random number seed.
\item
The {\tt type} parameter specifies whether the linear system is
real or complex.
Use {\tt 1} for real and {\tt 2} for complex.
\item
The {\tt symmetryflag} parameter denotes the presence or absence of
symmetry.
\begin{itemize}
\item
Use {\tt 0} for a real or complex symmetric matrix $A$.
A $(U^T + I)D(I + U)$ factorization is computed.
\item
Use {\tt 1} for a complex Hermitian matrix $A$.
A $(U^H + I)D(I + U)$ factorization is computed.
\item
Use {\tt 2} for a real or complex nonsymmetric matrix $A$.
A $(L + I)D(I + U)$ factorization is computed.
\end{itemize}
\item
The {\tt sparsityflag} parameter denotes a direct or approximate
factorization.
Valid values are {\tt 0} for a direct factorization
and {\tt 1} is for an approximate factorization.
\item
The {\tt pivotingflag} parameter denotes whether pivoting is to be
used in the factorization.
Valid values are {\tt 0} for no pivoting
and {\tt 1} to enable pivoting.
\item
The {\tt tau} parameter is used when pivoting is enabled,
in which case it is an upper bound on the magnitude of an entry in
the triangular factors $L$ and $U$.
\item
The {\tt droptol} parameter is used when an approximate
factorization is requested, in which it is a lower bound on the
magnitude of an entry in $L$ and $U$.
\item
The {\tt lookahead} parameter governs the
``upward--looking'' nature of the factorization.
Choosing {\tt lookahead = 0} is usually the most conservative with
respect to working storage, while positive values increase the
working storage and sometimes decrease the factorization time.
\item
The {\tt nrhs} parameter is the number of right hand sides.
\item
The {\tt maptype} parameter is the type of factorization map.
\begin{itemize}
\item {\tt 1} --- a wrap map via a post-order traversal
\item {\tt 2} --- a balanced map via a post-order traversal
\item {\tt 3} --- a subtree--subset map
\item {\tt 4} --- a domain decomposition map
\end{itemize}
\item
The {\tt cutoff} parameter is used with the domain decomposition
map, and specifies the maximum fraction of the vertices to be
included into a domain. Try {\tt cutoff} = {\tt 1/nproc}
or {\tt 1/(2*nproc)}.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIV_allgather msglvl msgFile n seed 
\end{verbatim}
This driver program tests the distributed 
{\tt IV\_MPI\_allgather()} method.
Each processor generates the same {\tt owners[]} map
and fills an {\tt IV} object with random entries for the entries
which it owns.
The processors all-gather the entries of the vector so each
processor has a copy of the global vector.
Each processor computes a checksum of the vector to detect errors.
Use the script file {\tt do\_IVallgather} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt n} parameter is the length of the vector.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIVL_alltoall msglvl msgFile n seed
\end{verbatim}
This driver program tests the distributed {\tt IVL\_MPI\_alltoall()}
method.
This is used by the {\tt makeSendRecvIVLs} method when setting up
the distributed matrix-matrix multiply.
Each processor constructs a ``receive'' {\tt IVL} object with 
{\tt nproc} lists.
List {\tt iproc} contains a set of ids of items that this processor
will receive from processor {\tt iproc}.
The processors then call {\tt IVL\_MPI\_allgather} to create their
``send'' {\tt IVL} object,
where list {\tt iproc} contains a set of ids of items that 
this processor will send to processor {\tt iproc}.
The set of lists in all the ``receive'' {\tt IVL} objects is
exactly the same as the set of lists in all the ``send'' objects.
This is an ``all-to-all'' scatter/gather operation.
Had the lists be stored contiguously or at least in one block of
storage, we could have used the {\tt MPI\_Alltoallv()} method.
\par
Use the script file {\tt do\_IVL\_alltoall} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt n} parameter is an upper bound on list size and element value.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIVL_allgather msglvl msgFile nlist seed 
\end{verbatim}
This driver program tests the distributed 
{\tt IVL\_MPI\_allgather()} method.
Each processor generates the same {\tt owners[]} map
and fills an {\tt IVL} object with random entries for the lists
which it owns.
The processors all-gather the entries of the {\tt IVL} object so each
processor has a copy of the global object.
Each processor computes a checksum of the lists to detect errors.
Use the script file {\tt do\_IVLallgather} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt nlist} parameter is the number of lists.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIVL_Bcast msglvl msgFile nlist maxlistsize root seed 
\end{verbatim}
This driver program tests the distributed 
{\tt IVL\_MPI\_Bcast()} method.
Processor {\tt root} generates a random {\tt IVL} object
with {\tt nlist} lists.
The size of each list is bounded above by {\tt maxlistsize}.
Processor {\tt root} then sends its {\tt IVL} object to the other
processors.
Each processor computes a checksum for its object, and the error
are collected on processor 0.
Use the script file {\tt do\_IVL\_Bcast} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt nlist} parameter specifies the number of lists.
\item
The {\tt maxlist} parameter is an upper bound on the size of each list.
\item
{\tt root} is the root processor for the broadcast.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testMMM msglvl msgFile nrowA ncolA nentA ncolX coordType
        inputMode symflag opflag seed real imag
\end{verbatim}
This driver program tests the distributed matrix-matrix multiply
$Y := Y + \alpha A X$,
$Y := Y + \alpha A^T X$ or
$Y := Y + \alpha A^H X$.
Process zero creates $Y$, $A$ and $X$ and computes
$Z = Y + \alpha A X$,
$Z = Y + \alpha A^T X$ or
$Z = Y + \alpha A^H X$.
Using random maps, it distributes $A$, $X$ and $Y$ among the other
processors.
The information structure is created using
{\tt MatMul\_MPI\_setup()}.
The local matrix $A^q$ is mapped to local coordinates.
The matrix-matrix multiply is computed,
and then all the $Y^q$ local matrices are gathered onto processor
zero into $Y$, which is then compared with $Z$ that was computed
using a serial matrix-matrix multiply.
The error is written to the message file by processor zero.
Use the script file {\tt do\_MMM} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt nrowA} parameter is the number of rows in $A$.
\item
The {\tt ncolA} parameter is the number of columns in $A$.
\item
The {\tt nentA} parameter is the number of entries to be put into $A$.
\item
The {\tt nrowX} parameter is the number of rows in $X$.
\item
The {\tt coordType} parameter defines the coordinate type that will
be used during the redistribution. Valid values are {\tt 1} for rows,
{\tt 2} for columns and {\tt 3} for chevrons.
\item
The {\tt inputMode} parameter defines the mode of input.
Valid values are {\tt 1} for real entries 
and {\tt 2} for complex entries.
\item
The {\tt symflag} parameter specifies whether the matrix is
symmetric ({\tt symflag} = 0),
Hermitian ({\tt symflag} = 1) or
nonsymmetric ({\tt symflag} = 2)
\item
The {\tt opflag} parameter specifies the type of multiply,
{\tt 0} for $Y := Y + \alpha A X$,
{\tt 1} for $Y := Y + \alpha A^T X$ or
{\tt 2} for $Y := Y + \alpha A^H X$.
\item
The {\tt seed} parameter is a random number seed.
\item
The {\tt real} parameter is the real part of the scalar $\alpha$.
\item
The {\tt imag} parameter is the imaginary part of the scalar $\alpha$,
ignored for real entries.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testScatterDenseMtx msglvl msgFile nrow ncol inc1 inc2 seed root
\end{verbatim}
This driver program exercises the
{\tt DenseMtx\_MPI\_splitFromGlobalByRows()}
method to split or redistribute by rows
a {\tt DenseMtx} dense matrix object.
Process {\tt root} generates the {\tt DenseMtx} object.
A random map is generated (the same map on all processes) and the
object is redistributed using this random map.
The local matrices are then gathered into a second global matrix on
processor {\tt root} and the two are compared.
Use the script file {\tt do\_ScatterDenseMtx} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt nrow} parameter is the number of rows for the matrix.
\item
The {\tt ncol} parameter is the number of columns for the matrix.
\item
The {\tt inc1} parameter is the row increment  for the matrix.
Valid values are {\tt 1} for column major and {\tt ncol} for row
major.
\item
The {\tt inc2} parameter is the column increment  for the matrix.
Valid values are {\tt 1} for row major and {\tt nrow} for column
major.
\item
The {\tt seed} parameter is a random number seed.
\item
The {\tt root} parameter is the root processor for the scatter and
gather.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testScatterInpMtx msglvl msgFile neqns seed 
                  coordType inputMode inInpMtxFile root
\end{verbatim}
This driver program tests the distributed 
{\tt InpMtx\_MPI\_splitFromGlobal()}
method to split a {\tt InpMtx} sparse matrix object.
Process {\tt root} reads in the {\tt InpMtx} object.
A random map is generated (the same map on all processes) and the
object is scattered from processor {\tt root} to the other processors.
Use the script file {\tt do\_ScatterInpMtx} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt neqns} parameter is the number of equations for the matrix.
\item
The {\tt seed} parameter is a random number seed.
\item
The {\tt coordType} parameter defines the coordinate type that will
be used during the redistribution. Valid values are {\tt 1} for rows,
{\tt 2} for columns and {\tt 3} for chevrons.
\item
The {\tt inputMode} parameter defines the mode of input.
Valid values are {\tt 0} for indices only,
{\tt 1} for real entries 
and {\tt 2} for complex entries.
\item
The {\tt inInpMtxFile} parameter is the name of the file that
contain the {\tt InpMtx} object.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testSplitDenseMtx msglvl msgFile nrow ncol inc1 inc2 seed
\end{verbatim}
This driver program tests the distributed 
{\tt DenseMtx\_MPI\_splitByRows()}
method to split or redistribute by rows
a {\tt DenseMtx} dense matrix object.
Process zero generates the {\tt DenseMtx} object.
It is then split among the processes using a wrap map.
A random map is generated (the same map on all processes) and the
object is redistributed using this random map.
Use the script file {\tt do\_SplitDenseMtx} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt nrow} parameter is the number of rows for the matrix.
\item
The {\tt ncol} parameter is the number of columns for the matrix.
\item
The {\tt inc1} parameter is the row increment  for the matrix.
Valid values are {\tt 1} for column major and {\tt ncol} for row
major.
\item
The {\tt inc2} parameter is the column increment  for the matrix.
Valid values are {\tt 1} for row major and {\tt nrow} for column
major.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testSplitInpMtx msglvl msgFile neqns seed coordType inputMode inInpMtxFile
\end{verbatim}
This driver program tests the distributed {\tt InpMtx\_MPI\_split()}
method to split or redistribute a {\tt InpMtx} sparse matrix object.
Process zero reads in the {\tt InpMtx} object.
It is then split among the processes using a wrap map.
A random map is generated (the same map on all processes) and the
object is redistributed using this random map.
Use the script file {\tt do\_SplitInpMtx} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt neqns} parameter is the number of equations for the matrix.
\item
The {\tt seed} parameter is a random number seed.
\item
The {\tt coordType} parameter defines the coordinate type that will
be used during the redistribution. Valid values are {\tt 1} for rows,
{\tt 2} for columns and {\tt 3} for chevrons.
\item
The {\tt inputMode} parameter defines the mode of input.
Valid values are {\tt 0} for indices only,
{\tt 1} for real entries 
and {\tt 2} for complex entries.
\item
The {\tt inInpMtxFile} parameter is the name of the file that
contain the {\tt InpMtx} object.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testSymbFac msglvl msgFile inGraphFile inETreeFile seed 
\end{verbatim}
This driver program tests the distributed 
{\tt SymbFac\_MPI\_initFromInpMtx()} method
that forms a {\tt IVL} object that contains the necessary parts of
a symbolic factorization for each processor.
The program reads in the global {\tt Graph} and {\tt ETree}
objects.
Each processor creates a global {\tt InpMtx} object from the
structure of the graph and computes a global symbolic factorization
object using the serial {\tt SymbFac\_initFromInpMtx()} method.
The processors then compute a map from fronts to processors, and
each processor throws away the unowned matrix entries from the {\tt
InpMtx} object.
The processors then compute their necessary symbolic factorizations
in parallel.
For a check, they compare the two symbolic factorizations for error.
Use the script file {\tt do\_symbfac} for testing.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt inGraphFile} parameter is the input file for the {\tt
Graph} object.
\item
The {\tt inETreeFile} parameter is the input file for the {\tt
ETree} object.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\end{enumerate}