mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: minor adjustments to doxygen comments
This commit is contained in:
@ -34,7 +34,6 @@ Description
|
||||
|
||||
Usage
|
||||
\b foamToEnsight [OPTION]
|
||||
Translates OpenFOAM data to EnSight format
|
||||
|
||||
Options:
|
||||
- \par -ascii
|
||||
@ -43,29 +42,28 @@ Usage
|
||||
- \par -noZero
|
||||
Exclude the often incomplete initial conditions.
|
||||
|
||||
- \par -noLagrangian \n
|
||||
- \par -noLagrangian
|
||||
Suppress writing lagrangian positions and fields.
|
||||
|
||||
- \par -noPatches
|
||||
Suppress writing any patches.
|
||||
|
||||
- \par -patches patchList \n
|
||||
- \par -patches patchList
|
||||
Specify particular patches to write.
|
||||
Specifying an empty list suppresses writing the internalMesh.
|
||||
|
||||
- \par -faceZones zoneList \n
|
||||
- \par -faceZones zoneList
|
||||
Specify faceZones to write, with wildcards
|
||||
|
||||
- \par -cellZone zoneName
|
||||
Specify single cellZone to write (not lagrangian)
|
||||
|
||||
- \par -width \<n\>\n
|
||||
- \par -width \<n\>
|
||||
Width of EnSight data subdir (default: 8)
|
||||
|
||||
Note
|
||||
Parallel support for cloud data is not supported
|
||||
- writes to \a EnSight directory to avoid collisions with
|
||||
foamToEnsightParts
|
||||
Writes to \a EnSight directory to avoid collisions with
|
||||
foamToEnsightParts
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -48,10 +48,10 @@ Usage
|
||||
Ignore the time index contained in the time file and use a
|
||||
simple indexing when creating the \c Ensight/data/######## files.
|
||||
|
||||
- \par -noLagrangian \n
|
||||
- \par -noLagrangian
|
||||
Suppress writing lagrangian positions and fields.
|
||||
|
||||
- \par -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.
|
||||
|
||||
|
||||
@ -72,10 +72,10 @@ Usage
|
||||
- \par -noInternal
|
||||
Do not generate file for mesh, only for patches
|
||||
|
||||
- \par -noLagrangian \n
|
||||
- \par -noLagrangian
|
||||
Suppress writing lagrangian positions and fields.
|
||||
|
||||
- \par -noPointValues \n
|
||||
- \par -noPointValues
|
||||
No pointFields
|
||||
|
||||
- \par -noFaceZones
|
||||
|
||||
Reference in New Issue
Block a user