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

STY: Adding documentation for volume sampling in regionSizeDistribution FO

Browse Source
This commit is contained in:
sergio
2016-12-05 15:07:13 -08:00
parent fc8f2ac94b
commit d6db12b549
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
View File

@ -114,8 +114,16 @@ Usage
minDiameter | minimum region equivalent diameter | no | 0 minDiameter | minimum region equivalent diameter | no | 0
setFormat | writing format | yes | setFormat | writing format | yes |
origin | origin of local co-ordinate system | yes | origin | origin of local co-ordinate system | yes |
coordinateRoation | orientation of local co-ordinate system | no | coordinateRoation | orientation of local co-ordinate system | no
log | Log to standard output | no | yes log | Log to standard output | no | yes
isoPlanes | switch for isoPlanes | no | false
origin | origin of the plane when isoPlanes is used | no | none
direction | direction of the plane when isoPlanes is used | no | none
maxDiameter | maximum diameter of the sampling cylinder when
isoPlanes is used | no | none
nDownstreamBins | number of bins when isoPlanes is used | no | none
maxDownstream | maximum distance from origin when isoPlanes is used
| no | none
\endtable \endtable
See also See also