doc/man/manTemplates/foamToStarMesh.1.in

   1 '\" t
   2 .\"     Title: @UP@FOAMTOSTARMESH
   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@FOAMTOSTARMESH" "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@foamToStarMesh \- Reads an OpenFOAM mesh and writes a pro\-STAR (v4) bnd/cel/vrt format\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@foamToStarMesh\fR [\-noBnd] [\-scale \fI<factor>\fR] [\-surface] [\-tri] [\-case \fI<dir>\fR] [\-noZero] [\-constant] [\-latestTime] [\-time \fI<time>\fR] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 \fBTODO\fR extended description
  29 .SH "OPTIONS"
  30 .PP
  31 \fB\-noBnd\fR
  32 .RS 4
  33 Suppress writing the
  34 \&.bnd
  35 file\&.
  36 .RE
  37 .PP
  38 \fB\-scale\fR \fI<factor>\fR
  39 .RS 4
  40 Specify an alternative geometry scaling factor\&. The default is
  41 \fB1000\fR
  42 (scale
  43 \fI[m]\fR
  44 to
  45 \fI[mm])\&.\fR
  46 .RE
  47 .PP
  48 \fB\-surface\fR
  49 .RS 4
  50 Extract the surface of the volume mesh only\&. This can be useful, for example, for surface morphing in an external package\&.
  51 .RE
  52 .PP
  53 \fB\-tri\fR
  54 .RS 4
  55 Extract a triangulated surface\&. The
  56 \fB\-surface\fR
  57 options is implicitly selected\&.
  58 .RE
  59 .PP
  60 \fB\-case\fR \fI<dir>\fR
  61 .RS 4
  62 Case directory\&.
  63 .RE
  64 .PP
  65 \fB\-noZero\fR
  66 .RS 4
  67 Ignore time step 0\&.
  68 .RE
  69 .PP
  70 \fB\-constant\fR
  71 .RS 4
  72 Include the constant directory\&.
  73 .RE
  74 .PP
  75 \fB\-latestTime\fR
  76 .RS 4
  77 Only apply to the latest time step\&.
  78 .RE
  79 .PP
  80 \fB\-time\fR \fI<time>\fR
  81 .RS 4
  82 Apply only to specified time\&.
  83 .RE
  84 .PP
  85 \fB\-help\fR
  86 .RS 4
  87 Display help message\&.
  88 .RE
  89 .PP
  90 \fB\-doc\fR
  91 .RS 4
  92 Display Doxygen API documentation page for this application\&.
  93 .RE
  94 .PP
  95 \fB\-srcDoc\fR
  96 .RS 4
  97 Display Doxygen source documentation page for this application\&.
  98 .RE
  99 .SH "NOTE"
 100 .sp
 101 The cellTable information available in the files constant/cellTable and constant/polyMesh/cellTableId will be used if available\&. Otherwise the cellZones are used when creating the cellTable information\&.
 102 .SH "SEE ALSO"
 103 .sp
 104 Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD
 105 .sp
 106 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
 107 .SH "AUTHOR"
 108 .sp
 109 OpenCFD Ltd\&.
 110 .SH "FREEFOAM"
 111 .sp
 112 Part of the \fBfreefoam\fR(7) suite\&.
 113 .SH "COPYRIGHT"
 114 .SS "Copyright \(co 2009 Michael Wild\&."
 115 .sp
 116 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
 117 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
 118 .sp
 119 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
 120 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
 121 .sp
 122 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