mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: (further) Doxygen documentation updates for module support
This commit is contained in:
Andrew Heather
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamDataToFluent
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to Fluent format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToEnsight
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to EnSight format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToEnsightParts
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to Ensight format.
|
||||
An Ensight part is created for each cellZone and patch.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToGMV
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates foam output to GMV readable files.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToTecplot360
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Tecplot binary file format writer.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToTetDualMesh
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Converts polyMesh results to tetDualMesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToVTK
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Legacy VTK file format writer.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
smapToFoam
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates a STAR-CD SMAP data file into OpenFOAM field format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamCalc
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Generic wrapper for calculating a quantity at each time.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
particleTracks
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Generates a VTK file of particle tracks for cases that were computed using
|
||||
a tracked-parcel-type cloud.
|
||||
|
||||
@ -24,6 +24,10 @@ License
|
||||
Application
|
||||
steadyParticleTracks
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
|
||||
Description
|
||||
Generates a VTK file of particle tracks for cases that were computed using
|
||||
a steady-state cloud
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
dsmcFieldsCalc
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculate intensive fields (U and T) from averaged extensive fields from a
|
||||
DSMC calculation.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
engineCompRatio
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculate the geometric compression ratio.
|
||||
|
||||
@ -83,7 +86,7 @@ int main(int argc, char *argv[])
|
||||
Info<< "\nVmax = " << Vmax
|
||||
<< ", Vmin = " << Vmin << nl
|
||||
<< "Vmax/Vmin = " << Vmax/Vmin << endl;
|
||||
|
||||
|
||||
Info<< "\nEnd\n" << endl;
|
||||
|
||||
return 0;
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
execFlowFunctionObjects
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Execute the set of functionObjects specified in the selected dictionary
|
||||
(which defaults to system/controlDict) for the selected set of times.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamListTimes
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
List times using timeSelector.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
pdfPlot
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
Description
|
||||
Generates a graph of a probability distribution function.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
postChannel
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Post-processes data from channel flow calculations.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
ptot
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
For each time: calculate the total pressure.
|
||||
|
||||
|
||||
@ -21,6 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Application
|
||||
temporalInterpolate
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Interpolate fields between time-steps e.g. for animation.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
wdot
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes wdot for each time.
|
||||
|
||||
|
||||
@ -21,6 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Application
|
||||
writeCellCentres
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Write the three components of the cell centres as volScalarFields so
|
||||
they can be used in postprocessing in thresholding.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
noise
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Utility to perform noise analysis of pressure data using the noiseFFT
|
||||
library.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
patchAverage
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates the average of the specified field over the specified patch.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
patchIntegrate
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates the integral of the specified field over the specified patch.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
probeLocations
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Probe locations.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
sample
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Sample field data with a choice of interpolation schemes, sampling options
|
||||
and write formats.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
pPrime2
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the scalar field of pPrime2 (sqr(p - pMean)) at
|
||||
each time
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
R
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the Reynolds stress R for the current time step.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
createTurbulenceFields
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Creates a full set of turbulence fields.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
Co
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the Co number as a volScalarField obtained
|
||||
from field phi.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
Lambda2
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the second largest eigenvalue of the sum of the
|
||||
square of the symmetrical and anti-symmetrical parts of the velocity
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
Mach
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and optionally writes the local Mach number from the velocity
|
||||
field U at each time.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
Pe
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates the Peclet number Pe from the flux phi and writes the maximum
|
||||
value, the surfaceScalarField Pef and volScalarField Pe.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
Q
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the second invariant of the velocity gradient tensor.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
enstrophy
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the enstrophy of the velocity field U.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
flowType
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the flowType of velocity field U.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
streamFunction
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the stream function of velocity field U at each
|
||||
time.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
uprime
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the scalar field of uprime (sqrt(2/3 k)).
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
vorticity
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the vorticity of velocity field U.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
wallGradU
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the gradient of U at the wall.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
wallHeatFlux
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and writes the heat flux for all patches as the boundary field
|
||||
of a volScalarField and also prints the integrated flux for all wall
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
wallShearStress
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and reports the turbulent wall shear stress for all patches,
|
||||
for the specified times.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
yPlus
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculates and reports yPlus for the near-wall cells of all wall patches,
|
||||
for the specified times for laminar, LES and RAS.
|
||||
|
||||
Reference in New Issue
Block a user