STYLE: add notes to some (most) command-line options

- mapFields and splitMeshRegions need more clarification
This commit is contained in:
Mark Olesen
2010-04-27 10:50:15 +02:00
parent 5debfe4cdf
commit 147fa2a75d
85 changed files with 1221 additions and 472 deletions

View File

@ -176,7 +176,11 @@ static void writeFaceData
int main(int argc, char *argv[])
{
argList::noParallel();
argList::addBoolOption("noWall");
argList::addBoolOption
(
"noWall",
"skip setting wall information"
);
timeSelector::addOptions(true, false);
# include "setRootCase.H"

View File

@ -31,7 +31,7 @@ Usage
- foamToTecplot360 [OPTION]
@param -fields \<fields\>\n
@param -fields \<names\>\n
Convert selected fields only. For example,
@verbatim
-fields '( p T U )'
@ -163,30 +163,65 @@ labelList getSelectedPatches
int main(int argc, char *argv[])
{
argList::addNote
(
"Tecplot binary file format writer"
);
timeSelector::addOptions();
#include "addRegionOption.H"
# include "addRegionOption.H"
argList::addOption("fields", "fields");
argList::addOption("cellSet", "cellSet name");
argList::addOption("faceSet", "faceSet name");
argList::addBoolOption("nearCellValue");
argList::addBoolOption("noInternal");
argList::addBoolOption("noPointValues");
argList::addOption
(
"fields",
"names",
"convert selected fields only. eg, '(p T U)'"
);
argList::addOption
(
"cellSet",
"name",
"restrict conversion to the specified cellSet"
);
argList::addOption
(
"faceSet",
"name",
"restrict conversion to the specified cellSet"
);
argList::addBoolOption
(
"nearCellValue",
"output cell value on patches instead of patch value itself"
);
argList::addBoolOption
(
"noInternal",
"do not generate file for mesh, only for patches"
);
argList::addBoolOption
(
"noPointValues",
"no pointFields"
);
argList::addOption
(
"excludePatches",
"patches (wildcards) to exclude"
);
argList::addBoolOption("noFaceZones");
argList::addBoolOption
(
"noFaceZones",
"no faceZones"
);
# include "setRootCase.H"
# include "createTime.H"
#include "setRootCase.H"
#include "createTime.H"
bool doWriteInternal = !args.optionFound("noInternal");
bool doFaceZones = !args.optionFound("noFaceZones");
bool nearCellValue = args.optionFound("nearCellValue");
const bool doWriteInternal = !args.optionFound("noInternal");
const bool doFaceZones = !args.optionFound("noFaceZones");
const bool nearCellValue = args.optionFound("nearCellValue");
const bool noPointValues = args.optionFound("noPointValues");
if (nearCellValue)
{
@ -195,8 +230,6 @@ int main(int argc, char *argv[])
<< nl << endl;
}
bool noPointValues = args.optionFound("noPointValues");
if (noPointValues)
{
WarningIn(args.executable())

View File

@ -226,13 +226,17 @@ labelList getSelectedPatches
int main(int argc, char *argv[])
{
argList::addNote
(
"legacy VTK file format writer"
);
timeSelector::addOptions();
# include "addRegionOption.H"
#include "addRegionOption.H"
argList::addOption
(
"fields", "wordList",
"fields",
"wordList",
"only convert the specified fields - eg '(p T U)'"
);
argList::addOption
@ -241,25 +245,59 @@ int main(int argc, char *argv[])
"name",
"convert a mesh subset corresponding to the specified cellSet"
);
argList::addOption("faceSet", "name");
argList::addOption("pointSet", "name");
argList::addOption
(
"faceSet",
"name",
"restrict conversion to the specified faceSet"
);
argList::addOption
(
"pointSet",
"name",
"restrict conversion to the specified pointSet"
);
argList::addBoolOption
(
"ascii",
"write in ASCII format instead of binary"
);
argList::addBoolOption("surfaceFields");
argList::addBoolOption("nearCellValue");
argList::addBoolOption("noInternal");
argList::addBoolOption("noPointValues");
argList::addBoolOption("allPatches");
argList::addBoolOption
(
"surfaceFields",
"write surfaceScalarFields (e.g., phi)"
);
argList::addBoolOption
(
"nearCellValue",
"use cell value on patches instead of patch value itself"
);
argList::addBoolOption
(
"noInternal",
"do not generate file for mesh, only for patches"
);
argList::addBoolOption
(
"noPointValues",
"no pointFields"
);
argList::addBoolOption
(
"allPatches",
"combine all patches into a single file"
);
argList::addOption
(
"excludePatches",
"wordReList",
"a list of patches to exclude - eg '( inlet \".*Wall\" )' "
);
argList::addBoolOption("noFaceZones");
argList::addBoolOption
(
"noFaceZones",
"no faceZones"
);
argList::addBoolOption
(
"noLinks",
@ -271,8 +309,8 @@ int main(int argc, char *argv[])
"use the time name instead of the time index when naming the files"
);
# include "setRootCase.H"
# include "createTime.H"
#include "setRootCase.H"
#include "createTime.H"
const bool doWriteInternal = !args.optionFound("noInternal");
const bool doFaceZones = !args.optionFound("noFaceZones");