STYLE: Updated header file documentation

This commit is contained in:
Andrew Heather
2015-12-09 16:10:35 +00:00
parent 8837a89237
commit abeef3313d
14 changed files with 53 additions and 35 deletions

View File

@ -28,9 +28,10 @@ Group
grpCombustionSolvers
Description
Solver for chemistry problems
- designed for use on single cell cases to provide comparison against
other chemistry solvers
Solver for chemistry problems designed for use on single cell cases to
provide comparison against other chemistry solvers
Note:
- single cell mesh created on-the-fly
- fields created on the fly from the initial conditions

View File

@ -29,11 +29,12 @@ Group
Description
Combination of heatConductionFoam and buoyantFoam for conjugate heat
transfer between solid regions and fluid regions. Both regions include
the fvOptions framework.
transfer between solid regions and fluid regions.
It handles secondary fluid or solid circuits which can be coupled
thermally with the main fluid region. i.e radiators, etc.
Note:
- Both regions support the fvOptions framework.
- It handles secondary fluid or solid circuits which can be coupled
thermally with the main fluid region. i.e radiators, etc.
\*---------------------------------------------------------------------------*/

View File

@ -29,7 +29,7 @@ Group
Description
Steady-state solver for incompressible, 1D turbulent flow, typically to
generate boundary layer conditions at an inlet, for use in a simulation.
generate boundary layer conditions at an inlet.
Boundary layer code to calculate the U, k and epsilon distributions.
Used to create inlet boundary conditions for experimental comparisons

View File

@ -28,13 +28,12 @@ Group
grpLagrangianSolvers
Description
Transient solver for:
- compressible,
- turbulent flow,
with
- coal and limestone parcel injections,
- energy source, and
- combustion.
Transient PIMPLE solver for compressible, laminar or turbulent flow with
coal and thermodynamic parcels, and combustion.
Note:
- includes run-time selectable finite volume options, e.g. sources,
constraints
\*---------------------------------------------------------------------------*/

View File

@ -29,8 +29,11 @@ Group
Description
Transient PIMPLE solver for compressible, laminar or turbulent flow with
reacting multiphase Lagrangian parcels, including run-time selectable
finite volume options, e.g. sources, constraints
reacting multiphase Lagrangian parcels.
Note:
- includes run-time selectable finite volume options, e.g. sources,
constraints
\*---------------------------------------------------------------------------*/