doc/man/manTemplates/renumberMesh.1.in

   1 '\" t
   2 .\"     Title: @UP@RENUMBERMESH
   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@RENUMBERMESH" "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@renumberMesh \- Renumbers the cell list in order to reduce the bandwidth, reading and renumbering all fields from all the time directories\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@renumberMesh\fR [\-blockOrder] [\-writeMaps] [\-orderPoints] [\-overwrite] [\-noZero] [\-constant] [\-time \fI<time>\fR] [\-latestTime] [\-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\-blockOrder\fR
  32 .RS 4
  33 Order cells into regions and faces into region\-internal/external\&.
  34 .RE
  35 .PP
  36 \fB\-writeMaps\fR
  37 .RS 4
  38 Write renumber map (new to old)
  39 .RE
  40 .PP
  41 \fB\-orderPoints\fR
  42 .RS 4
  43 Order points into internal/boundary points\&.
  44 .RE
  45 .PP
  46 \fB\-overwrite\fR
  47 .RS 4
  48 Overwrite existing data\&.
  49 .RE
  50 .PP
  51 \fB\-noZero\fR
  52 .RS 4
  53 Ignore timestep 0\&.
  54 .RE
  55 .PP
  56 \fB\-constant\fR
  57 .RS 4
  58 Include the constant directory\&.
  59 .RE
  60 .PP
  61 \fB\-time\fR \fI<time>\fR
  62 .RS 4
  63 Apply only to specific time\&.
  64 .RE
  65 .PP
  66 \fB\-latestTime\fR
  67 .RS 4
  68 Only apply to latest time step\&.
  69 .RE
  70 .PP
  71 \fB\-case\fR \fI<dir>\fR
  72 .RS 4
  73 Case directory\&.
  74 .RE
  75 .PP
  76 \fB\-parallel\fR
  77 .RS 4
  78 Run in parallel\&.
  79 .RE
  80 .PP
  81 \fB\-help\fR
  82 .RS 4
  83 Display help message\&.
  84 .RE
  85 .PP
  86 \fB\-doc\fR
  87 .RS 4
  88 Display Doxygen API documentation page for this application\&.
  89 .RE
  90 .PP
  91 \fB\-srcDoc\fR
  92 .RS 4
  93 Display Doxygen source documentation page for this application\&.
  94 .RE
  95 .SH "SEE ALSO"
  96 .sp
  97 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  98 .SH "AUTHOR"
  99 .sp
 100 OpenCFD Ltd\&.
 101 .SH "FREEFOAM"
 102 .sp
 103 Part of the \fBfreefoam\fR(7) suite\&.
 104 .SH "COPYRIGHT"
 105 .SS "Copyright \(co 2009 Michael Wild\&."
 106 .sp
 107 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
 108 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
 109 .sp
 110 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
 111 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
 112 .sp
 113 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