STYLE: Updated header documentation

This commit is contained in:
Andrew Heather
2019-06-19 11:32:53 +01:00
parent c901f9bc7f
commit 3f955cac07
2 changed files with 2 additions and 1 deletions

View File

@ -96,6 +96,7 @@ Usage
writeFields | Write force,moment coefficient fields | no | no writeFields | Write force,moment coefficient fields | no | no
patches | Patches included in the forces calculation | yes | patches | Patches included in the forces calculation | yes |
magUInf | Free stream velocity magnitude | yes | magUInf | Free stream velocity magnitude | yes |
rhoInf | Free stream density | for compressible cases |
lRef | Reference length scale for moment calculations | yes | lRef | Reference length scale for moment calculations | yes |
Aref | Reference area | yes | Aref | Reference area | yes |
porosity | Include porosity contributions | no | false porosity | Include porosity contributions | no | false

View File

@ -48,7 +48,7 @@ Usage
p_rgh | Name of p_rgh field | no | p_rgh p_rgh | Name of p_rgh field | no | p_rgh
ph_rgh | Name of ph_rgh field | no | ph_rgh ph_rgh | Name of ph_rgh field | no | ph_rgh
pRef | Name of pressure ref field | no | pRef pRef | Name of pressure ref field | no | pRef
pRefValue | Value of pressure ref when pRef set to pInf | no | 0 pRefValue | Value of pressure ref | when pRef set to pInf | 0
rho | Name of density field | no | rho rho | Name of density field | no | rho
U | Name of velocity field | no | U U | Name of velocity field | no | U
gh | Name of gravity*height volume field | no | gh gh | Name of gravity*height volume field | no | gh