Files
ThirdParty-6/scotch_6.0.3/man/man1/dgtst.1
Henry Weller 1cce60aa78 scotch_6.0.3: Added to the source tree to simplify building OpenFOAM
Recent versions of scotch are rarely available in packaged form for
ready installation on GNU/Linux distributions and so the sources are
generally required.
2016-05-30 21:17:14 +01:00

79 lines
2.5 KiB
Groff
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

." Text automatically generated by txt2man
.TH dgtst 1 "August 03, 2010" "" "PT-Scotch user's manual"
.SH NAME
\fBdgtst \fP- test the consistency of source graphs in parallel
\fB
.SH SYNOPSIS
.nf
.fam C
\fBdgtst\fP [\fIoptions\fP] [\fIgfile\fP] [\fIlfile\fP]
.fam T
.fi
.SH DESCRIPTION
The \fBdgtst\fP program checks, in a parallel way, the consistency of a
Scotch source graph and, in case of success, outputs some statistics
regarding edge weights, vertex weights, and vertex degrees.
.PP
It produces the very same results as the \fBgtst\fP(1) program of the
Scotch sequential distribution, but unlike this latter it can handle
distributed graphs.
.PP
Source graph file \fIgfile\fP is either a centralized graph file, or a set
of files representing fragments of a distributed graph. The
resulting statistics are stored in file \fIlfile\fP. When file names are
not specified, data is read from standard input and written to
standard output. Standard streams can also be explicitly
represented by a dash '-'.
.PP
When the proper libraries have been included at compile time, \fBdgtst\fP
can directly handle compressed graphs, both as input and output. A
stream is treated as compressed whenever its name is postfixed with
a compressed file extension, such as in 'brol.grf.bz2' or '-.gz'. The
compression formats which can be supported are the bzip2 format
('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma', on
input only).
.PP
\fBdgtst\fP bases on implementations of the MPI interface to spread work
across the processing elements. It is therefore not likely to be run
directly, but instead through some launcher command such as \fBmpirun\fP.
.SH OPTIONS
.TP
.B
\fB-h\fP
Display some help.
.TP
.B
\fB-r\fP\fIpnum\fP
Set root process for centralized files (default is 0).
.TP
.B
\fB-V\fP
Display program version and copyright.
.SH EXAMPLE
Run \fBdgtst\fP on 5 processing elements to test the consistency of graph brol.grf
.PP
.nf
.fam C
$ mpirun -np 5 dgtst brol.grf
.fam T
.fi
Run dgord on 5 processing elements to test the consistency of a
distributed graph stored on graph fragment files brol5-0.dgr to
brol5-4.dgr, and save the resulting ordering to file brol.ord (see
\fBdgscat\fP(1) for an explanation of the '%p' and '%r' sequences in names
of distributed graph fragments).
.PP
.nf
.fam C
$ mpirun -np 5 dgtst brol%p-%r.dgr brol.ord
.fam T
.fi
.SH SEE ALSO
\fBdgscat\fP(1), \fBgtst\fP(1), \fBdgord\fP(1).
.PP
PT-Scotch user's manual.
.SH AUTHOR
Francois Pellegrini <francois.pellegrini@labri.fr>