zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs

Browse Source
This commit is contained in:
Henry
2011-02-08 18:22:00 +00:00
parent 5339d687a4
commit c3cb632c24
221 changed files with 1096 additions and 8800 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -30,22 +30,22 @@ Usage
- foamToEnsight [OPTION] \n
Translates OpenFOAM data to Ensight format
@param -ascii \n
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
@param -patches patchList \n
\param -patches patchList \n
Specify particular patches to write.
Specifying an empty list suppresses writing the internalMesh.
@param -noPatches \n
\param -noPatches \n
Suppress writing any patches.
@param -faceZones zoneList \n
\param -faceZones zoneList \n
Specify faceZones to write, with wildcards
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
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,23 +32,23 @@ Usage
- foamToEnsightParts [OPTION] \n
Translates OpenFOAM data to Ensight format
@param -ascii \n
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
@param -noZero \n
\param -noZero \n
Exclude the often incomplete initial conditions.
@param -index \<start\>\n
\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.
simple indexing when creating the \c Ensight/data/######## files.
@param -noMesh \n
\param -noMesh \n
Suppress writing the geometry. Can be useful for converting partial
results for a static geometry.
Note
- no parallel data.
- writes to @a Ensight directory to avoid collisions with foamToEnsight.
- writes to \a Ensight directory to avoid collisions with foamToEnsight.
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,40 +31,40 @@ Usage
- foamToTecplot360 [OPTION]
@param -fields \<names\>\n
\param -fields \<names\>\n
Convert selected fields only. For example,
@verbatim
\verbatim
-fields '( p T U )'
@endverbatim
\endverbatim
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
\param -cellSet \<name\>\n
\param -faceSet \<name\>\n
Restrict conversion to the cellSet, faceSet.
@param -nearCellValue \n
\param -nearCellValue \n
Output cell value on patches instead of patch value itself
@param -noInternal \n
\param -noInternal \n
Do not generate file for mesh, only for patches
@param -noPointValues \n
\param -noPointValues \n
No pointFields
@param -noFaceZones \n
\param -noFaceZones \n
No faceZones
@param -excludePatches \<patchNames\>\n
\param -excludePatches \<patchNames\>\n
Specify patches (wildcards) to exclude. For example,
@verbatim
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
@endverbatim
\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.
@param -useTimeName \n
\param -useTimeName \n
use the time index in the VTK file name instead of the time index
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -40,59 +40,59 @@ Usage
- foamToVTK [OPTION]
@param -ascii \n
\param -ascii \n
Write VTK data in ASCII format instead of binary.
@param -mesh \<name\>\n
\param -mesh \<name\>\n
Use a different mesh name (instead of -region)
@param -fields \<fields\>\n
\param -fields \<fields\>\n
Convert selected fields only. For example,
@verbatim
\verbatim
-fields "( p T U )"
@endverbatim
\endverbatim
The quoting is required to avoid shell expansions and to pass the
information as a single argument.
@param -surfaceFields \n
\param -surfaceFields \n
Write surfaceScalarFields (e.g., phi)
@param -cellSet \<name\>\n
@param -faceSet \<name\>\n
@param -pointSet \<name\>\n
\param -cellSet \<name\>\n
\param -faceSet \<name\>\n
\param -pointSet \<name\>\n
Restrict conversion to the cellSet, faceSet or pointSet.
@param -nearCellValue \n
\param -nearCellValue \n
Output cell value on patches instead of patch value itself
@param -noInternal \n
\param -noInternal \n
Do not generate file for mesh, only for patches
@param -noPointValues \n
\param -noPointValues \n
No pointFields
@param -noFaceZones \n
\param -noFaceZones \n
No faceZones
@param -noLinks \n
\param -noLinks \n
(in parallel) do not link processor files to master
@param poly \n
\param poly \n
write polyhedral cells without tet/pyramid decomposition
@param -allPatches \n
\param -allPatches \n
Combine all patches into a single file
@param -excludePatches \<patchNames\>\n
\param -excludePatches \<patchNames\>\n
Specify patches (wildcards) to exclude. For example,
@verbatim
\verbatim
-excludePatches '( inlet_1 inlet_2 "proc.*")'
@endverbatim
\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.
@param -useTimeName \n
\param -useTimeName \n
use the time index in the VTK file name instead of the time index
Note
@ -110,7 +110,7 @@ Note
However can have .pvd file format which refers to time simulation
if XML *.vtu files are available:
@verbatim
\verbatim
<?xml version="1.0"?>
<VTKFile type="Collection"
version="0.1"
@ -129,7 +129,7 @@ Note
<DataSet timestep="500" file="pitzDaily_11.vtu"/>
</Collection>
</VTKFile>
@endverbatim
\endverbatim
\*---------------------------------------------------------------------------*/