STYLE: add usage notes to more utilities and solvers

This commit is contained in:
Mark Olesen
2018-12-11 15:25:27 +01:00
parent ee5199cc65
commit 68ec561df8
224 changed files with 1336 additions and 238 deletions

View File

@ -28,10 +28,11 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids with phase-change
(e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based
interface capturing approach, with optional mesh motion and mesh topology
changes including adaptive re-meshing.
Solver for two incompressible, isothermal immiscible fluids with
phase-change (e.g. cavitation).
Uses VOF (volume of fluid) phase-fraction based interface capturing,
with optional mesh motion and mesh topology changes including
adaptive re-meshing.
The momentum and other fluid properties are of the "mixture" and a
single momentum equation is solved.
@ -59,6 +60,15 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, isothermal immiscible fluids with"
" phase-change.\n"
"Uses VOF (volume of fluid) phase-fraction based interface capturing,"
" with optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -28,9 +28,9 @@ Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids with phase-change
(e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based
interface capturing approach.
Solver for two incompressible, isothermal immiscible fluids with
phase-change (e.g. cavitation).
Uses VOF (volume of fluid) phase-fraction based interface capturing.
The momentum and other fluid properties are of the "mixture" and a
single momentum equation is solved.
@ -56,6 +56,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, isothermal immiscible fluids with"
" phase-change.\n"
"Uses VOF (volume of fluid) phase-fraction based interface capturing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"