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

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