Packaged function objects: added a Description entry

This commit is contained in:
Chris Greenshields
2016-06-11 08:53:04 +01:00
parent 9cf8bd8313
commit 605c489d5f
48 changed files with 454 additions and 241 deletions

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the average value of one or more fields on a patch.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
patchAverage patchAverage

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the surface integral of one or more fields on a patch.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
patchIntegrate patchIntegrate

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the Courant Number field from the flux field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
CourantNo CourantNo

View File

@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 Lambda2

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the Mach Number field from the velocity field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
MachNo MachNo

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the Peclet Number field from the flux field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
PecletNo PecletNo

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the second invariant of the velocity gradient tensor.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
Q Q

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the Reynolds stress tensor field and stores it on the database.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
R R

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes the component scalar fields (e.g. Ux, Uy, Uz) of a field (e.g. U).
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
components components

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the divergence of a field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
div div

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the enstrophy of the velocity field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
enstrophy enstrophy

View File

@ -1,9 +1,16 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates and writes the flowType of velocity field where:
-1 = rotational flow;
0 = simple shear flow;
+1 = planar extensional flow.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
flowType flowType

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the gradient of a field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
grad grad

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the magnitude of a field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
mag mag

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the magnitude-squared of a field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
magSqr magSqr

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Adds a random component to a field, with a specified perturbation
magnitude.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
randomise randomise

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates specified turbulence fields and stores it on the database.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
turbulenceFields turbulenceFields

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the vorticity field, i.e. the curl of the velocity field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
vorticity vorticity

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the shear stress at wall patches, outputting the data as a
volVectorField.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
wallShearStress wallShearStress

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out specified objects, e.g. fields, stored on the case database.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
writeObjects writeObjects

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the turbulence y+, outputting the data as a yPlus field.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
yPlus yPlus

View File

@ -1,14 +1,16 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 flowRatePatch
{ {

View File

@ -1,14 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 volFlowRateSurface
{ {

View File

@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 forceCoeffsCompressible

View File

@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 forceCoeffsIncompressible

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 forcesCompressible

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 forcesIncompressible

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes graph data for specified fields along a line, specified by start
and end points.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
singleGraph singleGraph

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the maximum cell value for one or more fields.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
cellMax cellMax

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the minimum cell value for one or more fields.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
cellMin cellMin

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the maximum face value for one or more fields.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
faceMax faceMax

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the minimum face value for one or more fields.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
faceMin faceMin

View File

@ -1,16 +1,21 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the minimum and maximum values, by component for non-scalar
fields, and the locations where they occur.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
minMaxComponents minMaxComponents
{ {
#includeEtc "caseDicts/postProcessing/minMax/minMaxComponents.cfg" #includeEtc "caseDicts/postProcessing/minMax/minMaxComponents.cfg"
mode components; fields (U p);
} }
// ************************************************************************* // // ************************************************************************* //

View File

@ -7,6 +7,6 @@
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#includeEtc "caseDicts/postProcessing/minMax/fieldMinMax.cfg" #includeEtc "caseDicts/postProcessing/minMax/fieldMinMax.cfg"
mode components; mode component;
// ************************************************************************* // // ************************************************************************* //

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out the minimum and maximum values, by magnitude for non-scalar
fields, and the locations where they occur.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
minMaxMagnitude minMaxMagnitude

View File

@ -1,9 +1,15 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 residuals

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates the difference between the average pressures on 2 specified
patches.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
pressureDifferencePatch pressureDifferencePatch

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Interpolates pressures onto 2 specified triangulated surfaces and
calculates the difference between the average pressures.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
pressureDifferenceSurface pressureDifferenceSurface

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 staticPressure

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 totalPressureCompressible

View File

@ -8,7 +8,7 @@
#includeEtc "caseDicts/postProcessing/pressure/pressure.cfg" #includeEtc "caseDicts/postProcessing/pressure/pressure.cfg"
calcTotal no; calcTotal yes;
calcCoeff no; calcCoeff no;
// ************************************************************************* // // ************************************************************************* //

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 totalPressureIncompressible

View File

@ -1,9 +1,14 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out values of fields at a cloud of points, interpolated to
specified boundary patches.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
boundaryCloud boundaryCloud

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out values of fields interpolated to a specified cloud of points.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
internalCloud internalCloud

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out values of fields from cells nearest to specified locations.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
probes probes

View File

@ -1,9 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 scalarTransport

View File

@ -1,9 +1,13 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ M anipulation |
-------------------------------------------------------------------------------
Description
Writes out files of streamlines with interpolated field data in VTK format.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
streamlines streamlines

View File

@ -1,9 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\ /*--------------------------------*- C++ -*----------------------------------*\
| ========= | | ========= |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
| \\ / O peration | Version: dev | \\ / O peration |
| \\ / A nd | Web: www.OpenFOAM.org | \\ / A nd | Web: www.OpenFOAM.org
| \\/ M anipulation | | \\/ 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 surfaces