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

@ -44,6 +44,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Direct numerical simulation for boxes of isotropic turbulence."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -59,6 +59,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Laplace equation solver for a scalar quantity."
);
#include "addCheckCaseOptions.H"
#include "setRootCase.H"

View File

@ -60,6 +60,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Overset Laplace equation solver for a scalar quantity."
);
#include "setRootCase.H"
#include "createTime.H"

View File

@ -97,6 +97,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Overset potential flow solver which solves for the velocity potential"
);
argList::addOption
(
"pName",

View File

@ -94,6 +94,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Potential flow solver which solves for the velocity potential"
);
argList::addOption
(
"pName",

View File

@ -61,6 +61,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Passive scalar transport equation solver."
);
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
#include "createTime.H"

View File

@ -86,6 +86,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for compressible premixed/partially-premixed combustion with"
" turbulence modelling."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -71,6 +71,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for compressible premixed/partially-premixed combustion with"
" turbulence modelling."
);
#include "setRootCase.H"
#include "createTime.H"

View File

@ -67,6 +67,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for compressible premixed/partially-premixed combustion with"
" turbulence modelling."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -65,6 +65,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for compressible premixed/partially-premixed combustion with"
" turbulence modelling in internal combustion engines."
);
#define CREATE_TIME createEngineTime.H
#define CREATE_MESH createEngineMesh.H
#include "postProcess.H"

View File

@ -65,6 +65,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for compressible premixed/partially-premixed combustion with"
" turbulence modelling."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -32,7 +32,6 @@ Description
provide comparison against other chemistry solvers, that uses a single cell
mesh, and fields created from the initial conditions.
\*---------------------------------------------------------------------------*/
#include "fvCFD.H"
@ -49,6 +48,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for chemistry problems, designed for use on single cell cases"
" to provide comparison against other chemistry solvers"
);
argList::noParallel();
#define CREATE_MESH createSingleCellMesh.H

View File

@ -45,6 +45,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for cold-flow in internal combustion engines."
);
#define CREATE_TIME createEngineTime.H
#define CREATE_MESH createEngineMesh.H
#include "postProcess.H"

View File

@ -50,6 +50,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for fires and turbulent diffusion flames"
" with reacting particle clouds, surface film and pyrolysis modelling."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for combustion with chemical reactions"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCombustionSolvers
Description
Solver for combustion with chemical reactions using a density based
Solver for combustion with chemical reactions using a density-based
thermodynamics package with enhanced buoyancy treatment.
\*---------------------------------------------------------------------------*/
@ -47,6 +47,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for combustion with chemical reactions using density-based"
" thermodynamics package,"
" with enhanced buoyancy treatment."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCombustionSolvers
Description
Solver for combustion with chemical reactions using density based
Solver for combustion with chemical reactions using density-based
thermodynamics package.
\*---------------------------------------------------------------------------*/
@ -48,6 +48,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for combustion with chemical reactions using density-based"
" thermodynamics package."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,8 +28,9 @@ Group
grpCompressibleSolvers grpMovingMeshSolvers
Description
Density-based compressible flow solver based on central-upwind schemes of
Kurganov and Tadmor with support for mesh-motion and topology changes.
Density-based compressible flow solver based on central-upwind
schemes of Kurganov and Tadmor
with support for mesh-motion and topology changes.
\*---------------------------------------------------------------------------*/
@ -47,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Density-based compressible flow solver based on central-upwind"
" schemes of Kurganov and Tadmor.\n"
"With support for mesh-motion and topology changes."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -28,8 +28,8 @@ Group
grpCompressibleSolvers
Description
Density-based compressible flow solver based on central-upwind schemes of
Kurganov and Tadmor.
Density-based compressible flow solver based on central-upwind
schemes of Kurganov and Tadmor.
\*---------------------------------------------------------------------------*/
@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Density-based compressible flow solver based on central-upwind"
" schemes of Kurganov and Tadmor."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -58,6 +58,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for laminar or turbulent flow"
" of weakly compressible fluids for low Mach number"
" aeroacoustic applications."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -54,6 +54,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible turbulent flow.\n"
"With optional mesh motion and mesh topology changes."
);
#include "setRootCase.H"
#include "createTime.H"
#include "createDynamicFvMesh.H"

View File

@ -52,6 +52,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible turbulent flow.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
Overset steady-state solver for turbulent flow of compressible fluids.
Overset steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Overset steady-state solver for compressible turbulent flow"
);
#define CREATE_MESH createUpdatedDynamicFvMesh.H
#include "postProcess.H"

View File

@ -28,8 +28,8 @@ Group
grpCompressibleSolvers
Description
Steady-state solver for turbulent flow of compressible fluids, with
implicit or explicit porosity treatment and optional sources.
Steady-state solver for compressible turbulent flow,
with implicit or explicit porosity treatment and optional sources.
\*---------------------------------------------------------------------------*/
@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible turbulent flow,"
"with implicit or explicit porosity treatment and optional sources."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
Steady-state solver for turbulent flow of compressible fluids.
Steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible turbulent flow."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -45,6 +45,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, turbulent flow"
" of a compressible gas.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -43,6 +43,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, turbulent flow"
" of a compressible gas."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, laminar flow"
" of a compressible liquid."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,8 +28,8 @@ Group
grpDiscreteMethodsSolvers
Description
Direct simulation Monte Carlo (DSMC) solver for, transient, multi-species
flows.
Direct simulation Monte Carlo (DSMC) solver
for transient, multi-species flows.
\*---------------------------------------------------------------------------*/
@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Direct simulation Monte Carlo (DSMC) solver"
" for transient, multi-species flows."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -37,6 +37,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Equilibrate and/or precondition molecular dynamics systems."
);
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
#include "createTime.H"

View File

@ -39,6 +39,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Molecular dynamics solver for fluid dynamics."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -38,6 +38,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for electrostatics."
);
#include "addCheckCaseOptions.H"
#include "setRootCase.H"

View File

@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for the magnetic field generated by permanent magnets."
);
argList::addBoolOption
(
"noH",

View File

@ -58,6 +58,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for magnetohydrodynamics (MHD):"
" incompressible, laminar flow of a conducting fluid"
" under the influence of a magnetic field."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -40,6 +40,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solves the Black-Scholes equation to price commodities."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -47,6 +47,12 @@ Author
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible, laminar flow"
" of Newtonian fluids in liquid film formulation."
);
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"

View File

@ -41,6 +41,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Passive finiteArea scalar transport on a sphere"
);
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"

View File

@ -30,7 +30,7 @@ Group
grpFiniteAreaSolvers
Description
Passive scalar transport equation solver.
Passive scalar transport finiteArea equation solver.
\heading Solver details
The equation is given by:
@ -65,6 +65,11 @@ Author
int main(int argc, char *argv[])
{
argList::addNote
(
"Passive scalar transport finiteArea equation solver."
);
#include "setRootCase.H"
#include "createTime.H"
#include "createMesh.H"

View File

@ -59,6 +59,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for buoyant, turbulent flow"
" of incompressible fluids.\n"
"Uses the Boussinesq approximation."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -59,6 +59,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for buoyant, turbulent flow"
" of incompressible fluids."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for buoyant, turbulent fluid flow"
" of compressible fluids, including radiation."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -44,6 +44,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for buoyant, turbulent fluid flow"
" of compressible fluids, including radiation."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -54,6 +54,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for buoyant, turbulent fluid flow and solid heat"
" conduction with conjugate heat transfer"
" between solid and fluid regions."
);
#define NO_CONTROL
#define CREATE_MESH createMeshesPostProcess.H
#include "postProcess.H"

View File

@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for buoyant, turbulent fluid flow and solid heat"
" conduction with conjugate heat transfer"
" between solid and fluid regions."
);
#define NO_CONTROL
#define CREATE_MESH createMeshesPostProcess.H
#include "postProcess.H"

View File

@ -45,6 +45,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Solver for energy transport and thermodynamics on a frozen flow field"
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -72,6 +72,13 @@ void zeroCells
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, turbulent flow"
" of non-Newtonian fluids with duct shape optimisation"
" by applying 'blockage' in regions causing pressure loss"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,8 +28,8 @@ Group
grpIncompressibleSolvers
Description
Steady-state solver for incompressible, 1D turbulent flow, typically to
generate boundary layer conditions at an inlet.
Steady-state solver for incompressible, 1D turbulent flow,
typically to 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
@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, 1D turbulent flow,"
" typically to generate boundary layer conditions at an inlet."
);
argList::noParallel();
#include "addCheckCaseOptions.H"

View File

@ -67,6 +67,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible, laminar flow"
" of Newtonian fluids."
);
#include "addCheckCaseOptions.H"
#include "setRootCase.H"
#include "createTime.H"

View File

@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible laminar flow"
" of non-Newtonian fluids."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,8 +28,8 @@ Group
grpIncompressibleSolvers
Description
Large time-step transient solver for incompressible, turbulent flow in a
single rotating frame.
Large time-step transient solver for incompressible flow
in a single rotating frame.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Large time-step transient solver for incompressible flow"
" in a single rotating frame."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpIncompressibleSolvers grpMovingMeshSolvers
Description
Transient solver for incompressible, flow of Newtonian fluids
Transient solver for incompressible flow of Newtonian fluids
on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm.
Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
@ -54,6 +54,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible, turbulent flow"
" on a moving mesh."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -79,6 +79,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible, turbulent flow"
" of Newtonian fluids on a moving mesh."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -75,6 +75,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for incompressible, turbulent flow,"
" using the PISO algorithm."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -42,6 +42,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for inviscid shallow-water equations with rotation"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -44,6 +44,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, turbulent flow"
" of non-Newtonian fluids in a single rotating frame."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -79,6 +79,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, turbulent flow"
);
#define CREATE_MESH createUpdatedDynamicFvMesh.H
#include "postProcess.H"

View File

@ -45,6 +45,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, turbulent flow with"
"implicit/explicit porosity treatment\n"
"With MRF support."
);
#define CREATE_FIELDS_2 createPorousZones.H
#include "postProcess.H"

View File

@ -28,7 +28,7 @@ Group
grpIncompressibleSolvers
Description
Steady-state solver for incompressible flows with turbulence modelling.
Steady-state solver for incompressible, turbulent flows.
\heading Solver details
The solver uses the SIMPLE algorithm to solve the continuity equation:
@ -71,6 +71,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for incompressible, turbulent flows."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -48,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the coupled transport of a"
" single kinematic particle cloud including the effect"
" of the volume fraction of particles on the continuous phase.\n"
"With optional mesh motion and mesh topology changes."
);
argList::addOption
(
"cloudName",

View File

@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the coupled transport of a"
" single kinematic particle cloud including the effect"
" of the volume fraction of particles on the continuous phase."
);
argList::addOption
(
"cloud",

View File

@ -51,6 +51,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible, turbulent flow"
" with coal and limestone clouds, energy sources and combustion."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the passive transport"
" of a single kinematic particle cloud.\n"
"With optional mesh motion and mesh topology changes."
);
argList::addOption
(
"cloud",

View File

@ -44,6 +44,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the passive transport"
" of a single kinematic particle cloud"
);
argList::addOption
(
"cloud",

View File

@ -51,6 +51,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible, turbulent flow"
" with reacting, multiphase particle clouds"
" and surface film modelling."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -25,7 +25,7 @@ Application
simpleReactingParcelFoam
Description
Steady state solver for compressible, turbulent flow with reacting,
Steady-state solver for compressible, turbulent flow with reacting,
multiphase particle clouds and optional sources/constraints.
\*---------------------------------------------------------------------------*/
@ -54,6 +54,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible, turbulent flow"
" with reacting, multiphase particle clouds"
" and optional sources/constraints."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpLagrangianSolvers
Description
Steady state solver for compressible, turbulent flow with coal particle
Steady-state solver for compressible, turbulent flow with coal particle
clouds and optional sources/constraints.
\*---------------------------------------------------------------------------*/
@ -49,6 +49,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible, turbulent flow"
" with coal particle clouds and optional sources/constraints."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -46,6 +46,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible, turbulent engine flow"
" with a spray particle cloud."
);
#define CREATE_TIME createEngineTime.H
#define CREATE_MESH createEngineMesh.H
#include "postProcess.H"

View File

@ -49,6 +49,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible, turbulent flow"
" with a spray particle cloud.\n"
"With optional mesh motion and mesh topology changes.\n"
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -47,6 +47,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible, turbulent flow"
" with a spray particle cloud."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -41,6 +41,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the passive transport of a particle cloud"
" with optional mesh motion"
"Uses a pre-calculated velocity field to evolve the cloud."
);
argList::addOption
(
"cloudName",

View File

@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for the passive transport of a particle cloud.\n"
"Uses a pre-calculated velocity field to evolve the cloud."
);
argList::addOption
(
"cloud",

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

View File

@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient segregated finite-volume solver of linear-elastic,"
" small-strain deformation of a solid body, with optional thermal"
" diffusion and thermal stresses"
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -44,6 +44,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state segregated finite-volume solver of linear-elastic,"
" small-strain deformation of a solid body, with optional thermal"
" diffusion and thermal stresses"
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -27,7 +27,7 @@ Application
makeFaMesh
Description
Check a Finite Area mesh
Check a finiteArea mesh
Author
Zeljko Tukovic, FAMENA
@ -46,6 +46,11 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::addNote
(
"Check a finiteArea mesh"
);
#include "addRegionOption.H"
#include "setRootCase.H"

View File

@ -27,7 +27,7 @@ Application
makeFaMesh
Description
A mesh generator for finite area mesh.
A mesh generator for finiteArea mesh.
Author
Zeljko Tukovic, FAMENA
@ -69,6 +69,11 @@ public:
int main(int argc, char *argv[])
{
argList::addNote
(
"A mesh generator for finiteArea mesh"
);
#include "addRegionOption.H"
argList::noParallel();

View File

@ -614,6 +614,10 @@ label findPatch(const polyBoundaryMesh& patches, const word& patchName)
int main(int argc, char *argv[])
{
argList::addNote
(
"Mesh and field preparation utility for PDR type simulations."
);
#include "addOverwriteOption.H"
argList::noFunctionObjects(); // Never use function objects

Some files were not shown because too many files have changed in this diff Show More