zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-12-28 03:37:59 +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 b33932e1f6
commit 1319df48d9
28 changed files with 389 additions and 360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
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,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