zhyang-dev/OpenFOAM-6
1
0
Fork 0
mirror of https://github.com/OpenFOAM/OpenFOAM-6.git synced 2025-12-08 06:57:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rationalized Doxygen documentation of command-line options

Browse Source
This commit is contained in:
Henry Weller
2016-06-17 09:11:58 +01:00
parent 0b333a4249
commit 7b75d81269
28 changed files with 389 additions and 360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
View File

@ -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,13 +28,13 @@ 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
Options:
- \par -noBnd
Suppress writing the \c .bnd file
\param -scale \<factor\>\n
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
The default is \b 1000 (scale \em [m] to \em [mm]).

12
applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
View File

@ -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,14 +28,14 @@ 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
Options:
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
Eg, use \b 1000 to scale \em [m] to \em [mm].
E.g. use \b 1000 to scale \em [m] to \em [mm].
\param -tri \n
- \par -tri
Triangulate surface.
\*---------------------------------------------------------------------------*/

14
applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
View File

@ -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
Options:
- \par -ascii
Write in ASCII format instead of binary
\param -scale \<factor\>\n
- \par -scale \<factor\>
Specify an alternative geometry scaling factor.
The default is \b 0.001 (scale \em [mm] to \em [m]).
\param -solids \n
- \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
\*---------------------------------------------------------------------------*/

2
applications/utilities/mesh/generation/blockMesh/Make/files
View File

@ -1,3 +1,3 @@
blockMeshApp.C
blockMesh.C
EXE = $(FOAM_APPBIN)/blockMesh

18
applications/utilities/mesh/generation/blockMesh/blockMeshApp.C → applications/utilities/mesh/generation/blockMesh/blockMesh.C
View File

@ -28,22 +28,22 @@ 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]
\param -blockTopology \n
Options:
- \par -blockTopology
Write the topology as a set of edges in OBJ format.
\param -region \<name\> \n
- \par -region \<name\>
Specify an alternative mesh region.
\param -dict \<filename\> \n
- \par -dict \<filename\>
Specify alternative dictionary for the block mesh description.
\*---------------------------------------------------------------------------*/

21
applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
View File

@ -28,23 +28,26 @@ Description
Checks validity of a mesh.
Usage
- checkMesh [OPTION]
\b checkMesh [OPTION]
\param -allGeometry \n
Options:
- \par -allGeometry
Checks all (including non finite-volume specific) geometry
\param -allTopology \n
- \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
- \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)
\*---------------------------------------------------------------------------*/

21
applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
View File

@ -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
Options:
- \par -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
- \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)
\param -doNotPreserveFaceZones:
- \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: is just a driver for meshDualiser. Substitute your own
simpleMarkFeatures to have different behaviour.
Note
It is just a driver for meshDualiser. Substitute your own simpleMarkFeatures
to have different behaviour.
\*---------------------------------------------------------------------------*/

38
applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
View File

@ -28,45 +28,55 @@ Description
Interrogates and manipulates dictionaries.
Usage
- foamDictionary [OPTION] dictionary
\b foamDictionary [OPTION] dictionary
\param -entry \<name\> \n
- \par -entry \<name\>
Selects an entry
\param -keywords \<name\> \n
- \par -keywords \<name\>
Prints the keywords (of the selected entry or of the top level if
no entry was selected
\param -add \<value\> \n
- \par -add \<value\>
Adds the entry (should not exist yet)
\param -set \<value\> \n
- \par -set \<value\>
Adds or replaces the entry
\param -expand \n
- \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 simulation to run for one timestep only:
\verbatim
foamDictionary system/controlDict -entry stopAt -set writeNow
\endverbatim
- change solver
- Change solver:
\verbatim
foamDictionary system/fvSolution -entry solvers.p.solver -set PCG
\endverbatim
- print bc type
- Print bc type:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall.type
\endverbatim
- change bc parameter
- Change bc parameter:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall.value \
-set "uniform (2 0 0)"
\endverbatim
- change whole bc type
- Change whole bc type:
\verbatim
foamDictionary 0/U -entry boundaryField.movingWall \
-set "{type uniformFixedValue; uniformValue (2 0 0);}"
\endverbatim
\*---------------------------------------------------------------------------*/

13
applications/utilities/miscellaneous/foamList/foamList.C
View File

@ -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
\*---------------------------------------------------------------------------*/

9
applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
View File

@ -28,12 +28,13 @@ Description
List times using timeSelector.
Usage
\b foamListTimes [OPTION]
- foamListTimes [OPTION]
\param -rm \n
Options:
- \par -rm
Remove selected time directories
\param -processor \n
- \par -processor
List times from processor0/ directory
\*---------------------------------------------------------------------------*/

25
applications/utilities/parallelProcessing/decomposePar/decomposePar.C
View File

@ -29,40 +29,41 @@ Description
execution of OpenFOAM.
Usage
\b decomposePar [OPTION]
- decomposePar [OPTION]
\param -cellDist \n
Options:
- \par -cellDist
Write the cell distribution as a labelList, for use with 'manual'
decomposition method or as a volScalarField for post-processing.
\param -region regionName \n
- \par -region \<regionName\> \n
Decompose named region. Does not check for existence of processor*.
\param -allRegions \n
- \par -allRegions \n
Decompose all regions in regionProperties. Does not check for
existence of processor*.
\param -copyUniform \n
- \par -copyUniform \n
Copy any \a uniform directories too.
\param -constant \n
\param -time xxx:yyy \n
- \par -constant
- \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
- \par -fields \n
Use existing geometry decomposition and convert fields only.
\param -noSets \n
- \par -noSets \n
Skip decomposing cellSets, faceSets, pointSets.
\param -force \n
- \par -force \n
Remove any existing \a processor subdirectories before decomposing the
geometry.
\param -ifRequired \n
- \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

14
applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
View File

@ -30,23 +30,23 @@ 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
Options:
- \par -ascii
Write Ensight data in ASCII format instead of "C Binary"
\param -patches patchList \n
- \par -patches patchList
Specify particular patches to write.
Specifying an empty list suppresses writing the internalMesh.
\param -noPatches \n
- \par -noPatches
Suppress writing any patches.
\param -faceZones zoneList \n
- \par -faceZones zoneList
Specify faceZones to write, with wildcards
\param -cellZone zoneName \n
- \par -cellZone zoneName
Specify single cellZone to write (not lagrangian)
Note

20
applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
View File

@ -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
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
- \par -noZero
Exclude the often incomplete initial conditions.
\param -index \<start\>\n
- \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
- \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.

23
applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
View File

@ -28,10 +28,10 @@ Description
Tecplot binary file format writer.
Usage
\b foamToTecplot360 [OPTION]
- foamToTecplot360 [OPTION]
\param -fields \<names\>\n
Options:
- \par -fields \<names\>
Convert selected fields only. For example,
\verbatim
-fields '( p T U )'
@ -39,23 +39,24 @@ Usage
The quoting is required to avoid shell expansions and to pass the
information as a single argument.
\param -cellSet \<name\>\n
\param -faceSet \<name\>\n
- \par -cellSet \<name\>
- \par -faceSet \<name\>
Restrict conversion to the cellSet, faceSet.
\param -nearCellValue \n
- \par -nearCellValue
Output cell value on patches instead of patch value itself
\param -noInternal \n
- \par -noInternal
Do not generate file for mesh, only for patches
\param -noPointValues \n
- \par -noPointValues
No pointFields
\param -noFaceZones \n
- \par -noFaceZones
No faceZones
\param -excludePatches \<patchNames\>\n
- \par -excludePatches \<patchNames\>
Specify patches (wildcards) to exclude. For example,
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
@ -64,7 +65,7 @@ Usage
information as a single argument. The double quotes denote a regular
expression.
\param -useTimeName \n
- \par -useTimeName
use the time index in the VTK file name instead of the time index
\*---------------------------------------------------------------------------*/

39
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
View File

@ -37,16 +37,16 @@ Description
handled by vtk.
Usage
\b foamToVTK [OPTION]
- foamToVTK [OPTION]
\param -ascii \n
Options:
- \par -ascii
Write VTK data in ASCII format instead of binary.
\param -mesh \<name\>\n
- \par -mesh \<name\>
Use a different mesh name (instead of -region)
\param -fields \<fields\>\n
- \par -fields \<fields\>
Convert selected fields only. For example,
\verbatim
-fields "( p T U )"
@ -54,36 +54,37 @@ Usage
The quoting is required to avoid shell expansions and to pass the
information as a single argument.
\param -surfaceFields \n
- \par -surfaceFields
Write surfaceScalarFields (e.g., phi)
\param -cellSet \<name\>\n
\param -faceSet \<name\>\n
\param -pointSet \<name\>\n
- \par -cellSet \<name\>
- \par -faceSet \<name\>
- \par -pointSet \<name\>
Restrict conversion to the cellSet, faceSet or pointSet.
\param -nearCellValue \n
- \par -nearCellValue
Output cell value on patches instead of patch value itself
\param -noInternal \n
- \par -noInternal
Do not generate file for mesh, only for patches
\param -noPointValues \n
- \par -noPointValues
No pointFields
\param -noFaceZones \n
- \par -noFaceZones
No faceZones
\param -noLinks \n
- \par -noLinks
(in parallel) do not link processor files to master
\param poly \n
- \par poly
write polyhedral cells without tet/pyramid decomposition
\param -allPatches \n
- \par -allPatches
Combine all patches into a single file
\param -excludePatches \<patchNames\>\n
- \par -excludePatches \<patchNames\>
Specify patches (wildcards) to exclude. For example,
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
@ -92,7 +93,7 @@ Usage
information as a single argument. The double quotes denote a regular
expression.
\param -useTimeName \n
- \par -useTimeName
use the time index in the VTK file name instead of the time index
Note
@ -105,7 +106,7 @@ Note
whole-mesh values onto the subset patch.
Note
new file format: \n
\par new file format:
no automatic timestep recognition.
However can have .pvd file format which refers to time simulation
if XML *.vtu files are available:

12
applications/utilities/preProcessing/changeDictionary/changeDictionary.C
View File

@ -52,20 +52,20 @@ Description
Replacement entries starting with '~' will remove the entry.
Usage
\b changeDictionary [OPTION]
changeDictionary [OPTION]
\param -subDict \n
Options:
- \par -subDict
Specify the subDict name of the replacements dictionary.
\param -literalRE \n
- \par -literalRE
Do not interpret regular expressions or patchGroups; treat them as any
other keyword.
\param -enableFunctionEntries \n
- \par -enableFunctionEntries
Enable function entries (default: disabled)
\param -disablePatchGroups \n
- \par -disablePatchGroups
Disable the default checking for keys being patchGroups
\*---------------------------------------------------------------------------*/

8
applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
View File

@ -28,13 +28,13 @@ Description
Tool to upgrade mesh and fields for split cyclics.
Usage
\b foamUpgradeCyclics [OPTION]
- foamUpgradeCyclics [OPTION]
\param -test \n
Options:
- \par -test
Suppress writing the updated files with split cyclics
\param -enableFunctionEntries \n
- \par -enableFunctionEntries
By default all dictionary preprocessing of fields is disabled
\*---------------------------------------------------------------------------*/

11
applications/utilities/surface/surfaceConvert/surfaceConvert.C
View File

@ -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,16 @@ Description
Converts from one surface mesh format to another.
Usage
- surfaceConvert inputFile outputFile [OPTION]
\b surfaceConvert inputFile outputFile [OPTION]
\param -clean \n
Options:
- \par -clean
Perform some surface checking/cleanup on the input surface
\param -scale \<scale\> \n
- \par -scale \<scale\>
Specify a scaling factor for writing the files
\param -group \n
- \par -group
Orders faces by region
Note

17
applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
View File

@ -29,27 +29,28 @@ Description
transformations (rotate/translate) on a coordinateSystem.
Usage
- surfaceMeshConvert inputFile outputFile [OPTION]
\b surfaceMeshConvert inputFile outputFile [OPTION]
\param -clean \n
Options:
- \par -clean
Perform some surface checking/cleanup on the input surface.
\param -scaleIn \<scale\> \n
- \par -scaleIn \<scale\>
Specify a scaling factor when reading files.
\param -scaleOut \<scale\> \n
- \par -scaleOut \<scale\>
Specify a scaling factor when writing files.
\param -dict \<dictionary\> \n
- \par -dict \<dictionary\>
Specify an alternative dictionary for constant/coordinateSystems.
\param -from \<coordinateSystem\> \n
- \par -from \<coordinateSystem\>
Specify a coordinate System when reading files.
\param -to \<coordinateSystem\> \n
- \par -to \<coordinateSystem\>
Specify a coordinate System when writing files.
\param -tri \n
- \par -tri
Triangulate surface.
Note

15
applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
View File

@ -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
@ -29,21 +29,22 @@ Description
used for testing functionality.
Usage
- surfaceMeshConvertTesting inputFile outputFile [OPTION]
\b surfaceMeshConvertTesting inputFile outputFile [OPTION]
\param -clean \n
Options:
- \par -clean
Perform some surface checking/cleanup on the input surface
\param -orient \n
- \par -orient
Check face orientation on the input surface
\param -scale \<scale\> \n
- \par -scale \<scale\>
Specify a scaling factor for writing the files
\param -triSurface \n
- \par -triSurface
Use triSurface library for input/output
\param -keyed \n
- \par -keyed
Use keyedSurface for input/output
Note

19
applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
View File

@ -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
@ -30,27 +30,28 @@ Description
coordinateSystem.
Usage
- surfaceMeshExport outputFile [OPTION]
\b surfaceMeshExport outputFile [OPTION]
\param -clean \n
Options:
- \par -clean
Perform some surface checking/cleanup on the input surface.
\param -name \<name\> \n
- \par -name \<name\>
Specify an alternative surface name when writing.
\param -scaleIn \<scale\> \n
- \par -scaleIn \<scale\>
Specify a scaling factor when reading files.
\param -scaleOut \<scale\> \n
- \par -scaleOut \<scale\>
Specify a scaling factor when writing files.
\param -dict \<dictionary\> \n
- \par -dict \<dictionary\>
Specify an alternative dictionary for constant/coordinateSystems.
\param -from \<coordinateSystem\> \n
- \par -from \<coordinateSystem\>
Specify a coordinate system when reading files.
\param -to \<coordinateSystem\> \n
- \par -to \<coordinateSystem\>
Specify a coordinate system when writing files.
Note

19
applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
View File

@ -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
@ -30,27 +30,28 @@ Description
on a coordinateSystem.
Usage
- surfaceMeshImport inputFile [OPTION]
\b surfaceMeshImport inputFile [OPTION]
\param -clean \n
Options:
- \par -clean \n
Perform some surface checking/cleanup on the input surface.
\param -name \<name\> \n
- \par -name \<name\> \n
Specify an alternative surface name when writing.
\param -scaleIn \<scale\> \n
- \par -scaleIn \<scale\> \n
Specify a scaling factor when reading files.
\param -scaleOut \<scale\> \n
- \par -scaleOut \<scale\> \n
Specify a scaling factor when writing files.
\param -dict \<dictionary\> \n
- \par -dict \<dictionary\> \n
Specify an alternative dictionary for constant/coordinateSystems.
\param -from \<coordinateSystem\> \n
- \par -from \<coordinateSystem\> \n
Specify a coordinate system when reading files.
\param -to \<coordinateSystem\> \n
- \par -to \<coordinateSystem\> \n
Specify a coordinate system when writing files.
Note

9
applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
View File

@ -28,15 +28,16 @@ Description
Miscellaneous information about surface meshes.
Usage
- surfaceMeshInfo surfaceFile [OPTION]
\b surfaceMeshInfo surfaceFile [OPTION]
\param -areas \n
Options:
- \par -areas
Report area for each face.
\param -scale \<scale\> \n
- \par -scale \<scale\>
Specify a scaling factor when reading files.
\param -xml \n
- \par -xml
Write output in XML format.
Note

10
src/OSspecific/POSIX/signals/sigFpe.H
View File

@ -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,10 +28,10 @@ Description
Set up trapping for floating point exceptions (signal FPE).
Controlled by two env vars:
\param FOAM_SIGFPE \n
exception trapping
\param FOAM_SETNAN \n
initialization of all malloced memory to NaN. If FOAM_SIGFPE
- \par FOAM_SIGFPE
Exception trapping
- \par FOAM_SETNAN
Initialization of all malloced memory to NaN. If FOAM_SIGFPE
also set, this will cause usage of uninitialized scalars to trigger
an abort.

14
src/OpenFOAM/db/IOobject/IOobject.H
View File

@ -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
@ -36,29 +36,29 @@ Description
\par Read options
Define what is done on object construction and explicit reads:
\param MUST_READ
- \par MUST_READ
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read.
Does not check timestamp or re-read.
\param MUST_READ_IF_MODIFIED
- \par MUST_READ_IF_MODIFIED
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read. If object is
registered its timestamp will be checked every timestep and possibly
re-read.
\param READ_IF_PRESENT
- \par READ_IF_PRESENT
Read object from Istream if Istream exists, otherwise don't. \n
Error only if Istream exists but can't be read.
Does not check timestamp or re-read.
\param NO_READ
- \par NO_READ
Don't read
\par Write options
Define what is done on object destruction and explicit writes:
\param AUTO_WRITE
- \par AUTO_WRITE
Object is written automatically when requested to by the
objectRegistry.
\param NO_WRITE
- \par NO_WRITE
No automatic write on destruction but can be written explicitly
SourceFiles

14
src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,12 +34,12 @@ Description
\endverbatim
The possible input modes:
\param merge merge sub-dictionaries when possible
\param overwrite keep last entry and silently remove previous ones
\param protect keep initial entry and silently ignore subsequent ones
\param warn keep initial entry and warn about subsequent ones
\param error issue a FatalError for duplicate entries
\param default currently identical to merge
- \par merge merge sub-dictionaries when possible
- \par overwrite keep last entry and silently remove previous ones
- \par protect keep initial entry and silently ignore subsequent ones
- \par warn keep initial entry and warn about subsequent ones
- \par error issue a FatalError for duplicate entries
- \par default currently identical to merge
SourceFiles
inputModeEntry.C

22
src/OpenFOAM/global/argList/argList.H
View File

@ -39,17 +39,17 @@ Description
\endverbatim
The backslash-escaping is required to avoid interpretation by the shell.
\par Default command-line options
\param -case \<dir\> \n
select a case directory instead of the current working directory
\param -parallel \n
specify case as a parallel job
\param -doc \n
display the documentation in browser
\param -srcDoc \n
display the source documentation in browser
\param -help \n
print the usage
Default command-line options:
- \par -case \<dir\>
Select a case directory instead of the current working directory
- \par -parallel
Specify case as a parallel job
- \par -doc
Display the documentation in browser
- \par -srcDoc
Display the source documentation in browser
- \par -help
Print the usage
The environment variable \b FOAM_CASE is set to the path of the
global case (same for serial and parallel jobs).

2
src/meshTools/coordinateSystems/coordinateSystem.H
View File

@ -286,7 +286,7 @@ public:
}
//- Return as dictionary of entries
// \param [in] ignoreType drop type (cartesian, cylindrical, etc)
// \param[in] ignoreType drop type (cartesian, cylindrical, etc)
// when generating the dictionary
virtual dictionary dict(bool ignoreType=false) const;