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

ENH: Added documentation for boundary and function object helper utilities

Browse Source
This commit is contained in:
andy
2012-08-16 15:58:41 +01:00
parent 48cf4e6715
commit 8026866012
2 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H
View File

@ -25,7 +25,24 @@ Class
Foam::helpBoundary
Description
This class provides help for boundary conditions (patch fields). When no
additional arguments are given, the utility outputs all known boundary
conditions.
Usage:
\plaintable
\c -browse \<patch type\> | open documentation for patch in browser
\c -field \<name\> | boundary conditions for a given field
\c -constraint | list constraint boundary conditions
\c -fixedValue | list \c fixedValue type boundary conditions
\endplaintable
Note
To use the \c -fixedValue option, the \c -field option should also be used
SeeAlso
Foam::helkpType
Foam::fvPatchField
SourceFiles
helpBoundary.C

12
applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H
View File

@ -25,7 +25,17 @@ Class
Foam::helpFunctionObject
Description
This class provides help for functionObjects. When no additional arguments
are given, the utility outputs all known function objects.
Usage:
\plaintable
\c -browse \<patch type\> | open documentation for object in browser
\endplaintable
SeeAlso
Foam::helpType
Foam::functionObject
SourceFiles
helpFunctionObject.C