Modified Description entries for documenting purposes

2025-11-28 03:28:01 +00:00 · 2009-07-22 14:08:02 +01:00
parent e3710c2b66
commit 2f3016173e
19 changed files with 48 additions and 29 deletions
--- a/applications/solvers/combustion/PDRFoam/PDRFoam.C
+++ b/applications/solvers/combustion/PDRFoam/PDRFoam.C
@ -26,8 +26,8 @@ Application
    PDRFoam

 Description
-    Compressible premixed/partially-premixed combustion solver with turbulence
-    modelling.
+    Solver for compressible premixed/partially-premixed combustion with
+    turbulence modelling.

    Combusting RANS code using the b-Xi two-equation model.
    Xi may be obtained by either the solution of the Xi transport
--- a/applications/solvers/combustion/XiFoam/XiFoam.C
+++ b/applications/solvers/combustion/XiFoam/XiFoam.C
@ -26,8 +26,8 @@ Application
    XiFoam

 Description
-    Compressible premixed/partially-premixed combustion solver with turbulence
-    modelling.
+    Solver for compressible premixed/partially-premixed combustion with
+    turbulence modelling.

    Combusting RANS code using the b-Xi two-equation model.
    Xi may be obtained by either the solution of the Xi transport
--- a/applications/solvers/combustion/dieselEngineFoam/dieselEngineFoam.C
+++ b/applications/solvers/combustion/dieselEngineFoam/dieselEngineFoam.C
@ -26,7 +26,7 @@ Application
    dieselFoam

 Description
-    Diesel engine spray and combustion code.
+    Solver for diesel engine spray and combustion.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/combustion/dieselFoam/dieselFoam.C
+++ b/applications/solvers/combustion/dieselFoam/dieselFoam.C
@ -26,7 +26,7 @@ Application
    dieselFoam

 Description
-    Diesel spray and combustion code.
+    Solver for diesel spray and combustion.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/combustion/reactingFoam/reactingFoam.C
+++ b/applications/solvers/combustion/reactingFoam/reactingFoam.C
@ -26,7 +26,7 @@ Application
    reactingFoam

 Description
-    Chemical reaction code.
+    Solver for combustion with chemical reactions.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/combustion/rhoReactingFoam/rhoReactingFoam.C
+++ b/applications/solvers/combustion/rhoReactingFoam/rhoReactingFoam.C
@ -26,7 +26,8 @@ Application
    rhoReactingFoam

 Description
-    Chemical reaction code using density based thermodynamics package.
+    Solver for combustion with chemical reactions using density based
+    thermodynamics package.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
+++ b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
@ -26,7 +26,8 @@ Application
    dsmcFoam

 Description
-    Direct Simulation Monte Carlo Solver for 3D, transient, multi-species flows
+    Direct simulation Monte Carlo (DSMC) solver for 3D, transient, multi-
+    species flows

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
@ -26,7 +26,7 @@ Application
    mdEquilibrationFoam

 Description
-    Equilibrates and/or preconditions MD systems
+    Equilibrates and/or preconditions molecular dynamics systems

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
@ -26,7 +26,7 @@ Application
    mdFoam

 Description
-    molecular dynamics solver for fluid dynamics
+    Molecular dynamics solver for fluid dynamics

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/heatTransfer/buoyantPisoFoam/buoyantPisoFoam.C
+++ b/applications/solvers/heatTransfer/buoyantPisoFoam/buoyantPisoFoam.C
@ -26,9 +26,11 @@ Application
    buoyantPisoFoam

 Description
-    Transient Solver for buoyant, turbulent flow of compressible fluids for
-    ventilation and heat-transfer. Turbulence is modelled using a run-time
-    selectable compressible RAS or LES model.
+    Transient solver for buoyant, turbulent flow of compressible fluids for
+    ventilation and heat-transfer.
+
+    Turbulence is modelled using a run-time selectable compressible RAS or
+    LES model.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
+++ b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
@ -27,6 +27,7 @@ Application

 Description
    Transient solver for inviscid shallow-water equations with rotation.
+
    If the geometry is 3D then it is assumed to be one layers of cells and the
    component of the velocity normal to gravity is removed.

--- a/applications/solvers/lagrangian/porousExplicitSourceReactingParcelFoam/porousExplicitSourceReactingParcelFoam.C
+++ b/applications/solvers/lagrangian/porousExplicitSourceReactingParcelFoam/porousExplicitSourceReactingParcelFoam.C
@ -26,13 +26,17 @@ Application
    porousExplicitSourceReactingParcelFoam

 Description
+    Transient PISO solver for compressible, laminar or turbulent flow with
+    reacting Lagrangian parcels for porous media, including explicit sources
+
+    The solver includes:
    - reacting parcel cloud
    - porous media
    - point mass sources
    - polynomial based, incompressible thermodynamics (f(T))

    Note: ddtPhiCorr not used here when porous zones are active
-    - not well defined for porous calcs
+    - not well defined for porous calculations

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
+++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
@ -23,11 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Application
-    kinematicParcelFoam
+    uncoupledKinematicParcelFoam

 Description
-    Transient solver for a single kinematicCloud. Uses pre-calculated velocity
-    field to evolve a cloud.
+    Transient solver for the passive transport of a single kinematic
+    particle could.
+
+    Uses a pre- calculated velocity field to evolve the cloud.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/multiphase/compressibleInterDyMFoam/compressibleInterDyMFoam.C
+++ b/applications/solvers/multiphase/compressibleInterDyMFoam/compressibleInterDyMFoam.C
@ -27,11 +27,13 @@ Application

 Description
    Solver for 2 compressible, 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.
+    (volume of fluid) phase-fraction based interface capturing approach,
+    with optional mesh motion and mesh topology changes including adaptive
+    re-meshing.

-    Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
+    The momentum and other fluid properties are of the "mixture" and a
+    single momentum equation is solved.  Turbulence modelling is generic,
+    i.e. laminar, RAS or LES may be selected.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
+++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
@ -28,10 +28,11 @@ Application
 Description
    Solver for 2 compressible, 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.

-    Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
+    Turbulence modelling is generic, i.e.  laminar, RAS or LES may be selected.

 \*---------------------------------------------------------------------------*/

--- a/applications/solvers/multiphase/interFoam/interFoam.C
+++ b/applications/solvers/multiphase/interFoam/interFoam.C
@ -28,10 +28,11 @@ Application
 Description
    Solver for 2 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.

-    Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.
+    Turbulence modelling is generic, i.e.  laminar, RAS or LES may be selected.

    For a two-fluid approach see twoPhaseEulerFoam.

--- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
@ -28,8 +28,10 @@ Application
 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.  The momentum and other fluid properties are
-    of the "mixture" and a single momentum equation is solved.
+    interface capturing approach.
+
+    The momentum and other fluid properties are of the "mixture" and a
+    single momentum equation is solved.

    The set of phase-change models provided are designed to simulate cavitation
    but other mechanisms of phase-change are supported within this solver
--- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
+++ b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
@ -27,7 +27,7 @@ Application

 Description
    Solver for n incompressible fluids which captures the interfaces and
-    includes surface-tension and contact-angle effects for each.
+    includes surface-tension and contact-angle effects for each phase.

    Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected.

--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@ -26,8 +26,10 @@ Application
    changeDictionary

 Description
-    Simple dictionary changing tool. Can be used to e.g. change the patch
-    type. Reads dictionaries (fields) and entries to change from a dictionary.
+    Utility to change dictionary entries, e.g. can be used to change the patch
+    type in the field and polyMesh/boundary files.
+
+    Reads dictionaries (fields) and entries to change from a dictionary.
    E.g. to make the @em movingWall a @em fixedValue for @em p, the
    @c system/changeDictionaryDict would contain the following:
    @verbatim