ENH: forces, forceCoeffs: updated header documentation

This commit is contained in:
andy
2013-11-19 13:52:53 +00:00
parent 34980ec7d7
commit 50c1360e79
2 changed files with 32 additions and 12 deletions

View File

@ -46,10 +46,14 @@ Description
pitchAxis (0 0 1);
magUInf 100;
lRef 3.5;
ARef 2.2;
nBin 20;
binDir (1 0 0);
binFormat gnuplot;
Aref 2.2;
binData
{
nBin 20;
direction (1 0 0);
cumulative yes;
}
}
\endverbatim
@ -64,10 +68,15 @@ Description
pitchAxis | picth axis | yes |
magUInf | free stream velocity magnitude | yes |
lRef | reference length scale for moment calculations | yes |
ARef | reference area | yes |
nBin | number of data bins | no |
binDir | direction along which bins are defined | no |
binFormat | output format for bin data | no |
Aref | reference area | yes |
\endtable
Bin data is optional, but if the dictionary is present, the entries must
be defined according o
\table
nBin | number of data bins | yes |
direction | direction along which bins are defined | yes |
cumulative | bin data accumulated with incresing distance | yes |
\endtable
SeeAlso

View File

@ -44,8 +44,13 @@ Description
...
log yes;
patches (walls);
nBin 20;
binDir (1 0 0);
binData
{
nBin 20;
direction (1 0 0);
cumulative yes;
}
}
\endverbatim
@ -55,8 +60,6 @@ Description
type | type name: forces | yes |
log | write force data to standard output | no | no
patches | patches included in the forces calculation | yes |
nBin | number of data bins | no |
binDir | direction along which bins are defined | no |
pName | pressure field name | no | p
UName | velocity field name | no | U
rhoName | density field name (see below) | no | rho
@ -65,6 +68,14 @@ Description
fDName | name of force density field (see below) | no | fD
\endtable
Bin data is optional, but if the dictionary is present, the entries must
be defined according o
\table
nBin | number of data bins | yes |
direction | direction along which bins are defined | yes |
cumulative | bin data accumulated with incresing distance | yes |
\endtable
Note
- For incompressible cases, set \c rhoName to \c rhoInf. You will then be
required to provide a \c rhoInf value corresponding to the free-stream