Commit 1319df48 authored by Henry Weller's avatar Henry Weller
Browse files

Rationalized Doxygen documentation of command-line options

parent b33932e1
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -28,15 +28,15 @@ Description
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
Usage
- foamToStarMesh [OPTION] \n
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
\b foamToStarMesh [OPTION]
\param -noBnd \n
Suppress writing the \c .bnd file
Options:
- \par -noBnd
Suppress writing the \c .bnd file
\param -scale \<factor\>\n
Specify an alternative geometry scaling factor.
The default is \b 1000 (scale \em [m] to \em [mm]).
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
The default is \b 1000 (scale \em [m] to \em [mm]).
Note
The cellTable information available in the files
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -28,15 +28,15 @@ Description
Reads an OpenFOAM mesh and writes the boundaries in a surface format.
Usage
- foamToSurface [OPTION] \n
Reads an OpenFOAM mesh and writes the boundaries in a surface format.
\b foamToSurface [OPTION]
\param -scale \<factor\>\n
Specify an alternative geometry scaling factor.
Eg, use \b 1000 to scale \em [m] to \em [mm].
Options:
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
E.g. use \b 1000 to scale \em [m] to \em [mm].
\param -tri \n
Triangulate surface.
- \par -tri
Triangulate surface.
\*---------------------------------------------------------------------------*/
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -28,22 +28,22 @@ Description
Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.
Usage
- star4ToFoam [OPTION] ccmMesh\n
convert pro-STAR mesh to OpenFOAM
\b star4ToFoam [OPTION] ccmMesh
\param -ascii \n
Write in ASCII format instead of binary
Options:
- \par -ascii
Write in ASCII format instead of binary
\param -scale \<factor\>\n
Specify an alternative geometry scaling factor.
The default is \b 0.001 (scale \em [mm] to \em [m]).
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
The default is \b 0.001 (scale \em [mm] to \em [m]).
\param -solids \n
Treat any solid cells present just like fluid cells.
The default is to discard them.
- \par -solids
Treat any solid cells present just like fluid cells.
The default is to discard them.
Note
- baffles are written as interfaces for later use
Baffles are written as interfaces for later use
\*---------------------------------------------------------------------------*/
......
blockMeshApp.C
blockMesh.C
EXE = $(FOAM_APPBIN)/blockMesh
......@@ -28,23 +28,23 @@ Description
A multi-block mesh generator.
Uses the block mesh description found in
\a system/blockMeshDict
or \a system/\<region\>/blockMeshDict
or \a constant/polyMesh/blockMeshDict
or \a constant/\<region\>/polyMesh/blockMeshDict
- \c system/blockMeshDict
- \c system/\<region\>/blockMeshDict
- \c constant/polyMesh/blockMeshDict
- \c constant/\<region\>/polyMesh/blockMeshDict
Usage
\b blockMesh [OPTION]
- blockMesh [OPTION]
Options:
- \par -blockTopology
Write the topology as a set of edges in OBJ format.
\param -blockTopology \n
Write the topology as a set of edges in OBJ format.
- \par -region \<name\>
Specify an alternative mesh region.
\param -region \<name\> \n
Specify an alternative mesh region.
\param -dict \<filename\> \n
Specify alternative dictionary for the block mesh description.
- \par -dict \<filename\>
Specify alternative dictionary for the block mesh description.
\*---------------------------------------------------------------------------*/
......
......@@ -28,23 +28,26 @@ Description
Checks validity of a mesh.
Usage
- checkMesh [OPTION]
\b checkMesh [OPTION]
\param -allGeometry \n
Checks all (including non finite-volume specific) geometry
Options:
- \par -allGeometry
Checks all (including non finite-volume specific) geometry
\param -allTopology \n
Checks all (including non finite-volume specific) addressing
- \par -allTopology
Checks all (including non finite-volume specific) addressing
\param -meshQuality \n
Checks against user defined (in \a system/meshQualityDict) quality settings
- \par -meshQuality
Checks against user defined (in \a system/meshQualityDict) quality
settings
\param -region \<name\> \n
Specify an alternative mesh region.
- \par -region \<name\>
Specify an alternative mesh region.
\param -writeSets \<surfaceFormat\> \n
Reconstruct all cellSets and faceSets geometry and write to postProcessing/
directory according to surfaceFormat (e.g. vtk or ensight)
- \par -writeSets \<surfaceFormat\>
Reconstruct all cellSets and faceSets geometry and write to
postProcessing directory according to surfaceFormat
(e.g. vtk or ensight)
\*---------------------------------------------------------------------------*/
......
......@@ -29,31 +29,32 @@ Description
edges.
Usage
- polyDualMesh featureAngle
\b polyDualMesh featureAngle
Detects any boundary edge > angle and creates multiple boundary faces
for it. Normal behaviour is to have each point become a cell
(1.5 behaviour)
\param -concaveMultiCells
Creates multiple cells for each point on a concave edge. Might limit
the amount of distortion on some meshes.
\param -splitAllFaces
Normally only constructs a single face between two cells. This single face
might be too distorted. splitAllFaces will create a single face for every
original cell the face passes through. The mesh will thus have
multiple faces inbetween two cells! (so is not strictly upper-triangular
anymore - checkMesh will complain)
\param -doNotPreserveFaceZones:
By default all faceZones are preserved by marking all faces, edges and
points on them as features. The -doNotPreserveFaceZones disables this
behaviour.
Note: is just a driver for meshDualiser. Substitute your own
simpleMarkFeatures to have different behaviour.
Options:
- \par -concaveMultiCells
Creates multiple cells for each point on a concave edge. Might limit
the amount of distortion on some meshes.
- \par -splitAllFaces
Normally only constructs a single face between two cells. This single
face might be too distorted. splitAllFaces will create a single face for
every original cell the face passes through. The mesh will thus have
multiple faces inbetween two cells! (so is not strictly upper-triangular
anymore - checkMesh will complain)
- \par -doNotPreserveFaceZones:
By default all faceZones are preserved by marking all faces, edges and
points on them as features. The -doNotPreserveFaceZones disables this
behaviour.
Note
It is just a driver for meshDualiser. Substitute your own simpleMarkFeatures
to have different behaviour.
\*---------------------------------------------------------------------------*/
......
......@@ -28,45 +28,55 @@ Description
Interrogates and manipulates dictionaries.
Usage
- foamDictionary [OPTION] dictionary
\b foamDictionary [OPTION] dictionary
\param -entry \<name\> \n
Selects an entry
- \par -entry \<name\>
Selects an entry
\param -keywords \<name\> \n
Prints the keywords (of the selected entry or of the top level if
no entry was selected
- \par -keywords \<name\>
Prints the keywords (of the selected entry or of the top level if
no entry was selected
\param -add \<value\> \n
Adds the entry (should not exist yet)
- \par -add \<value\>
Adds the entry (should not exist yet)
\param -set \<value\> \n
Adds or replaces the entry
- \par -set \<value\>
Adds or replaces the entry
\param -expand \n
Read the specified dictionary file, expand the macros etc. and write
the resulting dictionary to standard output.
- \par -expand
Read the specified dictionary file, expand the macros etc. and write
the resulting dictionary to standard output.
\param -includes \n
List the #include/#includeIfPresent files to standard output.
- \par -includes
List the \c #include and \c #includeIfPresent files to standard output.
Typical usage:
- change simulation to run for one timestep only:
foamDictionary system/controlDict -entry stopAt -set writeNow;
- change solver
foamDictionary system/fvSolution -entry solvers.p.solver -set PCG
- print bc type
foamDictionary 0/U -entry boundaryField.movingWall.type
- change bc parameter
foamDictionary 0/U -entry boundaryField.movingWall.value \
-set "uniform (2 0 0)"
- change whole bc type
foamDictionary 0/U -entry boundaryField.movingWall \
-set "{type uniformFixedValue; uniformValue (2 0 0);}"
- Change simulation to run for one timestep only:
\verbatim
foamDictionary system/controlDict -entry stopAt -set writeNow
\endverbatim
- Change solver:
\verbatim
foamDictionary system/fvSolution -entry solvers.p.solver -set PCG
\endverbatim
- Print bc type:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall.type
\endverbatim
- Change bc parameter:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall.value \
-set "uniform (2 0 0)"
\endverbatim
- Change whole bc type:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall \
-set "{type uniformFixedValue; uniformValue (2 0 0);}"
\endverbatim
\*---------------------------------------------------------------------------*/
......
......@@ -28,13 +28,18 @@ Description
Print the table of contents of selectable switches, classes etc. in the
OpenFOAM libraries
\par Command-line options
\param -switches \n
Usage
\b foamList [OPTION]
Options:
- \par -switches
Print the DebugSwitches, InfoSwitches and OptimisationSwitches
\param -registeredSwitches \n
- \par -registeredSwitches
Print the registered DebugSwitches, InfoSwitches and
OptimisationSwitches supporting run-time modification
\param -unset \n
- \par -unset
print switches declared in libraries but not set in etc/controlDict
\*---------------------------------------------------------------------------*/
......
......@@ -28,13 +28,14 @@ Description
List times using timeSelector.
Usage
\b foamListTimes [OPTION]
- foamListTimes [OPTION]
Options:
- \par -rm
Remove selected time directories
\param -rm \n
Remove selected time directories
\param -processor \n
List times from processor0/ directory
- \par -processor
List times from processor0/ directory
\*---------------------------------------------------------------------------*/
......
......@@ -29,46 +29,47 @@ Description
execution of OpenFOAM.
Usage
\b decomposePar [OPTION]
- decomposePar [OPTION]
Options:
- \par -cellDist
Write the cell distribution as a labelList, for use with 'manual'
decomposition method or as a volScalarField for post-processing.
\param -cellDist \n
Write the cell distribution as a labelList, for use with 'manual'
decomposition method or as a volScalarField for post-processing.
- \par -region \<regionName\> \n
Decompose named region. Does not check for existence of processor*.
\param -region regionName \n
Decompose named region. Does not check for existence of processor*.
- \par -allRegions \n
Decompose all regions in regionProperties. Does not check for
existence of processor*.
\param -allRegions \n
Decompose all regions in regionProperties. Does not check for
existence of processor*.
- \par -copyUniform \n
Copy any \a uniform directories too.
\param -copyUniform \n
Copy any \a uniform directories too.
- \par -constant
\param -constant \n
\param -time xxx:yyy \n
Override controlDict settings and decompose selected times. Does not
re-decompose the mesh i.e. does not handle moving mesh or changing
mesh cases.
- \par -time xxx:yyy \n
Override controlDict settings and decompose selected times. Does not
re-decompose the mesh i.e. does not handle moving mesh or changing
mesh cases.
\param -fields \n
Use existing geometry decomposition and convert fields only.
- \par -fields \n
Use existing geometry decomposition and convert fields only.
\param -noSets \n
Skip decomposing cellSets, faceSets, pointSets.
- \par -noSets \n
Skip decomposing cellSets, faceSets, pointSets.
\param -force \n
Remove any existing \a processor subdirectories before decomposing the
geometry.
- \par -force \n
Remove any existing \a processor subdirectories before decomposing the
geometry.
\param -ifRequired \n
Only decompose the geometry if the number of domains has changed from a
previous decomposition. No \a processor subdirectories will be removed
unless the \a -force option is also specified. This option can be used
to avoid redundant geometry decomposition (eg, in scripts), but should
be used with caution when the underlying (serial) geometry or the
decomposition method etc. have been changed between decompositions.
- \par -ifRequired \n
Only decompose the geometry if the number of domains has changed from a
previous decomposition. No \a processor subdirectories will be removed
unless the \a -force option is also specified. This option can be used
to avoid redundant geometry decomposition (eg, in scripts), but should
be used with caution when the underlying (serial) geometry or the
decomposition method etc. have been changed between decompositions.
\*---------------------------------------------------------------------------*/
......
......@@ -30,24 +30,24 @@ Description
An Ensight part is created for the internalMesh and for each patch.
Usage
- foamToEnsight [OPTION] \n
Translates OpenFOAM data to Ensight format
\b foamToEnsight [OPTION]
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
Options:
- \par -ascii
Write Ensight data in ASCII format instead of "C Binary"
\param -patches patchList \n
Specify particular patches to write.
Specifying an empty list suppresses writing the internalMesh.
- \par -patches patchList
Specify particular patches to write.
Specifying an empty list suppresses writing the internalMesh.
\param -noPatches \n
Suppress writing any patches.
- \par -noPatches
Suppress writing any patches.
\param -faceZones zoneList \n
Specify faceZones to write, with wildcards
- \par -faceZones zoneList
Specify faceZones to write, with wildcards
\param -cellZone zoneName \n
Specify single cellZone to write (not lagrangian)
- \par -cellZone zoneName
Specify single cellZone to write (not lagrangian)
Note
Parallel support for cloud data is not supported
......
......@@ -29,28 +29,28 @@ Description
An Ensight part is created for each cellZone and patch.
Usage
- foamToEnsightParts [OPTION] \n
Translates OpenFOAM data to Ensight format
\b foamToEnsightParts [OPTION]
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
Options:
- \par -ascii
Write Ensight data in ASCII format instead of "C Binary"
\param -name \<subdir\>\n
define sub-directory name to use for Ensight data (default: "Ensight")
- \par -name \<subdir\>
Define sub-directory name to use for Ensight data (default: "Ensight")
\param -noZero \n
Exclude the often incomplete initial conditions.
- \par -noZero
Exclude the often incomplete initial conditions.
\param -index \<start\>\n
Ignore the time index contained in the time file and use a
simple indexing when creating the \c Ensight/data/######## files.
- \par -index \<start\>
Ignore the time index contained in the time file and use a
simple indexing when creating the \c Ensight/data/######## files.
\param -noMesh \n
Suppress writing the geometry. Can be useful for converting partial
results for a static geometry.
- \par -noMesh
Suppress writing the geometry. Can be useful for converting partial
results for a static geometry.
\param -width \<n\>\n
width of Ensight data subdir
- \par -width \<n\>
Width of Ensight data subdir
Note
- no parallel data.
......
......@@ -28,44 +28,45 @@ Description
Tecplot binary file format writer.
Usage
\b foamToTecplot360 [OPTION]
- foamToTecplot360 [OPTION]
Options:
- \par -fields \<names\>
Convert selected fields only. For example,
\verbatim
-fields '( p T U )'
\endverbatim
The quoting is required to avoid shell expansions and to pass the
information as a single argument.
\param -fields \<names\>\n
Convert selected fields only. For example,
\verbatim
-fields '( p T U )'
\endverbatim
The quoting is required to avoid shell expansions and to pass the
information as a single argument.
- \par -cellSet \<name\>
\param -cellSet \<name\>\n
\param -faceSet \<name\>\n
Restrict conversion to the cellSet, faceSet.
- \par -faceSet \<name\>
Restrict conversion to the cellSet, faceSet.
\param -nearCellValue \n
Output cell value on patches instead of patch value itself
- \par -nearCellValue
Output cell value on patches instead of patch value itself
\param -noInternal \n
Do not generate file for mesh, only for patches
- \par -noInternal
Do not generate file for mesh, only for patches
\param -noPointValues \n
No pointFields
- \par -noPointValues
No pointFields
\param -noFaceZones \n
No faceZones
- \par -noFaceZones
No faceZones
\param -excludePatches \<patchNames\>\n
Specify patches (wildcards) to exclude. For example,
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
\endverbatim
The quoting is required to avoid shell expansions and to pass the
information as a single argument. The double quotes denote a regular
expression.
- \par -excludePatches \<patchNames\>
Specify patches (wildcards) to exclude. For example,
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
\endverbatim
The quoting is required to avoid shell expansions and to pass the
information as a single argument. The double quotes denote a regular
expression.