zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-12-28 03:37:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: add usage notes to more utilities and solvers

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

9
applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C
View File

@ -25,7 +25,7 @@ Application
MPPICInterFoam
Description
Solver for 2 incompressible, isothermal immiscible fluids using a VOF
Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
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 using"
" VOF phase-fraction based interface capturing.\n"
"Includes MRF and an MPPIC cloud."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

12
applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
View File

@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Transient cavitation code based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour "mixture" is obtained,
Transient cavitation solver based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour 'mixture' is obtained,
with optional mesh motion and mesh topology changes.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@ -48,6 +48,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient cavitation solver based on the homogeneous equilibrium"
" model from which the compressibility of the liquid/vapour 'mixture'"
" is obtained.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "setRootCase.H"

10
applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
View File

@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers
Description
Transient cavitation code based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour "mixture" is obtained.
Transient cavitation solver based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour 'mixture' is obtained.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient cavitation solver based on the homogeneous equilibrium"
" model from which the compressibility of the liquid/vapour 'mixture'"
" is obtained."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

10
applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
View File

@ -25,7 +25,7 @@ Application
compressibleInterDyMFoam
Description
Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@ -54,6 +54,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two compressible, non-isothermal immiscible fluids"
" using VOF phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "setRootCase.H"

8
applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C
View File

@ -25,7 +25,7 @@ Application
compressibleInterFoam
Description
Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@ -53,6 +53,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two compressible, non-isothermal immiscible fluids"
" using VOF phase-fraction based interface capturing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

8
applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
Solver for two compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@ -56,6 +56,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two compressible, non-isothermal immiscible fluids"
" using VOF phase-fraction based interface capturing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

8
applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for n compressible, non-isothermal immiscible fluids using a VOF
Solver for N compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.
The momentum and other fluid properties are of the "mixture" and a single
@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for N compressible, non-isothermal immiscible fluids"
" using VOF phase-fraction based interface capturing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

16
applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
View File

@ -28,11 +28,11 @@ Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible fluids using the mixture approach with the
drift-flux approximation for relative motion of the phases.
Solver for two incompressible fluids using the mixture approach with
the drift-flux approximation for relative motion of the phases.
Used for simulating the settling of the dispersed phase and other similar
separation problems.
Used for simulating the settling of the dispersed phase and other
similar separation problems.
\*---------------------------------------------------------------------------*/
@ -52,6 +52,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible fluids using the mixture approach with"
" the drift-flux approximation for relative motion of the phases.\n"
"Used for simulating the settling of the dispersed phase and other"
" similar separation problems."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

11
applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for n incompressible, non-isothermal immiscible fluids with
Solver for N incompressible, non-isothermal immiscible fluids with
phase-change. Uses a VOF (volume of fluid) phase-fraction based interface
capturing approach.
@ -55,6 +55,15 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for N incompressible, non-isothermal immiscible fluids with"
" phase-change,"
" using VOF phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "setRootCase.H"

11
applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible, non-isothermal immiscible fluids with
Solver for two incompressible, non-isothermal immiscible fluids with
phase-change (evaporation-condensation) between a fluid and its vapour.
Uses a VOF (volume of fluid) phase-fraction based interface capturing
approach.
@ -56,6 +56,15 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, non-isothermal immiscible fluids with"
" phase-change,"
" using VOF phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

10
applications/solvers/multiphase/interFoam/interFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids using a VOF
Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@ -53,6 +53,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, isothermal immiscible fluids"
" using VOF phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

8
applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
View File

@ -50,6 +50,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for three incompressible fluids (two of which are immiscible)"
" using VOF phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

10
applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids using a VOF
Solver for two incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,
with optional mesh motion and mesh topology changes including adaptive
re-meshing.
@ -59,6 +59,14 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, isothermal immiscible fluids using"
" VOF phase-fraction based interface capturing\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing."
);
#include "postProcess.H"
#include "setRootCase.H"

11
applications/solvers/multiphase/interIsoFoam/interIsoFoam.C
View File

@ -31,7 +31,7 @@ Group
grpMultiphaseSolvers
Description
Solver derived from interFoam for 2 incompressible, isothermal immiscible
Solver derived from interFoam for two incompressible, isothermal immiscible
fluids using the isoAdvector phase-fraction based interface capturing
approach, with optional mesh motion and mesh topology changes including
adaptive re-meshing.
@ -66,6 +66,15 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for two incompressible, isothermal immiscible fluids"
" using isoAdvector phase-fraction based interface capturing.\n"
"With optional mesh motion and mesh topology changes including"
" adaptive re-meshing.\n"
"The solver is derived from interFoam"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

18
applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
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"

13
applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
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"

6
applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
View File

@ -48,6 +48,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for a system of many compressible fluid phases including"
" heat-transfer."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

9
applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for n incompressible fluids which captures the interfaces and
Solver for N incompressible fluids which captures the interfaces and
includes surface-tension and contact-angle effects for each phase, with
optional mesh motion and mesh topology changes.
@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for N incompressible fluids which captures the interfaces and"
" includes surface-tension and contact-angle effects for each phase.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

7
applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
View File

@ -53,6 +53,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Incompressible Navier-Stokes solver with inclusion of a wave height"
" field to enable single-phase free-surface approximations.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "setRootCase.H"

6
applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
View File

@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Incompressible Navier-Stokes solver with inclusion of a wave height"
" field to enable single-phase free-surface approximations."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

6
applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
View File

@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for a system of any number of compressible fluid phases with a"
" common pressure, but otherwise separate properties."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

8
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for a system of 2 compressible fluid phases with a common pressure,
Solver for a system of two compressible fluid phases with a common pressure,
but otherwise separate properties. The type of phase model is run time
selectable and can optionally represent multiple species and in-phase
reactions. The phase system is also run time selectable and can optionally
@ -75,6 +75,12 @@ namespace Foam
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for a system of two compressible fluid phases with a"
" common pressure, but otherwise separate properties."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

7
applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
View File

@ -28,7 +28,7 @@ Group
grpMultiphaseSolvers
Description
Solver for mixing 2 incompressible fluids.
Solver for mixing two incompressible fluids.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@ -45,6 +45,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for mixing two incompressible fluids"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

11
applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
View File

@ -28,8 +28,8 @@ Group
grpMultiphaseSolvers
Description
Solver for a system of 2 compressible fluid phases with one phase
dispersed, e.g. gas bubbles in a liquid including heat-transfer.
Solver for a system of two compressible fluid phases with one dispersed
phase. Eg, gas bubbles in a liquid including heat-transfer.
\*---------------------------------------------------------------------------*/
@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for a system of two compressible fluid phases with one"
" dispersed phase.\n"
"Eg, gas bubbles in a liquid including heat-transfer."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"