doc/man/manTemplates/engineCompRatio.1.in

   1 '\" t
   2 .\"     Title: @UP@ENGINECOMPRATIO
   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@ENGINECOMPRATIO" "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@engineCompRatio \- Calculate the geometric compression ratio\&. Note that if you have valves and/or extra volumes it will not work, since it calculates the volume at BDC and TCD\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@engineCompRatio\fR [\-case \fI<dir>\fR] [\-parallel] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 \fBTODO\fR extended description
  29 .SH "OPTIONS"
  30 .PP
  31 \fB\-case\fR \fI<dir>\fR
  32 .RS 4
  33 Case directory\&.
  34 .RE
  35 .PP
  36 \fB\-parallel\fR
  37 .RS 4
  38 Run in parallel\&.
  39 .RE
  40 .PP
  41 \fB\-help\fR
  42 .RS 4
  43 Display help message\&.
  44 .RE
  45 .PP
  46 \fB\-doc\fR
  47 .RS 4
  48 Display Doxygen API documentation page for this application\&.
  49 .RE
  50 .PP
  51 \fB\-srcDoc\fR
  52 .RS 4
  53 Display Doxygen source documentation page for this application\&.
  54 .RE
  55 .SH "SEE ALSO"
  56 .sp
  57 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  58 .SH "AUTHOR"
  59 .sp
  60 OpenCFD Ltd\&.
  61 .SH "FREEFOAM"
  62 .sp
  63 Part of the \fBfreefoam\fR(7) suite\&.
  64 .SH "COPYRIGHT"
  65 .SS "Copyright \(co 2009 Michael Wild\&."
  66 .sp
  67 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
  68 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  69 .sp
  70 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
  71 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
  72 .sp
  73 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