mirror of
https://github.com/OpenFOAM/ThirdParty-6.git
synced 2025-12-08 06:57:43 +00:00
1cce60aa78
Recent versions of scotch are rarely available in packaged form for ready installation on GNU/Linux distributions and so the sources are generally required.
61 lines
1.9 KiB
Groff
61 lines
1.9 KiB
Groff
." Text automatically generated by txt2man
|
|
.TH gotst 1 "August 03, 2010" "" "Scotch user's manual"
|
|
.SH NAME
|
|
\fBgomtst \fP- compute statistics on sparse matrix orderings
|
|
\fB
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
\fBgotst\fP [\fIoptions\fP] [\fIgfile\fP] [\fIofile\fP] [\fIlfile\fP]
|
|
.fam T
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The \fBgotst\fP program computes, in a sequential way, statistics on a
|
|
sparse matrix ordering, such as fill-in, operation count, and
|
|
separator tree parameters: minimum, maximum, average height and
|
|
variance of its leaves.
|
|
.PP
|
|
Source graph file \fIgfile\fP can only be a centralized graph file. File
|
|
\fIofile\fP represents the ordering of the symmetric sparse matrix the
|
|
pattern of which is represented by \fIgfile\fP. 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, gtst
|
|
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
|
|
Since \fBgotst\fP performs sequentially the symbolic factorization of
|
|
matrix \fIgfile\fP in order to compute fill-in and operation count
|
|
numbers, this program can take a long time or even run out of memory,
|
|
when applied to very large graphs.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B
|
|
\fB-h\fP
|
|
Display some help.
|
|
.TP
|
|
.B
|
|
\fB-V\fP
|
|
Display program version and copyright.
|
|
.SH EXAMPLE
|
|
Display statistics on ordering brol.ord of graph brol.grf:
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
$ gotst brol.grf brol.ord
|
|
|
|
.fam T
|
|
.fi
|
|
.SH SEE ALSO
|
|
\fBgord\fP(1), \fBgtst\fP(1), \fBdgord\fP(1).
|
|
.PP
|
|
Scotch user's manual.
|
|
.SH AUTHOR
|
|
Francois Pellegrini <francois.pellegrini@labri.fr>
|