.\" Text automatically generated by txt2man
.TH gmk_m2 1 "02 April 2021" "" "Scotch user's manual"
.SH NAME
\fBgmk_m2, gmk_m3 \fP- create 2D and 3D grid source graphs
\fB
.SH SYNOPSIS
.nf
.fam C
\fBgmk_m2\fP [\fIoptions\fP] [\fB-b\fPbval] [\fB-g\fP\fIcfile\fP] [\fB-t\fP] [\fB-y\fP] \fIdimX\fP \fIdimY\fP [\fIofile\fP]

\fBgmk_m3\fP [\fIoptions\fP] [\fB-b\fPbval] [\fB-g\fP\fIcfile\fP] [\fB-t\fP] [\fB-y\fP] \fIdimX\fP \fIdimY\fP \fIdimZ\fP [\fIofile\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
The \fBgmk_\fP* programs create source graph files for some common,
regular topologies.
.PP
\fBgmk_m2\fP creates a 2D regular grid graph of \fIdimX\fP times \fIdimY\fP vertices,
such that vertex (i,j) is connected to vertices (i,j-1), (i-1,j),
(i+1,j) and (i,j+1), if they exist. If the \fB-e\fP option is set, it is
additionally connected to vertices (i-1,j-1), (i+1,j-1),
(i-1,j+1) and (i+1,j+1), if they exist.
.PP
\fBgmk_m3\fP creates a 3D regular grid graph of \fIdimX\fP times \fIdimY\fP times \fIdimZ\fP
vertices, such that vertex (i,j,k) is connected to vertices
(i,j,k-1), (i,j-1,k), (i-1,j,k), (i+1,j,k), (i,j+1,k) and (i,j,k+1),
if they exist.
.SH OPTIONS
.TP
.B
\fB-b\fPbval
Set the base value of the graph to bval. Default base value is 0.
.TP
.B
\fB-e\fP
Build a 8-neighbor grid rather than a 4-neighbor one (for
\fBgmk_m2\fP only).
.TP
.B
\fB-g\fP\fIcfile\fP
Output graph vertex coordinates (that is, geometry data to be used by
gout) in file \fIcfile\fP.
.TP
.B
\fB-h\fP
Display some help.
.TP
.B
\fB-t\fP
Builds a torus rather than a grid.
.TP
.B
\fB-V\fP
Display program version and copyright.
.TP
.B
\fB-y\fP
Invert y coordinate in geometry.
.SH EXAMPLE
Create a 2D graph of 5x7 vertices, of base 1, along with its geometry:
.PP
.nf
.fam C
    $ gmk_m2 5 7 -b1 -g/tmp/m5x7.xyz /tmp/m5x7.grf

.fam T
.fi
.SH SEE ALSO
\fBgtst\fP(1), \fBgout\fP(1), \fBgmap\fP(1), \fBgord\fP(1), \fBgpart\fP(1).
.PP
Scotch user's manual.
.SH AUTHOR
Francois Pellegrini <francois.pellegrini@labri.fr>