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

STYLE: add usage notes to more utilities and solvers

Browse Source
This commit is contained in:
Mark Olesen
2018-12-11 15:25:27 +01:00
parent ee5199cc65
commit 68ec561df8
224 changed files with 1336 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C
View File

@ -81,8 +81,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
"Extract force/moment information from existing calculations based "
"on the lumpedPoints pressure zones."
"Extract force/moment information from existing calculations based"
" on the lumpedPoints pressure zones."
);
argList::addBoolOption

5
applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C
View File

@ -27,6 +27,7 @@ Application
Description
This utility can be used to produce VTK files to visualize the response
points/rotations and the corresponding movement of the building surfaces.
Uses the tabulated responses from the specified file.
Optionally, it can also be used to a dummy responder for the
externalFileCoupler logic, which makes it useful as a debugging facility
@ -52,8 +53,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
"Visualize lumpedPoint movements or provide a slave responder "
"for diagnostic purposes."
"Visualize lumpedPoint movements or provide a slave responder"
" for diagnostic purposes."
);
argList::noParallel();

6
applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C
View File

@ -25,7 +25,7 @@ Application
lumpedPointZones
Description
Produces a VTK PolyData file \c lumpedPointZones.vtp in which the
Produce a VTK PolyData file \c lumpedPointZones.vtp in which the
segmentation of the pressure integration zones can be visualized
for diagnostic purposes. Does not use external coupling.
@ -46,8 +46,8 @@ int main(int argc, char *argv[])
{
argList::addNote
(
"Create lumpedPointZones.vtp to verify the segmentation of "
"pressure integration zones used by lumpedPoint BC."
"Create lumpedPointZones.vtp to verify the segmentation of"
" pressure integration zones used by lumpedPoint BC."
);
argList::noParallel(); // The VTP writer is not yet in parallel