man/gpiv_vorstra.1

   1 .TH GPIV_VORSTRA 1 "8 November 2006"
   2 .SH NAME
   3 gpiv_vorstra \- Calculates the differential quantities vorticity, shear
   4 strain and normal strain from PIV data.
   5 .SH SYNOPSIS
   6
   7 \fBgpiv_vorstra\fP
   8 [\fB-d \fIN\fR]
   9 [\fB-h\fR | \fB--help\fR]
  10 [\fB-n\fR | \fB-o\fR | \fB-s\fR]
  11 [\fB--no_g \fR]
  12 [\fB-p\fR | \fB--print\fR]
  13 [\fB-g\fR | \fB--g\fR]
  14 [\fB-v\fR | \fB--version\fR]
  15 [\fIfilename\fR]
  16 < \fIstdin\fR > \fIstdout\fR
  17
  18 \fP
  19
  20 .SH DESCRIPTION
  21
  22 \fBgpiv_vorstra\fP calculates the differential quantities like
  23 vorticity, shear strain and normal strain from PIV data. You can
  24 choose from several differential schemes: central differentiation,
  25 least squares, Richardson extrapolation and circulation
  26 method. Circulation method only allows to calculate vorticity, but no
  27 strain. The output can be generated as ASCII data containing four
  28 columns or as GNUPlot Data format that allows to view/print the data
  29 as contour plots.
  30
  31 The configuration parameters (containing the \fBPOST\fR key) may be
  32 overruled by the command line options, as explained below.
  33
  34 .SH Options
  35
  36 .TP
  37 \fB-d \fIN\fP
  38 Differential type to be used: central difference
  39 (\fIN\fR=0), least squares (\fIN\fR=1), Richardson interpolation
  40 (\fIN\fR=2), circulation method (\fIN\fR=3)
  41
  42 .TP
  43 \fB-h\fR | \fB--help\fP
  44 On-line help
  45
  46 .TP
  47 \fB-n\fR
  48 Calculate normal strain of the PIV data. As an alternative the program may
  49 be called by its nickname \fIgpiv_nstrain\fR. In combination with
  50 \fIfilename\fR the output will be written to \fIfilename\fB.nstr\fR.
  51
  52 .TP
  53 \fB-o\fP
  54 Calculate vorticity of the PIV data. As an alternative the program may
  55 be called by its nickname \fIgpiv_vorty\fR. In combination with
  56 \fIfilename\fR the output will be written to \fIfilename\fB.vor\fR.
  57
  58 .TP
  59 \fB-p\fR | \fB--print\fP
  60 Print parameters, command line options and eventually used input and
  61 output filenames to stdout. The output is identic of \fIfilename\fB.par\fR,
  62 in case \fIfilename\fP is used.
  63
  64 .TP
  65 \fB-s\fR
  66 Calculate shear strain of the PIV data. As an alternative the program may
  67 be called by its nickname \fIsstrain\fR. In combination with
  68 \fIfilename\fR the output will be written to \fIfilename\fB.sstr\fR.
  69
  70 .TP
  71 \fB-g\fR
  72 Show contour plot of the output with gnuplot.
  73
  74 .TP
  75 \fB--no_g\fR
  76 Suppresses to show contour plot of the output with gnuplot.
  77
  78 .TP
  79 \fB-v\fR | \fB--version\fP
  80 Print version information on standard output, then exit successfully.
  81
  82 .TP
  83 \fIfilename\fR
  84 Input PIV data file. Overrides stdin and stdout. The output will be
  85 written to \fIfilename\fB.vor\fR with \fB-o\fP, \fIfilename\fB.nstr\fR
  86 with \fB-n\fR or \fIfilename\fB.sstr\fR with \fB-s\fR.  Parameters are stored
  87 in \fIfilename\fB.par\fR and may be used for future use by including them
  88 in \fI./gpivrc\fR.
  89
  90 .SH SEE ALSO
  91 gpivtools
  92
  93 .SH AUTHOR
  94 Gerber Van der Graaf