diff --git a/etc/caseDicts/postProcessing/faceSource/patchAverage b/etc/caseDicts/postProcessing/faceSource/patchAverage index 25c03e5fc..bb573da7c 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 6caffbb11..6e4dcea05 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 4a6b84b8f..164f96a2e 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 5bd929969..9882cfbb8 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 792e05083..bbef2d2cb 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 5aa3082cf..7d7035cd6 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 bdfee511c..69d11674d 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 7cade5624..c4d4bf1f1 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 9993be4db..40110ff79 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 c6ccf6644..93a243711 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 45d7a1b02..99f64f952 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 44f5d695b..997fe3e0b 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 a1df8b379..a56efbb0c 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 438744416..3c360974b 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 49dccdb63..a2742446c 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 84c58b5a0..1fe72c26e 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 128467eb1..eae0183d4 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 6377bc201..b116630af 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 c4f5b96e8..0d2873c4c 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 a90743cc3..24cc15eae 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 92816e76a..6b0c06b6b 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 7eb8d0873..d458a5baf 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 1f64e1e5b..a267d81f1 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 89e01a298..aad008846 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 b8df56567..2877e5bd7 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 c02fa35bd..af492d95f 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 afa2dd07a..40982386a 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 f06e4a623..9e2d93e3e 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 815a7f7f3..eae49b0c6 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 aea52c7b6..54b8a926b 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 d8b4f6fd0..59225cf4a 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 0c82ec01d..4e12aa5d4 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 71db68463..38dc6fa57 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 f18af3c91..91c6c8220 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 3691baa8c..c5feaa33c 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 d4e937ecc..66d17a4f3 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 8bb8360cb..5e4b987ee 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 a2693dc52..b9f71d166 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 39ebd637f..f7c84b10d 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 72c8f9e3b..0470beaf3 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 6a86d3949..ab5ca7820 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 5623d09cc..04af623a5 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 72b0da5b7..e4302df5e 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 e5ba0c254..e4fc9deb2 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 f5936b06b..5a95e563d 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 7a6d7e06b..0af315e8a 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 c194eb7ef..bf8312498 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 3b820bd51..915517fcc 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