ENH: Updated header file documentation

This commit is contained in:
Andrew Heather
2017-03-21 09:40:35 +00:00
parent e9355df198
commit cbf793fca2
14 changed files with 21 additions and 18 deletions

View File

@ -32,10 +32,10 @@ Description
Reference:
\verbatim
Tenneti, S., Garg, R., & Subramaniam, S. (2011).
Drag law for monodisperse gassolid systems using particle-resolved
Drag law for monodisperse gas-solid systems using particle-resolved
direct numerical simulation of flow past fixed assemblies of spheres.
International Journal of Multiphase Flow, 37(9), 10721092.
\verbatim
International Journal of Multiphase Flow, 37(9), 1072-1092.
\endverbatim
SourceFiles
Tenneti.C

View File

@ -55,10 +55,10 @@ Usage
the resulting dictionary to standard output.
- \par -includes
List the \c #include and \c #includeIfPresent files to standard output
List the \c \#include and \c \#includeIfPresent files to standard output
- \par -disableFunctionEntries
Do not expand macros or directives (#include etc)
Do not expand macros or directives (\#include etc)
Example usage:
- Change simulation to run for one timestep only:

View File

@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namespace
ensightOutput
Foam::ensightOutput
Description
A collection of global functions for writing ensight file content.