doc/man/manTemplates/transformPoints.1.in

   1 '\" t
   2 .\"     Title: @UP@TRANSFORMPOINTS
   3 .\"    Author: [see the "AUTHOR" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2009
   6 .\"    Manual: FreeFOAM Manual
   7 .\"    Source: FreeFOAM @FF_VERSION_FULL@
   8 .\"  Language: English
   9 .\"
  10 .TH "@UP@TRANSFORMPOINTS" "1" "07/25/2009" "FreeFOAM @FF_VERSION_FULL@" "FreeFOAM Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 @EXECUTABLE_PREFIX@transformPoints \- Transforms the mesh points in the polyMesh directory according to the options:
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@transformPoints\fR [\-translate \fI<vector>\fR] [\-rotateFields] [\-rotate \fI<(vector vector)>\fR] [\-scale \fI<vector (sx sy sz)>\fR] [\-case \fI<dir>\fR] [\-parallel] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 \-translate vector Translates the points by the given vector,
  29 .sp
  30 \-rotate (vector vector) Rotates the points from the first vector to the second,
  31 .sp
  32 \-scale vector Scales the points by the given vector\&.
  33 .sp
  34 The any or all of the three options may be specified and are processed in the above order\&.
  35 .sp
  36 With \-rotateFields (in combination with \-rotate) it will also read & transform vector & tensor fields\&.
  37 .SH "OPTIONS"
  38 .PP
  39 \fB\-translate\fR \fI<vector>\fR
  40 .RS 4
  41 Translate by given vector\&.
  42 .RE
  43 .PP
  44 \fB\-rotateFields\fR
  45 .RS 4
  46 Also rotate vector/tensor fields\&.
  47 .RE
  48 .PP
  49 \fB\-rotate\fR \fI<(vector vector)>\fR
  50 .RS 4
  51 Rotate from first to second direction\&.
  52 .RE
  53 .PP
  54 \fB\-scale\fR \fI<vector (sx sy sz)>\fR
  55 .RS 4
  56 Scaling factors in x, y and z direction\&.
  57 .RE
  58 .PP
  59 \fB\-case\fR \fI<dir>\fR
  60 .RS 4
  61 Case directory\&.
  62 .RE
  63 .PP
  64 \fB\-parallel\fR
  65 .RS 4
  66 Run in parallel\&.
  67 .RE
  68 .PP
  69 \fB\-help\fR
  70 .RS 4
  71 Display help message\&.
  72 .RE
  73 .PP
  74 \fB\-doc\fR
  75 .RS 4
  76 Display Doxygen API documentation page for this application\&.
  77 .RE
  78 .PP
  79 \fB\-srcDoc\fR
  80 .RS 4
  81 Display Doxygen source documentation page for this application\&.
  82 .RE
  83 .SH "SEE ALSO"
  84 .sp
  85 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  86 .SH "AUTHOR"
  87 .sp
  88 OpenCFD Ltd\&.
  89 .SH "FREEFOAM"
  90 .sp
  91 Part of the \fBfreefoam\fR(7) suite\&.
  92 .SH "COPYRIGHT"
  93 .SS "Copyright \(co 2009 Michael Wild\&."
  94 .sp
  95 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1\&.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front\-Cover Texts, and no Back\-Cover Texts\&. A copy of the license is available from http://www\&.gnu\&.org/copyleft/fdl\&.html
  96 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  97 .sp
  98 OpenFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html
  99 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
 100 .sp
 101 FreeFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html