From 1865b49aae08d73abb8aa7d318073193243a170a Mon Sep 17 00:00:00 2001
From: Chris Greenshields <http://cfd.direct>
Date: Sat, 11 Jun 2016 08:53:04 +0100
Subject: [PATCH] Packaged function objects: added a Description entry
---
.../postProcessing/faceSource/patchAverage | 14 ++++++++-----
.../postProcessing/faceSource/patchIntegrate | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/CourantNo | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/Lambda2 | 16 +++++++++-----
etc/caseDicts/postProcessing/fields/MachNo | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/PecletNo | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/Q | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/R | 14 ++++++++-----
.../postProcessing/fields/components | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/div | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/enstrophy | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/flowType | 17 ++++++++++-----
etc/caseDicts/postProcessing/fields/grad | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/mag | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/magSqr | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/randomise | 15 ++++++++-----
.../postProcessing/fields/turbulenceFields | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/vorticity | 14 ++++++++-----
.../postProcessing/fields/wallShearStress | 15 ++++++++-----
.../postProcessing/fields/writeObjects | 14 ++++++++-----
etc/caseDicts/postProcessing/fields/yPlus | 14 ++++++++-----
.../postProcessing/flowRate/flowRatePatch | 20 ++++++++++--------
.../flowRate/volFlowRateSurface | 21 +++++++++++--------
.../forces/forceCoeffsCompressible | 16 +++++++++-----
.../forces/forceCoeffsIncompressible | 16 +++++++++-----
.../postProcessing/forces/forcesCompressible | 15 ++++++++-----
.../forces/forcesIncompressible | 15 ++++++++-----
.../postProcessing/graphs/singleGraph | 15 ++++++++-----
etc/caseDicts/postProcessing/minMax/cellMax | 14 ++++++++-----
etc/caseDicts/postProcessing/minMax/cellMin | 14 ++++++++-----
etc/caseDicts/postProcessing/minMax/faceMax | 14 ++++++++-----
etc/caseDicts/postProcessing/minMax/faceMin | 14 ++++++++-----
.../postProcessing/minMax/minMaxComponents | 17 +++++++++------
.../minMax/minMaxComponents.cfg | 2 +-
.../postProcessing/minMax/minMaxMagnitude | 15 ++++++++-----
.../postProcessing/numerical/residuals | 16 +++++++++-----
.../pressure/pressureDifferencePatch | 15 ++++++++-----
.../pressure/pressureDifferenceSurface | 15 ++++++++-----
.../postProcessing/pressure/staticPressure | 15 ++++++++-----
.../pressure/totalPressureCompressible | 15 ++++++++-----
.../pressure/totalPressureCompressible.cfg | 2 +-
.../pressure/totalPressureIncompressible | 15 ++++++++-----
.../postProcessing/probes/boundaryCloud | 15 ++++++++-----
.../postProcessing/probes/internalCloud | 14 ++++++++-----
etc/caseDicts/postProcessing/probes/probes | 14 ++++++++-----
.../solvers/scalarTransport/scalarTransport | 18 +++++++++++-----
.../postProcessing/visualization/streamlines | 14 ++++++++-----
.../postProcessing/visualization/surfaces | 18 +++++++++++-----
48 files changed, 454 insertions(+), 241 deletions(-)
diff --git a/etc/caseDicts/postProcessing/faceSource/patchAverage b/etc/caseDicts/postProcessing/faceSource/patchAverage
index 25c03e5fcf4..bb573da7cc1 100644
--- a/etc/caseDicts/postProcessing/faceSource/patchAverage
+++ b/etc/caseDicts/postProcessing/faceSource/patchAverage
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the average value of one or more fields on a patch.
+
\*---------------------------------------------------------------------------*/
patchAverage
diff --git a/etc/caseDicts/postProcessing/faceSource/patchIntegrate b/etc/caseDicts/postProcessing/faceSource/patchIntegrate
index 6caffbb119e..6e4dcea052d 100644
--- a/etc/caseDicts/postProcessing/faceSource/patchIntegrate
+++ b/etc/caseDicts/postProcessing/faceSource/patchIntegrate
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the surface integral of one or more fields on a patch.
+
\*---------------------------------------------------------------------------*/
patchIntegrate
diff --git a/etc/caseDicts/postProcessing/fields/CourantNo b/etc/caseDicts/postProcessing/fields/CourantNo
index 4a6b84b8f45..164f96a2efc 100644
--- a/etc/caseDicts/postProcessing/fields/CourantNo
+++ b/etc/caseDicts/postProcessing/fields/CourantNo
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the Courant Number field from the flux field.
+
\*---------------------------------------------------------------------------*/
CourantNo
diff --git a/etc/caseDicts/postProcessing/fields/Lambda2 b/etc/caseDicts/postProcessing/fields/Lambda2
index 5bd9299695b..9882cfbb81d 100644
--- a/etc/caseDicts/postProcessing/fields/Lambda2
+++ b/etc/caseDicts/postProcessing/fields/Lambda2
@@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates and writes the second largest eigenvalue of the sum of the
+ square of the symmetrical and anti-symmetrical parts of the velocity
+ gradient tensor.
+
\*---------------------------------------------------------------------------*/
Lambda2
diff --git a/etc/caseDicts/postProcessing/fields/MachNo b/etc/caseDicts/postProcessing/fields/MachNo
index 792e050838a..bbef2d2cb4c 100644
--- a/etc/caseDicts/postProcessing/fields/MachNo
+++ b/etc/caseDicts/postProcessing/fields/MachNo
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the Mach Number field from the velocity field.
+
\*---------------------------------------------------------------------------*/
MachNo
diff --git a/etc/caseDicts/postProcessing/fields/PecletNo b/etc/caseDicts/postProcessing/fields/PecletNo
index 5aa3082cf6e..7d7035cd662 100644
--- a/etc/caseDicts/postProcessing/fields/PecletNo
+++ b/etc/caseDicts/postProcessing/fields/PecletNo
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the Peclet Number field from the flux field.
+
\*---------------------------------------------------------------------------*/
PecletNo
diff --git a/etc/caseDicts/postProcessing/fields/Q b/etc/caseDicts/postProcessing/fields/Q
index bdfee511caa..69d11674db6 100644
--- a/etc/caseDicts/postProcessing/fields/Q
+++ b/etc/caseDicts/postProcessing/fields/Q
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the second invariant of the velocity gradient tensor.
+
\*---------------------------------------------------------------------------*/
Q
diff --git a/etc/caseDicts/postProcessing/fields/R b/etc/caseDicts/postProcessing/fields/R
index 7cade562409..c4d4bf1f1d0 100644
--- a/etc/caseDicts/postProcessing/fields/R
+++ b/etc/caseDicts/postProcessing/fields/R
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the Reynolds stress tensor field and stores it on the database.
+
\*---------------------------------------------------------------------------*/
R
diff --git a/etc/caseDicts/postProcessing/fields/components b/etc/caseDicts/postProcessing/fields/components
index 9993be4dbbe..40110ff79a3 100644
--- a/etc/caseDicts/postProcessing/fields/components
+++ b/etc/caseDicts/postProcessing/fields/components
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes the component scalar fields (e.g. Ux, Uy, Uz) of a field (e.g. U).
+
\*---------------------------------------------------------------------------*/
components
diff --git a/etc/caseDicts/postProcessing/fields/div b/etc/caseDicts/postProcessing/fields/div
index c6ccf6644a1..93a24371143 100644
--- a/etc/caseDicts/postProcessing/fields/div
+++ b/etc/caseDicts/postProcessing/fields/div
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the divergence of a field.
+
\*---------------------------------------------------------------------------*/
div
diff --git a/etc/caseDicts/postProcessing/fields/enstrophy b/etc/caseDicts/postProcessing/fields/enstrophy
index 45d7a1b02bb..99f64f9529f 100644
--- a/etc/caseDicts/postProcessing/fields/enstrophy
+++ b/etc/caseDicts/postProcessing/fields/enstrophy
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the enstrophy of the velocity field.
+
\*---------------------------------------------------------------------------*/
enstrophy
diff --git a/etc/caseDicts/postProcessing/fields/flowType b/etc/caseDicts/postProcessing/fields/flowType
index 44f5d695bdc..997fe3e0b4d 100644
--- a/etc/caseDicts/postProcessing/fields/flowType
+++ b/etc/caseDicts/postProcessing/fields/flowType
@@ -1,9 +1,16 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates and writes the flowType of velocity field where:
+ -1 = rotational flow;
+ 0 = simple shear flow;
+ +1 = planar extensional flow.
+
\*---------------------------------------------------------------------------*/
flowType
diff --git a/etc/caseDicts/postProcessing/fields/grad b/etc/caseDicts/postProcessing/fields/grad
index a1df8b379f6..a56efbb0c7c 100644
--- a/etc/caseDicts/postProcessing/fields/grad
+++ b/etc/caseDicts/postProcessing/fields/grad
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the gradient of a field.
+
\*---------------------------------------------------------------------------*/
grad
diff --git a/etc/caseDicts/postProcessing/fields/mag b/etc/caseDicts/postProcessing/fields/mag
index 43874441681..3c360974b65 100644
--- a/etc/caseDicts/postProcessing/fields/mag
+++ b/etc/caseDicts/postProcessing/fields/mag
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the magnitude of a field.
+
\*---------------------------------------------------------------------------*/
mag
diff --git a/etc/caseDicts/postProcessing/fields/magSqr b/etc/caseDicts/postProcessing/fields/magSqr
index 49dccdb6301..a2742446c29 100644
--- a/etc/caseDicts/postProcessing/fields/magSqr
+++ b/etc/caseDicts/postProcessing/fields/magSqr
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the magnitude-squared of a field.
+
\*---------------------------------------------------------------------------*/
magSqr
diff --git a/etc/caseDicts/postProcessing/fields/randomise b/etc/caseDicts/postProcessing/fields/randomise
index 84c58b5a073..1fe72c26e5c 100644
--- a/etc/caseDicts/postProcessing/fields/randomise
+++ b/etc/caseDicts/postProcessing/fields/randomise
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Adds a random component to a field, with a specified perturbation
+ magnitude.
+
\*---------------------------------------------------------------------------*/
randomise
diff --git a/etc/caseDicts/postProcessing/fields/turbulenceFields b/etc/caseDicts/postProcessing/fields/turbulenceFields
index 128467eb1aa..eae0183d485 100644
--- a/etc/caseDicts/postProcessing/fields/turbulenceFields
+++ b/etc/caseDicts/postProcessing/fields/turbulenceFields
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates specified turbulence fields and stores it on the database.
+
\*---------------------------------------------------------------------------*/
turbulenceFields
diff --git a/etc/caseDicts/postProcessing/fields/vorticity b/etc/caseDicts/postProcessing/fields/vorticity
index 6377bc2012d..b116630af11 100644
--- a/etc/caseDicts/postProcessing/fields/vorticity
+++ b/etc/caseDicts/postProcessing/fields/vorticity
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the vorticity field, i.e. the curl of the velocity field.
+
\*---------------------------------------------------------------------------*/
vorticity
diff --git a/etc/caseDicts/postProcessing/fields/wallShearStress b/etc/caseDicts/postProcessing/fields/wallShearStress
index c4f5b96e89c..0d2873c4cdf 100644
--- a/etc/caseDicts/postProcessing/fields/wallShearStress
+++ b/etc/caseDicts/postProcessing/fields/wallShearStress
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the shear stress at wall patches, outputting the data as a
+ volVectorField.
+
\*---------------------------------------------------------------------------*/
wallShearStress
diff --git a/etc/caseDicts/postProcessing/fields/writeObjects b/etc/caseDicts/postProcessing/fields/writeObjects
index a90743cc3ea..24cc15eaed5 100644
--- a/etc/caseDicts/postProcessing/fields/writeObjects
+++ b/etc/caseDicts/postProcessing/fields/writeObjects
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out specified objects, e.g. fields, stored on the case database.
+
\*---------------------------------------------------------------------------*/
writeObjects
diff --git a/etc/caseDicts/postProcessing/fields/yPlus b/etc/caseDicts/postProcessing/fields/yPlus
index 92816e76a0b..6b0c06b6bee 100644
--- a/etc/caseDicts/postProcessing/fields/yPlus
+++ b/etc/caseDicts/postProcessing/fields/yPlus
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the turbulence y+, outputting the data as a yPlus field.
+
\*---------------------------------------------------------------------------*/
yPlus
diff --git a/etc/caseDicts/postProcessing/flowRate/flowRatePatch b/etc/caseDicts/postProcessing/flowRate/flowRatePatch
index 7eb8d0873c4..d458a5baffc 100644
--- a/etc/caseDicts/postProcessing/flowRate/flowRatePatch
+++ b/etc/caseDicts/postProcessing/flowRate/flowRatePatch
@@ -1,14 +1,16 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
-\*---------------------------------------------------------------------------*/
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the flow rate through a specified patch by summing the flux on
+ patch faces. For solvers where the flux is volumetric, the flow rate is
+ volumetric; where flux is mass flux, the flow rate is mass flow rate.
-// This packaged function object sums the flux phi on patch faces so the
-// calculated volume flow rate for solvers where phi = volumetric flux, and
-// mass flow rate for solvers where phi = mass flux.
+\*---------------------------------------------------------------------------*/
flowRatePatch
{
diff --git a/etc/caseDicts/postProcessing/flowRate/volFlowRateSurface b/etc/caseDicts/postProcessing/flowRate/volFlowRateSurface
index 1f64e1e5b25..a267d81f14d 100644
--- a/etc/caseDicts/postProcessing/flowRate/volFlowRateSurface
+++ b/etc/caseDicts/postProcessing/flowRate/volFlowRateSurface
@@ -1,14 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
-\*---------------------------------------------------------------------------*/
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates volumetric flow rate through a specified triangulated surface
+ by interpolating velocity onto the triangles and integrating over the
+ surface area. Triangles need to be small (<= cell size) for an accurate
+ result.
-// This packaged function object interpolates velocity U onto triangles in
-// triSurface file and integrates over the surface area. Triangles need to
-// be small (<= cell size) for an accurate integration.
+\*---------------------------------------------------------------------------*/
volFlowRateSurface
{
diff --git a/etc/caseDicts/postProcessing/forces/forceCoeffsCompressible b/etc/caseDicts/postProcessing/forces/forceCoeffsCompressible
index 89e01a2989b..aad00884610 100644
--- a/etc/caseDicts/postProcessing/forces/forceCoeffsCompressible
+++ b/etc/caseDicts/postProcessing/forces/forceCoeffsCompressible
@@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates lift, drag and moment coefficients by summing forces on
+ specified patches for a case where the solver is compressible (pressure is
+ in units ML^-1T^-2, e.g. Pa).
+
\*---------------------------------------------------------------------------*/
forceCoeffsCompressible
diff --git a/etc/caseDicts/postProcessing/forces/forceCoeffsIncompressible b/etc/caseDicts/postProcessing/forces/forceCoeffsIncompressible
index b8df56567ff..2877e5bd760 100644
--- a/etc/caseDicts/postProcessing/forces/forceCoeffsIncompressible
+++ b/etc/caseDicts/postProcessing/forces/forceCoeffsIncompressible
@@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates lift, drag and moment coefficients by summing forces on
+ specified patches for a case where the solver is incompressible (pressure
+ is kinematic, e.g. m^2/s^2).
+
\*---------------------------------------------------------------------------*/
forceCoeffsIncompressible
diff --git a/etc/caseDicts/postProcessing/forces/forcesCompressible b/etc/caseDicts/postProcessing/forces/forcesCompressible
index c02fa35bd9d..af492d95f72 100644
--- a/etc/caseDicts/postProcessing/forces/forcesCompressible
+++ b/etc/caseDicts/postProcessing/forces/forcesCompressible
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates pressure and viscous forces over specified patches for a case
+ where the solver is compressible (pressure is in units ML^-1T^-2, e.g. Pa).
+
\*---------------------------------------------------------------------------*/
forcesCompressible
diff --git a/etc/caseDicts/postProcessing/forces/forcesIncompressible b/etc/caseDicts/postProcessing/forces/forcesIncompressible
index afa2dd07a39..40982386ad8 100644
--- a/etc/caseDicts/postProcessing/forces/forcesIncompressible
+++ b/etc/caseDicts/postProcessing/forces/forcesIncompressible
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates pressure and viscous forces over specified patches for a case
+ where the solver is incompressible (pressure is kinematic, e.g. m^2/s^2).
+
\*---------------------------------------------------------------------------*/
forcesIncompressible
diff --git a/etc/caseDicts/postProcessing/graphs/singleGraph b/etc/caseDicts/postProcessing/graphs/singleGraph
index f06e4a6234d..9e2d93e3eea 100644
--- a/etc/caseDicts/postProcessing/graphs/singleGraph
+++ b/etc/caseDicts/postProcessing/graphs/singleGraph
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes graph data for specified fields along a line, specified by start
+ and end points.
+
\*---------------------------------------------------------------------------*/
singleGraph
diff --git a/etc/caseDicts/postProcessing/minMax/cellMax b/etc/caseDicts/postProcessing/minMax/cellMax
index 815a7f7f344..eae49b0c633 100644
--- a/etc/caseDicts/postProcessing/minMax/cellMax
+++ b/etc/caseDicts/postProcessing/minMax/cellMax
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the maximum cell value for one or more fields.
+
\*---------------------------------------------------------------------------*/
cellMax
diff --git a/etc/caseDicts/postProcessing/minMax/cellMin b/etc/caseDicts/postProcessing/minMax/cellMin
index aea52c7b69c..54b8a926b03 100644
--- a/etc/caseDicts/postProcessing/minMax/cellMin
+++ b/etc/caseDicts/postProcessing/minMax/cellMin
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the minimum cell value for one or more fields.
+
\*---------------------------------------------------------------------------*/
cellMin
diff --git a/etc/caseDicts/postProcessing/minMax/faceMax b/etc/caseDicts/postProcessing/minMax/faceMax
index d8b4f6fd094..59225cf4acb 100644
--- a/etc/caseDicts/postProcessing/minMax/faceMax
+++ b/etc/caseDicts/postProcessing/minMax/faceMax
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the maximum face value for one or more fields.
+
\*---------------------------------------------------------------------------*/
faceMax
diff --git a/etc/caseDicts/postProcessing/minMax/faceMin b/etc/caseDicts/postProcessing/minMax/faceMin
index 0c82ec01ddf..4e12aa5d48f 100644
--- a/etc/caseDicts/postProcessing/minMax/faceMin
+++ b/etc/caseDicts/postProcessing/minMax/faceMin
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the minimum face value for one or more fields.
+
\*---------------------------------------------------------------------------*/
faceMin
diff --git a/etc/caseDicts/postProcessing/minMax/minMaxComponents b/etc/caseDicts/postProcessing/minMax/minMaxComponents
index 71db684633f..38dc6fa572b 100644
--- a/etc/caseDicts/postProcessing/minMax/minMaxComponents
+++ b/etc/caseDicts/postProcessing/minMax/minMaxComponents
@@ -1,16 +1,21 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the minimum and maximum values, by component for non-scalar
+ fields, and the locations where they occur.
+
\*---------------------------------------------------------------------------*/
minMaxComponents
{
#includeEtc "caseDicts/postProcessing/minMax/minMaxComponents.cfg"
- mode components;
+ fields (U p);
}
// ************************************************************************* //
diff --git a/etc/caseDicts/postProcessing/minMax/minMaxComponents.cfg b/etc/caseDicts/postProcessing/minMax/minMaxComponents.cfg
index f18af3c91f9..91c6c82201e 100644
--- a/etc/caseDicts/postProcessing/minMax/minMaxComponents.cfg
+++ b/etc/caseDicts/postProcessing/minMax/minMaxComponents.cfg
@@ -7,6 +7,6 @@
\*---------------------------------------------------------------------------*/
#includeEtc "caseDicts/postProcessing/minMax/fieldMinMax.cfg"
-mode components;
+mode component;
// ************************************************************************* //
diff --git a/etc/caseDicts/postProcessing/minMax/minMaxMagnitude b/etc/caseDicts/postProcessing/minMax/minMaxMagnitude
index 3691baa8c09..c5feaa33c7e 100644
--- a/etc/caseDicts/postProcessing/minMax/minMaxMagnitude
+++ b/etc/caseDicts/postProcessing/minMax/minMaxMagnitude
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out the minimum and maximum values, by magnitude for non-scalar
+ fields, and the locations where they occur.
+
\*---------------------------------------------------------------------------*/
minMaxMagnitude
diff --git a/etc/caseDicts/postProcessing/numerical/residuals b/etc/caseDicts/postProcessing/numerical/residuals
index d4e937ecc72..66d17a4f381 100644
--- a/etc/caseDicts/postProcessing/numerical/residuals
+++ b/etc/caseDicts/postProcessing/numerical/residuals
@@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ For specified fields, writes out the initial residuals for the first
+ solution of each time step; for non-scalar fields (e.g. vectors), writes
+ the largest of the residuals for each component (e.g. x, y, z).
+
\*---------------------------------------------------------------------------*/
residuals
diff --git a/etc/caseDicts/postProcessing/pressure/pressureDifferencePatch b/etc/caseDicts/postProcessing/pressure/pressureDifferencePatch
index 8bb8360cb7e..5e4b987ee3e 100644
--- a/etc/caseDicts/postProcessing/pressure/pressureDifferencePatch
+++ b/etc/caseDicts/postProcessing/pressure/pressureDifferencePatch
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the difference between the average pressures on 2 specified
+ patches.
+
\*---------------------------------------------------------------------------*/
pressureDifferencePatch
diff --git a/etc/caseDicts/postProcessing/pressure/pressureDifferenceSurface b/etc/caseDicts/postProcessing/pressure/pressureDifferenceSurface
index a2693dc52be..b9f71d166ee 100644
--- a/etc/caseDicts/postProcessing/pressure/pressureDifferenceSurface
+++ b/etc/caseDicts/postProcessing/pressure/pressureDifferenceSurface
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Interpolates pressures onto 2 specified triangulated surfaces and
+ calculates the difference between the average pressures.
+
\*---------------------------------------------------------------------------*/
pressureDifferenceSurface
diff --git a/etc/caseDicts/postProcessing/pressure/staticPressure b/etc/caseDicts/postProcessing/pressure/staticPressure
index 39ebd637f52..f7c84b10de9 100644
--- a/etc/caseDicts/postProcessing/pressure/staticPressure
+++ b/etc/caseDicts/postProcessing/pressure/staticPressure
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the pressure field in units ML^-1T^-2 (e.g. Pa) from kinematic
+ pressure by scaling by a specified density.
+
\*---------------------------------------------------------------------------*/
staticPressure
diff --git a/etc/caseDicts/postProcessing/pressure/totalPressureCompressible b/etc/caseDicts/postProcessing/pressure/totalPressureCompressible
index 72c8f9e3b43..0470beaf385 100644
--- a/etc/caseDicts/postProcessing/pressure/totalPressureCompressible
+++ b/etc/caseDicts/postProcessing/pressure/totalPressureCompressible
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the total pressure field for a case where the solver is
+ compressible (pressure is in units ML^-1T^-2, e.g. Pa).
+
\*---------------------------------------------------------------------------*/
totalPressureCompressible
diff --git a/etc/caseDicts/postProcessing/pressure/totalPressureCompressible.cfg b/etc/caseDicts/postProcessing/pressure/totalPressureCompressible.cfg
index 6a86d3949fc..ab5ca7820db 100644
--- a/etc/caseDicts/postProcessing/pressure/totalPressureCompressible.cfg
+++ b/etc/caseDicts/postProcessing/pressure/totalPressureCompressible.cfg
@@ -8,7 +8,7 @@
#includeEtc "caseDicts/postProcessing/pressure/pressure.cfg"
-calcTotal no;
+calcTotal yes;
calcCoeff no;
// ************************************************************************* //
diff --git a/etc/caseDicts/postProcessing/pressure/totalPressureIncompressible b/etc/caseDicts/postProcessing/pressure/totalPressureIncompressible
index 5623d09cc3a..04af623a5a4 100644
--- a/etc/caseDicts/postProcessing/pressure/totalPressureIncompressible
+++ b/etc/caseDicts/postProcessing/pressure/totalPressureIncompressible
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Calculates the total pressure field for a case where the solver is
+ incompressible (pressure is kinematic, e.g. m^2/s^2).
+
\*---------------------------------------------------------------------------*/
totalPressureIncompressible
diff --git a/etc/caseDicts/postProcessing/probes/boundaryCloud b/etc/caseDicts/postProcessing/probes/boundaryCloud
index 72b0da5b76c..e4302df5e5c 100644
--- a/etc/caseDicts/postProcessing/probes/boundaryCloud
+++ b/etc/caseDicts/postProcessing/probes/boundaryCloud
@@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out values of fields at a cloud of points, interpolated to
+ specified boundary patches.
+
\*---------------------------------------------------------------------------*/
boundaryCloud
diff --git a/etc/caseDicts/postProcessing/probes/internalCloud b/etc/caseDicts/postProcessing/probes/internalCloud
index e5ba0c2541d..e4fc9deb26e 100644
--- a/etc/caseDicts/postProcessing/probes/internalCloud
+++ b/etc/caseDicts/postProcessing/probes/internalCloud
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out values of fields interpolated to a specified cloud of points.
+
\*---------------------------------------------------------------------------*/
internalCloud
diff --git a/etc/caseDicts/postProcessing/probes/probes b/etc/caseDicts/postProcessing/probes/probes
index f5936b06b3b..5a95e563d4e 100644
--- a/etc/caseDicts/postProcessing/probes/probes
+++ b/etc/caseDicts/postProcessing/probes/probes
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out values of fields from cells nearest to specified locations.
+
\*---------------------------------------------------------------------------*/
probes
diff --git a/etc/caseDicts/postProcessing/solvers/scalarTransport/scalarTransport b/etc/caseDicts/postProcessing/solvers/scalarTransport/scalarTransport
index 7a6d7e06b4c..0af315e8ae2 100644
--- a/etc/caseDicts/postProcessing/solvers/scalarTransport/scalarTransport
+++ b/etc/caseDicts/postProcessing/solvers/scalarTransport/scalarTransport
@@ -1,9 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Solves a transport equation for a scalar field.
+
+ The name of the scalar field is specified in this file. A sample scalar
+ field file, that must be initialised for the case, typically in the 0
+ directory, is available in $FOAM_ETC/caseDicts/solvers/scalarTransport.
+
\*---------------------------------------------------------------------------*/
scalarTransport
diff --git a/etc/caseDicts/postProcessing/visualization/streamlines b/etc/caseDicts/postProcessing/visualization/streamlines
index c194eb7efe1..bf8312498ea 100644
--- a/etc/caseDicts/postProcessing/visualization/streamlines
+++ b/etc/caseDicts/postProcessing/visualization/streamlines
@@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out files of streamlines with interpolated field data in VTK format.
+
\*---------------------------------------------------------------------------*/
streamlines
diff --git a/etc/caseDicts/postProcessing/visualization/surfaces b/etc/caseDicts/postProcessing/visualization/surfaces
index 3b820bd51ee..915517fcc43 100644
--- a/etc/caseDicts/postProcessing/visualization/surfaces
+++ b/etc/caseDicts/postProcessing/visualization/surfaces
@@ -1,9 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\
-| ========= | |
-| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
-| \\ / O peration | Version: dev |
-| \\ / A nd | Web: www.OpenFOAM.org |
-| \\/ M anipulation | |
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Web: www.OpenFOAM.org
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+Description
+ Writes out surface files with interpolated field data in VTK format, e.g.
+ cutting planes, iso-surfaces and patch boundary surfaces.
+
+ This file includes a selection of example surfaces, each of which the user
+ should configure and/or remove.
+
\*---------------------------------------------------------------------------*/
surfaces
--
GitLab