doc/man/manTemplates/star4ToFoam.1.in

   1 '\" t
   2 .\"     Title: @UP@STAR4TOFOAM
   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@STAR4TOFOAM" "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@star4ToFoam \- Converts a Star\-CD (v4) pro\-STAR mesh into OpenFOAM format\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@star4ToFoam\fR [\-ascii] [\-scale \fI<factor>\fR] [\-solids] [\-case \fI<dir>\fR] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 \fBTODO\fR extended description
  29 .SH "OPTIONS"
  30 .PP
  31 \fB\-ascii\fR
  32 .RS 4
  33 Write in ASCII format instead of binary\&.
  34 .RE
  35 .PP
  36 \fB\-scale\fR \fI<factor>\fR
  37 .RS 4
  38 Specify an alternative geometry scaling factor\&. The default is
  39 \fB0\&.001\fR
  40 (scale
  41 \fI[mm]\fR
  42 to
  43 \fI[m])\&.\fR
  44 .RE
  45 .PP
  46 \fB\-solids\fR
  47 .RS 4
  48 Treat any solid cells present just like fluid cells\&. The default is to discard them\&.
  49 .RE
  50 .PP
  51 \fB\-case\fR \fI<dir>\fR
  52 .RS 4
  53 Case directory\&.
  54 .RE
  55 .PP
  56 \fB\-help\fR
  57 .RS 4
  58 Display help message\&.
  59 .RE
  60 .PP
  61 \fB\-doc\fR
  62 .RS 4
  63 Display Doxygen API documentation page for this application\&.
  64 .RE
  65 .PP
  66 \fB\-srcDoc\fR
  67 .RS 4
  68 Display Doxygen source documentation page for this application\&.
  69 .RE
  70 .SH "NOTE"
  71 .sp
  72 .RS 4
  73 .ie n \{\
  74 \h'-04'\(bu\h'+03'\c
  75 .\}
  76 .el \{\
  77 .sp -1
  78 .IP \(bu 2.3
  79 .\}
  80 baffles are written as interfaces for later use
  81 .RE
  82 .SH "SEE ALSO"
  83 .sp
  84 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  85 .SH "AUTHOR"
  86 .sp
  87 OpenCFD Ltd\&.
  88 .SH "FREEFOAM"
  89 .sp
  90 Part of the \fBfreefoam\fR(7) suite\&.
  91 .SH "COPYRIGHT"
  92 .SS "Copyright \(co 2009 Michael Wild\&."
  93 .sp
  94 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
  95 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  96 .sp
  97 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
  98 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
  99 .sp
 100 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