From e7400ef27161d6783ae52100faf9e19339d4be1a Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Mon, 10 Dec 2018 21:05:27 +0100 Subject: [PATCH 1/6] TUT: split off an Allrun.pre for windAroundBuildings --- .../simpleFoam/windAroundBuildings/{0 => 0.orig}/U | 0 .../windAroundBuildings/{0 => 0.orig}/epsilon | 0 .../simpleFoam/windAroundBuildings/{0 => 0.orig}/k | 0 .../simpleFoam/windAroundBuildings/{0 => 0.orig}/nut | 0 .../simpleFoam/windAroundBuildings/{0 => 0.orig}/p | 0 .../simpleFoam/windAroundBuildings/Allclean | 2 +- .../simpleFoam/windAroundBuildings/Allrun | 5 ++--- .../simpleFoam/windAroundBuildings/Allrun-parallel | 7 +++---- .../simpleFoam/windAroundBuildings/Allrun.pre | 11 +++++++++++ 9 files changed, 17 insertions(+), 8 deletions(-) rename tutorials/incompressible/simpleFoam/windAroundBuildings/{0 => 0.orig}/U (100%) rename tutorials/incompressible/simpleFoam/windAroundBuildings/{0 => 0.orig}/epsilon (100%) rename tutorials/incompressible/simpleFoam/windAroundBuildings/{0 => 0.orig}/k (100%) rename tutorials/incompressible/simpleFoam/windAroundBuildings/{0 => 0.orig}/nut (100%) rename tutorials/incompressible/simpleFoam/windAroundBuildings/{0 => 0.orig}/p (100%) create mode 100755 tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/U b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/U similarity index 100% rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/U rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/U diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/epsilon b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/epsilon similarity index 100% rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/epsilon rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/epsilon diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/k b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/k similarity index 100% rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/k rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/k diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/nut b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/nut similarity index 100% rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/nut rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/nut diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/0/p b/tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/p similarity index 100% rename from tutorials/incompressible/simpleFoam/windAroundBuildings/0/p rename to tutorials/incompressible/simpleFoam/windAroundBuildings/0.orig/p diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean index 53afd7eaea..98ff9b6209 100755 --- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean +++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allclean @@ -2,7 +2,7 @@ cd ${0%/*} || exit 1 # Run from this directory . $WM_PROJECT_DIR/bin/tools/CleanFunctions # Tutorial clean functions -cleanCase +cleanCase0 rm -rf constant/extendedFeatureEdgeMesh > /dev/null 2>&1 rm -f constant/triSurface/buildings.eMesh > /dev/null 2>&1 diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun index cc32f55043..30cbfe82f6 100755 --- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun +++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun @@ -2,10 +2,9 @@ cd ${0%/*} || exit 1 # Run from this directory . $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions -runApplication surfaceFeatureExtract +runApplication ./Allrun.pre -runApplication blockMesh -runApplication snappyHexMesh -overwrite +restore0Dir runApplication $(getApplication) diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel index 444dc97cc9..87dec4ec71 100755 --- a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel +++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun-parallel @@ -2,13 +2,12 @@ cd ${0%/*} || exit 1 # Run from this directory . $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions -runApplication surfaceFeatureExtract - -runApplication blockMesh -runApplication snappyHexMesh -overwrite +runApplication ./Allrun.pre runApplication decomposePar +restore0Dir -processor + runParallel $(getApplication) runApplication reconstructPar diff --git a/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre new file mode 100755 index 0000000000..162f1e5f74 --- /dev/null +++ b/tutorials/incompressible/simpleFoam/windAroundBuildings/Allrun.pre @@ -0,0 +1,11 @@ +#!/bin/sh +cd ${0%/*} || exit 1 # Run from this directory +. $WM_PROJECT_DIR/bin/tools/RunFunctions # Tutorial run functions + +runApplication surfaceFeatureExtract + +runApplication blockMesh + +runApplication snappyHexMesh -overwrite + +#------------------------------------------------------------------------------ From ee5199cc65c337cb17f0ba1f9f853e00e9bda17d Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Mon, 10 Dec 2018 22:40:53 +0100 Subject: [PATCH 2/6] STYLE: adjust manpage layouts --- bin/tools/foamCreateManpage | 2 +- src/OpenFOAM/global/argList/argListHelp.C | 38 +++++++++-------------- 2 files changed, 16 insertions(+), 24 deletions(-) diff --git a/bin/tools/foamCreateManpage b/bin/tools/foamCreateManpage index ed7ad21ff1..29e38fdb90 100755 --- a/bin/tools/foamCreateManpage +++ b/bin/tools/foamCreateManpage @@ -129,7 +129,7 @@ process() if grep -F -q "SYNOPSIS" "$tmpFile" 2>/dev/null then cat "$tmpFile" | \ - sed -e "${sedFilter:-p}" | "${gzipFilter:-cat}" \ + sed -e "${sedFilter}" | "${gzipFilter:-cat}" \ >| "$outFile${gzipFilter:+.gz}" echo "$outFile${gzipFilter:+.gz}" 1>&2 diff --git a/src/OpenFOAM/global/argList/argListHelp.C b/src/OpenFOAM/global/argList/argListHelp.C index 4199e0eb5d..35ced1a0ea 100644 --- a/src/OpenFOAM/global/argList/argListHelp.C +++ b/src/OpenFOAM/global/argList/argListHelp.C @@ -40,7 +40,7 @@ static inline void printManFooter() << "Online documentation " << "https://www.openfoam.com/documentation/" << nl << ".SH COPYRIGHT" << nl - << "Copyright 2018 OpenCFD Ltd." << nl; + << "Copyright \\(co 2018 OpenCFD Ltd." << nl; } @@ -162,12 +162,11 @@ void Foam::argList::printMan() const { // .TH "" 1 "OpenFOAM-" "source" "category" - Info - << ".TH" << token::SPACE - // All uppercase and quoted + Info<< ".TH" << token::SPACE + // All uppercase (returns a Foam::string) and thus also quoted << stringOps::upper(executable_) << token::SPACE - << "\"1\"" << token::SPACE - << token::DQUOTE << "OpenFOAM-v" << OPENFOAM << token::DQUOTE + << 1 << token::SPACE + << token::DQUOTE << "OpenFOAM-v" << foamVersion::api << token::DQUOTE << token::SPACE << token::DQUOTE << "www.openfoam.com" << token::DQUOTE << token::SPACE @@ -177,8 +176,7 @@ void Foam::argList::printMan() const // .SH NAME // \- part of OpenFOAM (The Open Source CFD Toolbox). - Info - << ".SH \"NAME\"" << nl + Info<< ".SH \"NAME\"" << nl << executable_ << " \\- part of \\fBOpenFOAM\\fR (The Open Source CFD Toolbox)." << nl; @@ -187,8 +185,7 @@ void Foam::argList::printMan() const // .SH SYNOPSIS // .B command [OPTIONS] ... - Info - << ".SH \"SYNOPSIS\"" << nl + Info<< ".SH \"SYNOPSIS\"" << nl << "\\fB" << executable_ << "\\fR [\\fIOPTIONS\\fR]"; if (validArgs.size()) @@ -217,10 +214,9 @@ void Foam::argList::printMan() const // .SH DESCRIPTION { - Info - << ".SH \"DESCRIPTION\"" << nl; + Info<< ".SH \"DESCRIPTION\"" << nl; - Info<< ".nf" << nl; + Info<< ".nf" << nl; // No fill lines if (notes.empty()) { @@ -228,7 +224,6 @@ void Foam::argList::printMan() const } else { - Info<< nl; for (const std::string& note : notes) { if (note.empty()) @@ -241,13 +236,12 @@ void Foam::argList::printMan() const } } } - Info<< ".fi" << nl; + Info<< ".fi" << nl; // Fill lines } // .SH "OPTIONS" - Info - << ".SH \"OPTIONS\"" << nl; + Info<< ".SH \"OPTIONS\"" << nl; for (const word& optName : validOptions.sortedToc()) { @@ -266,9 +260,8 @@ void Foam::argList::printMan() const printManOption("help-full", "Display full help and exit"); - // .SH "ADVANCED OPTIONS" - Info - << ".SH \"ADVANCED OPTIONS\"" << nl; + // .SS "ADVANCED OPTIONS" + Info<< ".SS \"ADVANCED OPTIONS\"" << nl; for (const word& optName : validOptions.sortedToc()) { @@ -402,9 +395,8 @@ void Foam::argList::printManCompat() const } - // .SH "COMPATIBILITY OPTIONS" - Info - << ".SH \"COMPATIBILITY OPTIONS\"" << nl; + // .SS "COMPATIBILITY OPTIONS" + Info<< ".SS \"COMPATIBILITY OPTIONS\"" << nl; for (const word& k : argList::validOptionsCompat.sortedToc()) { From 68ec561df8346fc0b9491aa46c862c3e83ef9658 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 11 Dec 2018 15:25:27 +0100 Subject: [PATCH 3/6] STYLE: add usage notes to more utilities and solvers --- applications/solvers/DNS/dnsFoam/dnsFoam.C | 5 ++++ .../basic/laplacianFoam/laplacianFoam.C | 5 ++++ .../overLaplacianDyMFoam.C | 5 ++++ .../overPotentialFoam/overPotentialFoam.C | 5 ++++ .../basic/potentialFoam/potentialFoam.C | 5 ++++ .../scalarTransportFoam/scalarTransportFoam.C | 5 ++++ .../solvers/combustion/PDRFoam/PDRFoam.C | 6 ++++ .../combustion/PDRFoam/PDRFoamAutoRefine.C | 6 ++++ .../combustion/XiFoam/XiDyMFoam/XiDyMFoam.C | 6 ++++ .../XiFoam/XiEngineFoam/XiEngineFoam.C | 6 ++++ .../solvers/combustion/XiFoam/XiFoam.C | 6 ++++ .../solvers/combustion/chemFoam/chemFoam.C | 7 ++++- .../coldEngineFoam/coldEngineFoam.C | 5 ++++ .../solvers/combustion/fireFoam/fireFoam.C | 6 ++++ .../combustion/reactingFoam/reactingFoam.C | 5 ++++ .../rhoReactingBuoyantFoam.C | 9 +++++- .../rhoReactingFoam/rhoReactingFoam.C | 8 +++++- .../rhoCentralDyMFoam/rhoCentralDyMFoam.C | 12 ++++++-- .../rhoCentralFoam/rhoCentralFoam.C | 10 +++++-- .../rhoPimpleAdiabaticFoam.C | 7 +++++ .../overRhoPimpleDyMFoam.C | 6 ++++ .../rhoPimpleFoam/rhoPimpleFoam.C | 6 ++++ .../overRhoSimpleFoam/overRhoSimpleFoam.C | 7 ++++- .../rhoPorousSimpleFoam/rhoPorousSimpleFoam.C | 10 +++++-- .../rhoSimpleFoam/rhoSimpleFoam.C | 7 ++++- .../sonicFoam/sonicDyMFoam/sonicDyMFoam.C | 7 +++++ .../compressible/sonicFoam/sonicFoam.C | 6 ++++ .../sonicLiquidFoam/sonicLiquidFoam.C | 6 ++++ .../discreteMethods/dsmc/dsmcFoam/dsmcFoam.C | 10 +++++-- .../mdEquilibrationFoam/mdEquilibrationFoam.C | 5 ++++ .../molecularDynamics/mdFoam/mdFoam.C | 5 ++++ .../electrostaticFoam/electrostaticFoam.C | 5 ++++ .../magneticFoam/magneticFoam.C | 5 ++++ .../electromagnetics/mhdFoam/mhdFoam.C | 7 +++++ .../financial/financialFoam/financialFoam.C | 5 ++++ .../liquidFilmFoam/liquidFilmFoam.C | 6 ++++ .../sphereSurfactantFoam.C | 5 ++++ .../surfactantFoam/surfactantFoam.C | 7 ++++- .../buoyantBoussinesqPimpleFoam.C | 7 +++++ .../buoyantBoussinesqSimpleFoam.C | 6 ++++ .../buoyantPimpleFoam/buoyantPimpleFoam.C | 6 ++++ .../buoyantSimpleFoam/buoyantSimpleFoam.C | 6 ++++ .../chtMultiRegionFoam/chtMultiRegionFoam.C | 7 +++++ .../chtMultiRegionSimpleFoam.C | 7 +++++ .../heatTransfer/thermoFoam/thermoFoam.C | 5 ++++ .../adjointShapeOptimizationFoam.C | 7 +++++ .../boundaryFoam/boundaryFoam.C | 10 +++++-- .../solvers/incompressible/icoFoam/icoFoam.C | 6 ++++ .../nonNewtonianIcoFoam/nonNewtonianIcoFoam.C | 6 ++++ .../pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C | 10 +++++-- .../overPimpleDyMFoam/overPimpleDyMFoam.C | 8 +++++- .../incompressible/pimpleFoam/pimpleFoam.C | 6 ++++ .../incompressible/pisoFoam/pisoFoam.C | 6 ++++ .../shallowWaterFoam/shallowWaterFoam.C | 5 ++++ .../simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C | 6 ++++ .../overSimpleFoam/overSimpleFoam.C | 5 ++++ .../porousSimpleFoam/porousSimpleFoam.C | 7 +++++ .../incompressible/simpleFoam/simpleFoam.C | 7 ++++- .../DPMFoam/DPMDyMFoam/DPMDyMFoam.C | 7 +++++ .../solvers/lagrangian/DPMFoam/DPMFoam.C | 6 ++++ .../coalChemistryFoam/coalChemistryFoam.C | 6 ++++ .../icoUncoupledKinematicParcelDyMFoam.C | 6 ++++ .../icoUncoupledKinematicParcelFoam.C | 5 ++++ .../reactingParcelFoam/reactingParcelFoam.C | 7 +++++ .../simpleReactingParcelFoam.C | 9 +++++- .../simpleCoalParcelFoam.C | 8 +++++- .../sprayFoam/engineFoam/engineFoam.C | 6 ++++ .../sprayFoam/sprayDyMFoam/sprayDyMFoam.C | 7 +++++ .../solvers/lagrangian/sprayFoam/sprayFoam.C | 6 ++++ .../uncoupledKinematicParcelDyMFoam.C | 8 +++++- .../uncoupledKinematicParcelFoam.C | 7 ++++- .../MPPICInterFoam/MPPICInterFoam.C | 9 +++++- .../cavitatingDyMFoam/cavitatingDyMFoam.C | 12 ++++++-- .../cavitatingFoam/cavitatingFoam.C | 10 +++++-- .../compressibleInterDyMFoam.C | 10 ++++++- .../compressibleInterFilmFoam.C | 8 +++++- .../compressibleInterFoam.C | 8 +++++- .../compressibleMultiphaseInterFoam.C | 8 +++++- .../multiphase/driftFluxFoam/driftFluxFoam.C | 16 ++++++++--- .../icoReactingMultiphaseInterFoam.C | 11 +++++++- .../interCondensatingEvaporatingFoam.C | 11 +++++++- .../solvers/multiphase/interFoam/interFoam.C | 10 ++++++- .../interMixingFoam/interMixingFoam.C | 8 ++++++ .../overInterDyMFoam/overInterDyMFoam.C | 10 ++++++- .../multiphase/interIsoFoam/interIsoFoam.C | 11 +++++++- .../interPhaseChangeDyMFoam.C | 18 +++++++++--- .../interPhaseChangeFoam.C | 13 +++++++-- .../multiphaseEulerFoam/multiphaseEulerFoam.C | 6 ++++ .../multiphaseInterFoam/multiphaseInterFoam.C | 9 +++++- .../potentialFreeSurfaceDyMFoam.C | 7 +++++ .../potentialFreeSurfaceFoam.C | 6 ++++ .../reactingMultiphaseEulerFoam.C | 6 ++++ .../reactingTwoPhaseEulerFoam.C | 8 +++++- .../twoLiquidMixingFoam/twoLiquidMixingFoam.C | 7 ++++- .../twoPhaseEulerFoam/twoPhaseEulerFoam.C | 11 ++++++-- .../solidDisplacementFoam.C | 7 +++++ .../solidEquilibriumDisplacementFoam.C | 7 +++++ .../finiteArea/checkFaMesh/checkFaMesh.C | 7 ++++- .../finiteArea/makeFaMesh/makeFaMesh.C | 7 ++++- .../utilities/mesh/advanced/PDRMesh/PDRMesh.C | 4 +++ .../advanced/collapseEdges/collapseEdges.C | 3 +- .../combinePatchFaces/combinePatchFaces.C | 7 ++++- .../mesh/advanced/modifyMesh/modifyMesh.C | 7 ++++- .../advanced/refineHexMesh/refineHexMesh.C | 6 +++- .../refineWallLayer/refineWallLayer.C | 8 +++++- .../refinementLevel/refinementLevel.C | 11 ++++++-- .../mesh/advanced/removeFaces/removeFaces.C | 6 +++- .../mesh/advanced/selectCells/selectCells.C | 5 ++++ .../snappyRefineMesh/snappyRefineMesh.C | 6 +++- .../mesh/conversion/ansysToFoam/ansysToFoam.L | 8 +++++- .../mesh/conversion/ccm/foamToCcm/foamToCcm.C | 2 +- .../mesh/conversion/cfx4ToFoam/cfx4ToFoam.C | 7 ++++- .../mesh/conversion/datToFoam/datToFoam.C | 10 +++++-- .../mesh/conversion/fireToFoam/fireToFoam.C | 4 +-- .../fluent3DMeshToFoam/fluent3DMeshToFoam.L | 6 +++- .../fluentMeshToFoam/fluentMeshToFoam.L | 7 ++++- .../foamMeshToFluent/foamMeshToFluent.C | 6 +++- .../foamToFireMesh/foamToFireMesh.C | 4 +-- .../foamToStarMesh/foamToStarMesh.C | 4 +-- .../conversion/foamToSurface/foamToSurface.C | 6 +++- .../conversion/gambitToFoam/gambitToFoam.L | 7 ++++- .../mesh/conversion/gmshToFoam/gmshToFoam.C | 5 ++++ .../ideasUnvToFoam/ideasUnvToFoam.C | 4 +++ .../mesh/conversion/kivaToFoam/kivaToFoam.C | 6 +++- .../mesh/conversion/mshToFoam/mshToFoam.C | 6 +++- .../netgenNeutralToFoam/netgenNeutralToFoam.C | 6 +++- .../conversion/plot3dToFoam/plot3dToFoam.C | 4 +++ .../mesh/conversion/star4ToFoam/star4ToFoam.C | 2 +- .../conversion/tetgenToFoam/tetgenToFoam.C | 7 ++++- .../vtkUnstructuredToFoam.C | 15 +++++++--- .../extrude/extrudeMesh/extrudeMesh.C | 5 ++++ .../extrudeToRegionMesh/extrudeToRegionMesh.C | 5 +++- .../extrude2DMesh/extrude2DMeshApp.C | 9 ++++-- .../foamyMesh/foamyHexMesh/foamyHexMesh.C | 4 +++ .../foamyMesh/foamyQuadMesh/foamyQuadMesh.C | 5 ++++ .../mesh/manipulation/attachMesh/attachMesh.C | 5 ++++ .../mesh/manipulation/autoPatch/autoPatch.C | 5 ++++ .../mesh/manipulation/checkMesh/checkMesh.C | 7 ++++- .../manipulation/createPatch/createPatch.C | 12 ++++++-- .../manipulation/deformedGeom/deformedGeom.C | 6 ++++ .../manipulation/flattenMesh/flattenMesh.C | 5 ++++ .../manipulation/insideCells/insideCells.C | 7 +++-- .../mesh/manipulation/mirrorMesh/mirrorMesh.C | 5 ++++ .../moveDynamicMesh/moveDynamicMesh.C | 7 ++++- .../moveEngineMesh/moveEngineMesh.C | 8 ++++-- .../mesh/manipulation/moveMesh/moveMesh.C | 6 +++- .../mesh/manipulation/objToVTK/objToVTK.C | 7 ++++- .../orientFaceZone/orientFaceZone.C | 6 +++- .../polyDualMesh/polyDualMeshApp.C | 17 +++++++---- .../manipulation/renumberMesh/renumberMesh.C | 2 +- .../mesh/manipulation/setSet/setSet.C | 11 ++++++-- .../manipulation/setsToZones/setsToZones.C | 2 +- .../singleCellMesh/singleCellMesh.C | 9 ++++-- .../mesh/manipulation/splitMesh/splitMesh.C | 5 ++++ .../splitMeshRegions/splitMeshRegions.C | 2 +- .../mesh/manipulation/subsetMesh/subsetMesh.C | 18 ++++++------ .../mesh/manipulation/topoSet/topoSet.C | 11 ++++++-- .../mesh/manipulation/zipUpMesh/zipUpMesh.C | 12 ++++++-- .../foamDictionary/foamDictionary.C | 7 +++-- .../foamFormatConvert/foamFormatConvert.C | 5 ++++ .../miscellaneous/foamHelp/addToolOption.H | 6 ++-- .../foamListRegions/foamListRegions.C | 12 +++++--- .../foamListTimes/foamListTimes.C | 17 +++++++---- .../foamRestoreFields/foamRestoreFields.C | 7 ++--- .../miscellaneous/patchSummary/patchSummary.C | 8 +++++- .../decomposePar/decomposePar.C | 4 +-- .../reconstructPar/reconstructPar.C | 2 +- .../reconstructParMesh/reconstructParMesh.C | 3 +- .../redistributePar/redistributePar.C | 7 +++++ .../foamDataToFluent/foamDataToFluent.C | 8 ++++-- .../foamToEnsight/foamToEnsight.C | 8 ++++-- .../foamToEnsightParts/foamToEnsightParts.C | 12 ++++++-- .../dataConversion/foamToGMV/foamToGMV.C | 7 ++++- .../foamToTetDualMesh/foamToTetDualMesh.C | 7 ++++- .../dataConversion/foamToVTK/foamToVTK.C | 5 +++- .../dataConversion/smapToFoam/smapToFoam.C | 7 ++++- .../particleTracks/particleTracks.C | 10 +++++-- .../steadyParticleTracks.C | 10 +++++-- .../lumpedPointForces/lumpedPointForces.C | 4 +-- .../lumpedPointMovement/lumpedPointMovement.C | 5 ++-- .../lumpedPointZones/lumpedPointZones.C | 6 ++-- .../engineCompRatio/engineCompRatio.C | 7 ++++- .../miscellaneous/pdfPlot/pdfPlot.C | 7 ++++- .../miscellaneous/postChannel/postChannel.C | 7 ++++- .../profilingSummary/profilingSummary.C | 6 ++-- .../temporalInterpolate/temporalInterpolate.C | 5 ++++ .../utilities/postProcessing/noise/noise.C | 7 ++++- .../postProcessing/postProcess/postProcess.C | 11 ++++++-- .../applyBoundaryLayer/applyBoundaryLayer.C | 4 +-- .../utilities/preProcessing/boxTurb/boxTurb.C | 10 +++++-- .../changeDictionary/changeDictionary.C | 6 ++++ .../createBoxTurb/createBoxTurb.C | 8 +++++- .../createExternalCoupledPatchGeometry.C | 8 +++++- .../createZeroDirectory/createZeroDirectory.C | 6 ++++ .../dsmcInitialise/dsmcInitialise.C | 6 ++++ .../preProcessing/engineSwirl/engineSwirl.C | 6 +++- .../faceAgglomerate/faceAgglomerate.C | 6 ++++ .../foamUpgradeCyclics/foamUpgradeCyclics.C | 5 ++++ .../preProcessing/mdInitialise/mdInitialise.C | 4 +++ .../setAlphaField/setAlphaField.C | 6 ++++ .../preProcessing/setFields/setFields.C | 7 ++++- .../viewFactorsGen/viewFactorsGen.C | 6 ++++ .../wallFunctionTable/wallFunctionTable.C | 5 ++++ .../utilities/surface/surfaceAdd/surfaceAdd.C | 5 ++-- .../surfaceBooleanFeatures.C | 28 +++++++++++-------- .../surface/surfaceCheck/surfaceCheck.C | 7 ++++- .../surface/surfaceClean/surfaceClean.C | 6 ++++ .../surface/surfaceCoarsen/surfaceCoarsen.C | 5 ++++ .../surface/surfaceFind/surfaceFind.C | 7 +++++ .../surface/surfaceHookUp/surfaceHookUp.C | 2 +- .../surface/surfaceInertia/surfaceInertia.C | 4 +-- .../surface/surfaceInflate/surfaceInflate.C | 5 +++- .../surfaceLambdaMuSmooth.C | 9 +++++- .../surfaceMeshConvert/surfaceMeshConvert.C | 4 +-- .../surface/surfacePatch/surfacePatch.C | 4 +++ .../surfaceRedistributePar.C | 6 ++-- .../surfaceRefineRedGreen.C | 4 +++ .../surfaceSplitByTopology.C | 7 +++++ .../surface/surfaceSubset/surfaceSubset.C | 10 +++++-- .../adiabaticFlameT/adiabaticFlameT.C | 6 ++-- .../chemkinToFoam/chemkinToFoam.C | 6 ++-- .../equilibriumCO/equilibriumCO.C | 4 +-- .../equilibriumFlameT/equilibriumFlameT.C | 11 ++++---- .../mixtureAdiabaticFlameT.C | 6 ++-- 224 files changed, 1336 insertions(+), 238 deletions(-) diff --git a/applications/solvers/DNS/dnsFoam/dnsFoam.C b/applications/solvers/DNS/dnsFoam/dnsFoam.C index e7011cdb75..28230c4db9 100644 --- a/applications/solvers/DNS/dnsFoam/dnsFoam.C +++ b/applications/solvers/DNS/dnsFoam/dnsFoam.C @@ -44,6 +44,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Direct numerical simulation for boxes of isotropic turbulence." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/basic/laplacianFoam/laplacianFoam.C b/applications/solvers/basic/laplacianFoam/laplacianFoam.C index 9bffe121d4..251915b6d5 100644 --- a/applications/solvers/basic/laplacianFoam/laplacianFoam.C +++ b/applications/solvers/basic/laplacianFoam/laplacianFoam.C @@ -59,6 +59,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Laplace equation solver for a scalar quantity." + ); + #include "addCheckCaseOptions.H" #include "setRootCase.H" diff --git a/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C b/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C index 9a1c1018d9..5d890a2c0e 100644 --- a/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C +++ b/applications/solvers/basic/laplacianFoam/overLaplacianDyMFoam/overLaplacianDyMFoam.C @@ -60,6 +60,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Overset Laplace equation solver for a scalar quantity." + ); + #include "setRootCase.H" #include "createTime.H" diff --git a/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C b/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C index 839023cfee..5811771600 100644 --- a/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C +++ b/applications/solvers/basic/potentialFoam/overPotentialFoam/overPotentialFoam.C @@ -97,6 +97,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Overset potential flow solver which solves for the velocity potential" + ); + argList::addOption ( "pName", diff --git a/applications/solvers/basic/potentialFoam/potentialFoam.C b/applications/solvers/basic/potentialFoam/potentialFoam.C index 9cd095c95d..3a3922fd11 100644 --- a/applications/solvers/basic/potentialFoam/potentialFoam.C +++ b/applications/solvers/basic/potentialFoam/potentialFoam.C @@ -94,6 +94,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Potential flow solver which solves for the velocity potential" + ); + argList::addOption ( "pName", diff --git a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C index 6c2d703b93..06fa8c4198 100644 --- a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C +++ b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C @@ -61,6 +61,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Passive scalar transport equation solver." + ); + #include "addCheckCaseOptions.H" #include "setRootCase.H" #include "createTime.H" diff --git a/applications/solvers/combustion/PDRFoam/PDRFoam.C b/applications/solvers/combustion/PDRFoam/PDRFoam.C index 4150024994..8dd5abac03 100644 --- a/applications/solvers/combustion/PDRFoam/PDRFoam.C +++ b/applications/solvers/combustion/PDRFoam/PDRFoam.C @@ -86,6 +86,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for compressible premixed/partially-premixed combustion with" + " turbulence modelling." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C b/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C index ef1d103b98..00fd303810 100644 --- a/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C +++ b/applications/solvers/combustion/PDRFoam/PDRFoamAutoRefine.C @@ -71,6 +71,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for compressible premixed/partially-premixed combustion with" + " turbulence modelling." + ); + #include "setRootCase.H" #include "createTime.H" diff --git a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C index 2b4dc4f107..8799b80034 100644 --- a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C +++ b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C @@ -67,6 +67,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for compressible premixed/partially-premixed combustion with" + " turbulence modelling." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C b/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C index 4c9c461d5d..a2e0a3320f 100644 --- a/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C +++ b/applications/solvers/combustion/XiFoam/XiEngineFoam/XiEngineFoam.C @@ -65,6 +65,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for compressible premixed/partially-premixed combustion with" + " turbulence modelling in internal combustion engines." + ); + #define CREATE_TIME createEngineTime.H #define CREATE_MESH createEngineMesh.H #include "postProcess.H" diff --git a/applications/solvers/combustion/XiFoam/XiFoam.C b/applications/solvers/combustion/XiFoam/XiFoam.C index 069c481eb5..5235ad2195 100644 --- a/applications/solvers/combustion/XiFoam/XiFoam.C +++ b/applications/solvers/combustion/XiFoam/XiFoam.C @@ -65,6 +65,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for compressible premixed/partially-premixed combustion with" + " turbulence modelling." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/combustion/chemFoam/chemFoam.C b/applications/solvers/combustion/chemFoam/chemFoam.C index c053395cd0..8caf77ae1b 100644 --- a/applications/solvers/combustion/chemFoam/chemFoam.C +++ b/applications/solvers/combustion/chemFoam/chemFoam.C @@ -32,7 +32,6 @@ Description provide comparison against other chemistry solvers, that uses a single cell mesh, and fields created from the initial conditions. - \*---------------------------------------------------------------------------*/ #include "fvCFD.H" @@ -49,6 +48,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for chemistry problems, designed for use on single cell cases" + " to provide comparison against other chemistry solvers" + ); + argList::noParallel(); #define CREATE_MESH createSingleCellMesh.H diff --git a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C index cd1f853c25..70a3303cd2 100644 --- a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C +++ b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C @@ -45,6 +45,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for cold-flow in internal combustion engines." + ); + #define CREATE_TIME createEngineTime.H #define CREATE_MESH createEngineMesh.H #include "postProcess.H" diff --git a/applications/solvers/combustion/fireFoam/fireFoam.C b/applications/solvers/combustion/fireFoam/fireFoam.C index 0559abf21e..2498023e50 100644 --- a/applications/solvers/combustion/fireFoam/fireFoam.C +++ b/applications/solvers/combustion/fireFoam/fireFoam.C @@ -50,6 +50,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for fires and turbulent diffusion flames" + " with reacting particle clouds, surface film and pyrolysis modelling." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/combustion/reactingFoam/reactingFoam.C b/applications/solvers/combustion/reactingFoam/reactingFoam.C index 0092fe97a5..d8bca088c8 100644 --- a/applications/solvers/combustion/reactingFoam/reactingFoam.C +++ b/applications/solvers/combustion/reactingFoam/reactingFoam.C @@ -47,6 +47,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for combustion with chemical reactions" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C index cca3dd36dd..e5f998d44b 100644 --- a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C +++ b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C @@ -28,7 +28,7 @@ Group grpCombustionSolvers Description - Solver for combustion with chemical reactions using a density based + Solver for combustion with chemical reactions using a density-based thermodynamics package with enhanced buoyancy treatment. \*---------------------------------------------------------------------------*/ @@ -47,6 +47,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for combustion with chemical reactions using density-based" + " thermodynamics package," + " with enhanced buoyancy treatment." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C index bc47c57f85..bf9988b2cb 100644 --- a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C +++ b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C @@ -28,7 +28,7 @@ Group grpCombustionSolvers Description - Solver for combustion with chemical reactions using density based + Solver for combustion with chemical reactions using density-based thermodynamics package. \*---------------------------------------------------------------------------*/ @@ -48,6 +48,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for combustion with chemical reactions using density-based" + " thermodynamics package." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C index f30c778488..e4eff920de 100644 --- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C +++ b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C @@ -28,8 +28,9 @@ Group grpCompressibleSolvers grpMovingMeshSolvers Description - Density-based compressible flow solver based on central-upwind schemes of - Kurganov and Tadmor with support for mesh-motion and topology changes. + Density-based compressible flow solver based on central-upwind + schemes of Kurganov and Tadmor + with support for mesh-motion and topology changes. \*---------------------------------------------------------------------------*/ @@ -47,6 +48,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Density-based compressible flow solver based on central-upwind" + " schemes of Kurganov and Tadmor.\n" + "With support for mesh-motion and topology changes." + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C index 89066b01c9..f0dc1a37dd 100644 --- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C +++ b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C @@ -28,8 +28,8 @@ Group grpCompressibleSolvers Description - Density-based compressible flow solver based on central-upwind schemes of - Kurganov and Tadmor. + Density-based compressible flow solver based on central-upwind + schemes of Kurganov and Tadmor. \*---------------------------------------------------------------------------*/ @@ -45,6 +45,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Density-based compressible flow solver based on central-upwind" + " schemes of Kurganov and Tadmor." + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C b/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C index 1a21d32d22..83a16ef3fa 100644 --- a/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C +++ b/applications/solvers/compressible/rhoPimpleAdiabaticFoam/rhoPimpleAdiabaticFoam.C @@ -58,6 +58,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for laminar or turbulent flow" + " of weakly compressible fluids for low Mach number" + " aeroacoustic applications." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C b/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C index b8439d075a..0202157732 100644 --- a/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C +++ b/applications/solvers/compressible/rhoPimpleFoam/overRhoPimpleDyMFoam/overRhoPimpleDyMFoam.C @@ -54,6 +54,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible turbulent flow.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "setRootCase.H" #include "createTime.H" #include "createDynamicFvMesh.H" diff --git a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C index 8ce729365b..c27f505131 100644 --- a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C +++ b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C @@ -52,6 +52,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible turbulent flow.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C index d72329b0f9..54ce9757b4 100644 --- a/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C +++ b/applications/solvers/compressible/rhoSimpleFoam/overRhoSimpleFoam/overRhoSimpleFoam.C @@ -28,7 +28,7 @@ Group grpCompressibleSolvers Description - Overset steady-state solver for turbulent flow of compressible fluids. + Overset steady-state solver for compressible turbulent flow. \*---------------------------------------------------------------------------*/ @@ -47,6 +47,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Overset steady-state solver for compressible turbulent flow" + ); + #define CREATE_MESH createUpdatedDynamicFvMesh.H #include "postProcess.H" diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C index 0283b3823a..5b388b9378 100644 --- a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C +++ b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C @@ -28,8 +28,8 @@ Group grpCompressibleSolvers Description - Steady-state solver for turbulent flow of compressible fluids, with - implicit or explicit porosity treatment and optional sources. + Steady-state solver for compressible turbulent flow, + with implicit or explicit porosity treatment and optional sources. \*---------------------------------------------------------------------------*/ @@ -45,6 +45,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for compressible turbulent flow," + "with implicit or explicit porosity treatment and optional sources." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C index ae8252bbf5..5dd4b21592 100644 --- a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C +++ b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C @@ -28,7 +28,7 @@ Group grpCompressibleSolvers Description - Steady-state solver for turbulent flow of compressible fluids. + Steady-state solver for compressible turbulent flow. \*---------------------------------------------------------------------------*/ @@ -43,6 +43,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for compressible turbulent flow." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C b/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C index 748a455158..07852d4daf 100644 --- a/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C +++ b/applications/solvers/compressible/sonicFoam/sonicDyMFoam/sonicDyMFoam.C @@ -45,6 +45,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for trans-sonic/supersonic, turbulent flow" + " of a compressible gas.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/compressible/sonicFoam/sonicFoam.C b/applications/solvers/compressible/sonicFoam/sonicFoam.C index 1ffbb6738f..bf7811e5fd 100644 --- a/applications/solvers/compressible/sonicFoam/sonicFoam.C +++ b/applications/solvers/compressible/sonicFoam/sonicFoam.C @@ -43,6 +43,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for trans-sonic/supersonic, turbulent flow" + " of a compressible gas." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C index afe963d8cf..98eb4f4dfd 100644 --- a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C +++ b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C @@ -40,6 +40,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for trans-sonic/supersonic, laminar flow" + " of a compressible liquid." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C index 38eb94fc4d..ab51c1e610 100644 --- a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C +++ b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C @@ -28,8 +28,8 @@ Group grpDiscreteMethodsSolvers Description - Direct simulation Monte Carlo (DSMC) solver for, transient, multi-species - flows. + Direct simulation Monte Carlo (DSMC) solver + for transient, multi-species flows. \*---------------------------------------------------------------------------*/ @@ -40,6 +40,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Direct simulation Monte Carlo (DSMC) solver" + " for transient, multi-species flows." + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C index 3bb0a881c3..45b47df908 100644 --- a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C +++ b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C @@ -37,6 +37,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Equilibrate and/or precondition molecular dynamics systems." + ); + #include "addCheckCaseOptions.H" #include "setRootCase.H" #include "createTime.H" diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C index a9bbd6d32f..351882182c 100644 --- a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C +++ b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C @@ -39,6 +39,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Molecular dynamics solver for fluid dynamics." + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C index 075a450441..cd3fd4e9bc 100644 --- a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C +++ b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C @@ -38,6 +38,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for electrostatics." + ); + #include "addCheckCaseOptions.H" #include "setRootCase.H" diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C index e0bc47fe53..679c19536e 100644 --- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C +++ b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C @@ -47,6 +47,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for the magnetic field generated by permanent magnets." + ); + argList::addBoolOption ( "noH", diff --git a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C index 1f9d4e1b8e..d1c8a1f89d 100644 --- a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C +++ b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C @@ -58,6 +58,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for magnetohydrodynamics (MHD):" + " incompressible, laminar flow of a conducting fluid" + " under the influence of a magnetic field." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/financial/financialFoam/financialFoam.C b/applications/solvers/financial/financialFoam/financialFoam.C index c8e8e7b5d0..0c21f956ba 100644 --- a/applications/solvers/financial/financialFoam/financialFoam.C +++ b/applications/solvers/financial/financialFoam/financialFoam.C @@ -40,6 +40,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solves the Black-Scholes equation to price commodities." + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C b/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C index 2f57e0b7a1..0287d535f7 100644 --- a/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C +++ b/applications/solvers/finiteArea/liquidFilmFoam/liquidFilmFoam.C @@ -47,6 +47,12 @@ Author int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible, laminar flow" + " of Newtonian fluids in liquid film formulation." + ); + #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" diff --git a/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C b/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C index daee7e9e59..a49102f175 100644 --- a/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C +++ b/applications/solvers/finiteArea/sphereSurfactantFoam/sphereSurfactantFoam.C @@ -41,6 +41,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Passive finiteArea scalar transport on a sphere" + ); + #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" diff --git a/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C b/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C index 4a0d63a89c..2057706aea 100644 --- a/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C +++ b/applications/solvers/finiteArea/surfactantFoam/surfactantFoam.C @@ -30,7 +30,7 @@ Group grpFiniteAreaSolvers Description - Passive scalar transport equation solver. + Passive scalar transport finiteArea equation solver. \heading Solver details The equation is given by: @@ -65,6 +65,11 @@ Author int main(int argc, char *argv[]) { + argList::addNote + ( + "Passive scalar transport finiteArea equation solver." + ); + #include "setRootCase.H" #include "createTime.H" #include "createMesh.H" diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C index c4b8df08f1..760b4bda4e 100644 --- a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C @@ -59,6 +59,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for buoyant, turbulent flow" + " of incompressible fluids.\n" + "Uses the Boussinesq approximation." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C index 8cc6523fc7..65f04204b1 100644 --- a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C @@ -59,6 +59,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for buoyant, turbulent flow" + " of incompressible fluids." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C index 39de4d6670..f8432dee50 100644 --- a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C @@ -47,6 +47,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for buoyant, turbulent fluid flow" + " of compressible fluids, including radiation." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C index a8fc1a9f35..8d0e60bfd8 100644 --- a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C @@ -44,6 +44,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for buoyant, turbulent fluid flow" + " of compressible fluids, including radiation." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C index e1bf669211..2fba8295db 100644 --- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C +++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C @@ -54,6 +54,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for buoyant, turbulent fluid flow and solid heat" + " conduction with conjugate heat transfer" + " between solid and fluid regions." + ); + #define NO_CONTROL #define CREATE_MESH createMeshesPostProcess.H #include "postProcess.H" diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C index 12c7ac5514..25faa39de7 100644 --- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C +++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C @@ -48,6 +48,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for buoyant, turbulent fluid flow and solid heat" + " conduction with conjugate heat transfer" + " between solid and fluid regions." + ); + #define NO_CONTROL #define CREATE_MESH createMeshesPostProcess.H #include "postProcess.H" diff --git a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C index ea210163c0..ecb753d382 100644 --- a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C +++ b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C @@ -45,6 +45,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for energy transport and thermodynamics on a frozen flow field" + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C index 3094f0c719..9bdca6d939 100644 --- a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C +++ b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C @@ -72,6 +72,13 @@ void zeroCells int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, turbulent flow" + " of non-Newtonian fluids with duct shape optimisation" + " by applying 'blockage' in regions causing pressure loss" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C index d9ec41c0ab..53e2ed6422 100644 --- a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C +++ b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C @@ -28,8 +28,8 @@ Group grpIncompressibleSolvers Description - Steady-state solver for incompressible, 1D turbulent flow, typically to - generate boundary layer conditions at an inlet. + Steady-state solver for incompressible, 1D turbulent flow, + typically to generate boundary layer conditions at an inlet. Boundary layer code to calculate the U, k and epsilon distributions. Used to create inlet boundary conditions for experimental comparisons @@ -49,6 +49,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, 1D turbulent flow," + " typically to generate boundary layer conditions at an inlet." + ); + argList::noParallel(); #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/icoFoam/icoFoam.C b/applications/solvers/incompressible/icoFoam/icoFoam.C index eab1372654..6e07a47e33 100644 --- a/applications/solvers/incompressible/icoFoam/icoFoam.C +++ b/applications/solvers/incompressible/icoFoam/icoFoam.C @@ -67,6 +67,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible, laminar flow" + " of Newtonian fluids." + ); + #include "addCheckCaseOptions.H" #include "setRootCase.H" #include "createTime.H" diff --git a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C index 71656d3527..da675122f8 100644 --- a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C +++ b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C @@ -40,6 +40,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible laminar flow" + " of non-Newtonian fluids." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C index 3fd55b434d..3bb41802da 100644 --- a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C @@ -28,8 +28,8 @@ Group grpIncompressibleSolvers Description - Large time-step transient solver for incompressible, turbulent flow in a - single rotating frame. + Large time-step transient solver for incompressible flow + in a single rotating frame. Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. @@ -46,6 +46,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Large time-step transient solver for incompressible flow" + " in a single rotating frame." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C b/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C index 4084953c8e..75f02c44cc 100644 --- a/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/overPimpleDyMFoam/overPimpleDyMFoam.C @@ -28,7 +28,7 @@ Group grpIncompressibleSolvers grpMovingMeshSolvers Description - Transient solver for incompressible, flow of Newtonian fluids + Transient solver for incompressible flow of Newtonian fluids on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm. Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. @@ -54,6 +54,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible, turbulent flow" + " on a moving mesh." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C index e12c04827f..9f801ddfe1 100644 --- a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C @@ -79,6 +79,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible, turbulent flow" + " of Newtonian fluids on a moving mesh." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/pisoFoam/pisoFoam.C b/applications/solvers/incompressible/pisoFoam/pisoFoam.C index d2e3efd2fb..dac62ec676 100644 --- a/applications/solvers/incompressible/pisoFoam/pisoFoam.C +++ b/applications/solvers/incompressible/pisoFoam/pisoFoam.C @@ -75,6 +75,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for incompressible, turbulent flow," + " using the PISO algorithm." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C index fa643a7a47..dd3d5b10eb 100644 --- a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C +++ b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C @@ -42,6 +42,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for inviscid shallow-water equations with rotation" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C index 4b0cbe1547..2a61cae499 100644 --- a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C @@ -44,6 +44,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, turbulent flow" + " of non-Newtonian fluids in a single rotating frame." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C index 6a4bf928cf..c97cd24506 100644 --- a/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/overSimpleFoam/overSimpleFoam.C @@ -79,6 +79,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, turbulent flow" + ); + #define CREATE_MESH createUpdatedDynamicFvMesh.H #include "postProcess.H" diff --git a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C index 909a5b61b5..e4649d2839 100644 --- a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C @@ -45,6 +45,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, turbulent flow with" + "implicit/explicit porosity treatment\n" + "With MRF support." + ); + #define CREATE_FIELDS_2 createPorousZones.H #include "postProcess.H" diff --git a/applications/solvers/incompressible/simpleFoam/simpleFoam.C b/applications/solvers/incompressible/simpleFoam/simpleFoam.C index 839dd3ddd6..964f383340 100644 --- a/applications/solvers/incompressible/simpleFoam/simpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/simpleFoam.C @@ -28,7 +28,7 @@ Group grpIncompressibleSolvers Description - Steady-state solver for incompressible flows with turbulence modelling. + Steady-state solver for incompressible, turbulent flows. \heading Solver details The solver uses the SIMPLE algorithm to solve the continuity equation: @@ -71,6 +71,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for incompressible, turbulent flows." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C index c1d2472921..1bdb4cdb16 100644 --- a/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C +++ b/applications/solvers/lagrangian/DPMFoam/DPMDyMFoam/DPMDyMFoam.C @@ -48,6 +48,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the coupled transport of a" + " single kinematic particle cloud including the effect" + " of the volume fraction of particles on the continuous phase.\n" + "With optional mesh motion and mesh topology changes." + ); argList::addOption ( "cloudName", diff --git a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C index 0ca222fa48..84f0b12200 100644 --- a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C +++ b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C @@ -49,6 +49,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the coupled transport of a" + " single kinematic particle cloud including the effect" + " of the volume fraction of particles on the continuous phase." + ); argList::addOption ( "cloud", diff --git a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C index a6f89528ab..4fd9a7ee64 100644 --- a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C +++ b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C @@ -51,6 +51,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible, turbulent flow" + " with coal and limestone clouds, energy sources and combustion." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C index 418935b5c7..325be06b14 100644 --- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C +++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C @@ -45,6 +45,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the passive transport" + " of a single kinematic particle cloud.\n" + "With optional mesh motion and mesh topology changes." + ); argList::addOption ( "cloud", diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C index 775e12099b..d44fce500a 100644 --- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C +++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C @@ -44,6 +44,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the passive transport" + " of a single kinematic particle cloud" + ); argList::addOption ( "cloud", diff --git a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C index e8bf311392..0a974bf082 100644 --- a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C +++ b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C @@ -51,6 +51,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible, turbulent flow" + " with reacting, multiphase particle clouds" + " and surface film modelling." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C index 00cdee6b1c..809e15b224 100644 --- a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C +++ b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C @@ -25,7 +25,7 @@ Application simpleReactingParcelFoam Description - Steady state solver for compressible, turbulent flow with reacting, + Steady-state solver for compressible, turbulent flow with reacting, multiphase particle clouds and optional sources/constraints. \*---------------------------------------------------------------------------*/ @@ -54,6 +54,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for compressible, turbulent flow" + " with reacting, multiphase particle clouds" + " and optional sources/constraints." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C b/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C index 5c2a11b43b..69c432bcc4 100644 --- a/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C +++ b/applications/solvers/lagrangian/simpleCoalParcelFoam/simpleCoalParcelFoam.C @@ -28,7 +28,7 @@ Group grpLagrangianSolvers Description - Steady state solver for compressible, turbulent flow with coal particle + Steady-state solver for compressible, turbulent flow with coal particle clouds and optional sources/constraints. \*---------------------------------------------------------------------------*/ @@ -49,6 +49,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state solver for compressible, turbulent flow" + " with coal particle clouds and optional sources/constraints." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C b/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C index d1f28f1f00..64ed862cb6 100644 --- a/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/engineFoam/engineFoam.C @@ -46,6 +46,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible, turbulent engine flow" + " with a spray particle cloud." + ); + #define CREATE_TIME createEngineTime.H #define CREATE_MESH createEngineMesh.H #include "postProcess.H" diff --git a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C index 13804c76ca..7cb9d3d910 100644 --- a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C @@ -49,6 +49,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible, turbulent flow" + " with a spray particle cloud.\n" + "With optional mesh motion and mesh topology changes.\n" + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C index 3a7ded9055..ee1c1c1596 100644 --- a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C @@ -47,6 +47,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for compressible, turbulent flow" + " with a spray particle cloud." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C index 81b323c5d3..3d27c93a6c 100644 --- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C +++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelDyMFoam/uncoupledKinematicParcelDyMFoam.C @@ -27,7 +27,7 @@ Application Description Transient solver for the passive transport of a particle cloud. - Uses a pre- calculated velocity field to evolve the cloud. + Uses a pre-calculated velocity field to evolve the cloud. \*---------------------------------------------------------------------------*/ @@ -41,6 +41,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the passive transport of a particle cloud" + " with optional mesh motion" + "Uses a pre-calculated velocity field to evolve the cloud." + ); argList::addOption ( "cloudName", diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C index 4ac6e57a65..4c0f64db55 100644 --- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C +++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C @@ -30,7 +30,7 @@ Group Description Transient solver for the passive transport of a particle cloud. - Uses a pre- calculated velocity field to evolve the cloud. + Uses a pre-calculated velocity field to evolve the cloud. \*---------------------------------------------------------------------------*/ @@ -43,6 +43,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient solver for the passive transport of a particle cloud.\n" + "Uses a pre-calculated velocity field to evolve the cloud." + ); argList::addOption ( "cloud", diff --git a/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C b/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C index d88736572a..2e3858251c 100644 --- a/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C +++ b/applications/solvers/multiphase/MPPICInterFoam/MPPICInterFoam.C @@ -25,7 +25,7 @@ Application MPPICInterFoam Description - Solver for 2 incompressible, isothermal immiscible fluids using a VOF + Solver for two incompressible, isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. The momentum and other fluid properties are of the "mixture" and a single momentum equation is solved. @@ -56,6 +56,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids using" + " VOF phase-fraction based interface capturing.\n" + "Includes MRF and an MPPIC cloud." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C index 71012644e7..788d717012 100644 --- a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C +++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C @@ -28,8 +28,8 @@ Group grpMultiphaseSolvers grpMovingMeshSolvers Description - Transient cavitation code based on the homogeneous equilibrium model - from which the compressibility of the liquid/vapour "mixture" is obtained, + Transient cavitation solver based on the homogeneous equilibrium model + from which the compressibility of the liquid/vapour 'mixture' is obtained, with optional mesh motion and mesh topology changes. Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. @@ -48,6 +48,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient cavitation solver based on the homogeneous equilibrium" + " model from which the compressibility of the liquid/vapour 'mixture'" + " is obtained.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C index 5dcea1f0c1..5d27662009 100644 --- a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C +++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C @@ -28,8 +28,8 @@ Group grpMultiphaseSolvers Description - Transient cavitation code based on the homogeneous equilibrium model - from which the compressibility of the liquid/vapour "mixture" is obtained. + Transient cavitation solver based on the homogeneous equilibrium model + from which the compressibility of the liquid/vapour 'mixture' is obtained. Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. @@ -45,6 +45,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient cavitation solver based on the homogeneous equilibrium" + " model from which the compressibility of the liquid/vapour 'mixture'" + " is obtained." + ); #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C index 26858eea90..8799c3384e 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C +++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C @@ -25,7 +25,7 @@ Application compressibleInterDyMFoam Description - Solver for 2 compressible, non-isothermal immiscible fluids using a VOF + Solver for two compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. @@ -54,6 +54,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two compressible, non-isothermal immiscible fluids" + " using VOF phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C index 1d169e30d4..ff701f853e 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C +++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFilmFoam/compressibleInterFilmFoam.C @@ -25,7 +25,7 @@ Application compressibleInterFoam Description - Solver for 2 compressible, non-isothermal immiscible fluids using a VOF + Solver for two compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. The momentum and other fluid properties are of the "mixture" and a single @@ -53,6 +53,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two compressible, non-isothermal immiscible fluids" + " using VOF phase-fraction based interface capturing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C index 7604768d8d..f96daf82c4 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C +++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for 2 compressible, non-isothermal immiscible fluids using a VOF + Solver for two compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. The momentum and other fluid properties are of the "mixture" and a single @@ -56,6 +56,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two compressible, non-isothermal immiscible fluids" + " using VOF phase-fraction based interface capturing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C index fef72cbb7a..2481677353 100644 --- a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C +++ b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for n compressible, non-isothermal immiscible fluids using a VOF + Solver for N compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. The momentum and other fluid properties are of the "mixture" and a single @@ -47,6 +47,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for N compressible, non-isothermal immiscible fluids" + " using VOF phase-fraction based interface capturing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C index 6034716845..2c178ea557 100644 --- a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C +++ b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C @@ -28,11 +28,11 @@ Group grpMultiphaseSolvers Description - Solver for 2 incompressible fluids using the mixture approach with the - drift-flux approximation for relative motion of the phases. + Solver for two incompressible fluids using the mixture approach with + the drift-flux approximation for relative motion of the phases. - Used for simulating the settling of the dispersed phase and other similar - separation problems. + Used for simulating the settling of the dispersed phase and other + similar separation problems. \*---------------------------------------------------------------------------*/ @@ -52,6 +52,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible fluids using the mixture approach with" + " the drift-flux approximation for relative motion of the phases.\n" + "Used for simulating the settling of the dispersed phase and other" + " similar separation problems." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C index a3de274602..3791fc60f2 100644 --- a/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C +++ b/applications/solvers/multiphase/icoReactingMultiphaseInterFoam/icoReactingMultiphaseInterFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for n incompressible, non-isothermal immiscible fluids with + Solver for N incompressible, non-isothermal immiscible fluids with phase-change. Uses a VOF (volume of fluid) phase-fraction based interface capturing approach. @@ -55,6 +55,15 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for N incompressible, non-isothermal immiscible fluids with" + " phase-change," + " using VOF phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C b/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C index 6e28f57f5d..5bd2767e3e 100644 --- a/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C +++ b/applications/solvers/multiphase/interCondensatingEvaporatingFoam/interCondensatingEvaporatingFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for 2 incompressible, non-isothermal immiscible fluids with + Solver for two incompressible, non-isothermal immiscible fluids with phase-change (evaporation-condensation) between a fluid and its vapour. Uses a VOF (volume of fluid) phase-fraction based interface capturing approach. @@ -56,6 +56,15 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, non-isothermal immiscible fluids with" + " phase-change," + " using VOF phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/interFoam/interFoam.C b/applications/solvers/multiphase/interFoam/interFoam.C index 5b8d2e8b3e..154f85c1de 100644 --- a/applications/solvers/multiphase/interFoam/interFoam.C +++ b/applications/solvers/multiphase/interFoam/interFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for 2 incompressible, isothermal immiscible fluids using a VOF + Solver for two incompressible, isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. @@ -53,6 +53,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids" + " using VOF phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C index a065444dde..54cfe26f7d 100644 --- a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C +++ b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C @@ -50,6 +50,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for three incompressible fluids (two of which are immiscible)" + " using VOF phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C b/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C index 7f1df58eb9..fbcc6ee8e1 100644 --- a/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C +++ b/applications/solvers/multiphase/interFoam/overInterDyMFoam/overInterDyMFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers grpMovingMeshSolvers Description - Solver for 2 incompressible, isothermal immiscible fluids using a VOF + Solver for two incompressible, isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. @@ -59,6 +59,14 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids using" + " VOF phase-fraction based interface capturing\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C b/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C index b7d12f5741..131cebd555 100644 --- a/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C +++ b/applications/solvers/multiphase/interIsoFoam/interIsoFoam.C @@ -31,7 +31,7 @@ Group grpMultiphaseSolvers Description - Solver derived from interFoam for 2 incompressible, isothermal immiscible + Solver derived from interFoam for two incompressible, isothermal immiscible fluids using the isoAdvector phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. @@ -66,6 +66,15 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids" + " using isoAdvector phase-fraction based interface capturing.\n" + "With optional mesh motion and mesh topology changes including" + " adaptive re-meshing.\n" + "The solver is derived from interFoam" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C index 87e960fd63..dd80f4dc14 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C +++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C @@ -28,10 +28,11 @@ Group grpMultiphaseSolvers grpMovingMeshSolvers Description - Solver for 2 incompressible, isothermal immiscible fluids with phase-change - (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based - interface capturing approach, with optional mesh motion and mesh topology - changes including adaptive re-meshing. + Solver for two incompressible, isothermal immiscible fluids with + phase-change (e.g. cavitation). + Uses VOF (volume of fluid) phase-fraction based interface capturing, + with optional mesh motion and mesh topology changes including + adaptive re-meshing. The momentum and other fluid properties are of the "mixture" and a single momentum equation is solved. @@ -59,6 +60,15 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids with" + " phase-change.\n" + "Uses VOF (volume of fluid) phase-fraction based interface capturing," + " with optional mesh motion and mesh topology changes including" + " adaptive re-meshing." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C index 2fe1e45038..6009d9ea87 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C +++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C @@ -28,9 +28,9 @@ Group grpMultiphaseSolvers Description - Solver for 2 incompressible, isothermal immiscible fluids with phase-change - (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based - interface capturing approach. + Solver for two incompressible, isothermal immiscible fluids with + phase-change (e.g. cavitation). + Uses VOF (volume of fluid) phase-fraction based interface capturing. The momentum and other fluid properties are of the "mixture" and a single momentum equation is solved. @@ -56,6 +56,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for two incompressible, isothermal immiscible fluids with" + " phase-change.\n" + "Uses VOF (volume of fluid) phase-fraction based interface capturing." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C index 4d42facea1..8dcbd7ed1d 100644 --- a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C +++ b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C @@ -48,6 +48,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for a system of many compressible fluid phases including" + " heat-transfer." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C index 478dcccdb1..85f5813843 100644 --- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C +++ b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for n incompressible fluids which captures the interfaces and + Solver for N incompressible fluids which captures the interfaces and includes surface-tension and contact-angle effects for each phase, with optional mesh motion and mesh topology changes. @@ -48,6 +48,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for N incompressible fluids which captures the interfaces and" + " includes surface-tension and contact-angle effects for each phase.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C index 9c0bb8d4c3..b4cf64fd24 100644 --- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C +++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C @@ -53,6 +53,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Incompressible Navier-Stokes solver with inclusion of a wave height" + " field to enable single-phase free-surface approximations.\n" + "With optional mesh motion and mesh topology changes." + ); + #include "postProcess.H" #include "setRootCase.H" diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C index e7502f67e0..4eec2e5f96 100644 --- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C +++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C @@ -47,6 +47,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Incompressible Navier-Stokes solver with inclusion of a wave height" + " field to enable single-phase free-surface approximations." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C index 4eeaa5ab1f..b9ea18cf24 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C @@ -46,6 +46,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for a system of any number of compressible fluid phases with a" + " common pressure, but otherwise separate properties." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C index c4c49f3a09..01e0307fb3 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for a system of 2 compressible fluid phases with a common pressure, + Solver for a system of two compressible fluid phases with a common pressure, but otherwise separate properties. The type of phase model is run time selectable and can optionally represent multiple species and in-phase reactions. The phase system is also run time selectable and can optionally @@ -75,6 +75,12 @@ namespace Foam int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for a system of two compressible fluid phases with a" + " common pressure, but otherwise separate properties." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C index 0df1d48c5f..0fcbfbac1f 100644 --- a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C +++ b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C @@ -28,7 +28,7 @@ Group grpMultiphaseSolvers Description - Solver for mixing 2 incompressible fluids. + Solver for mixing two incompressible fluids. Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. @@ -45,6 +45,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for mixing two incompressible fluids" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C index 9ad83f5275..bc213139ef 100644 --- a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C +++ b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C @@ -28,8 +28,8 @@ Group grpMultiphaseSolvers Description - Solver for a system of 2 compressible fluid phases with one phase - dispersed, e.g. gas bubbles in a liquid including heat-transfer. + Solver for a system of two compressible fluid phases with one dispersed + phase. Eg, gas bubbles in a liquid including heat-transfer. \*---------------------------------------------------------------------------*/ @@ -44,6 +44,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Solver for a system of two compressible fluid phases with one" + " dispersed phase.\n" + "Eg, gas bubbles in a liquid including heat-transfer." + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C index eb5707d292..2e053d8590 100644 --- a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C +++ b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C @@ -44,6 +44,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Transient segregated finite-volume solver of linear-elastic," + " small-strain deformation of a solid body, with optional thermal" + " diffusion and thermal stresses" + ); + #include "postProcess.H" #include "addCheckCaseOptions.H" diff --git a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C index 29e8b70108..5a92ca839f 100644 --- a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C +++ b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C @@ -44,6 +44,13 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Steady-state segregated finite-volume solver of linear-elastic," + " small-strain deformation of a solid body, with optional thermal" + " diffusion and thermal stresses" + ); + #define NO_CONTROL #include "postProcess.H" diff --git a/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C b/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C index 29e7fd8c15..a0c307ea6a 100644 --- a/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C +++ b/applications/utilities/finiteArea/checkFaMesh/checkFaMesh.C @@ -27,7 +27,7 @@ Application makeFaMesh Description - Check a Finite Area mesh + Check a finiteArea mesh Author Zeljko Tukovic, FAMENA @@ -46,6 +46,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Check a finiteArea mesh" + ); + #include "addRegionOption.H" #include "setRootCase.H" diff --git a/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C b/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C index d9f1dea5f4..fd556855de 100644 --- a/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C +++ b/applications/utilities/finiteArea/makeFaMesh/makeFaMesh.C @@ -27,7 +27,7 @@ Application makeFaMesh Description - A mesh generator for finite area mesh. + A mesh generator for finiteArea mesh. Author Zeljko Tukovic, FAMENA @@ -69,6 +69,11 @@ public: int main(int argc, char *argv[]) { + argList::addNote + ( + "A mesh generator for finiteArea mesh" + ); + #include "addRegionOption.H" argList::noParallel(); diff --git a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C index b54edbda5b..3aa52a84c1 100644 --- a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C +++ b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C @@ -614,6 +614,10 @@ label findPatch(const polyBoundaryMesh& patches, const word& patchName) int main(int argc, char *argv[]) { + argList::addNote + ( + "Mesh and field preparation utility for PDR type simulations." + ); #include "addOverwriteOption.H" argList::noFunctionObjects(); // Never use function objects diff --git a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C index f23d474a83..7fbcb7c9bd 100644 --- a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C +++ b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C @@ -63,13 +63,12 @@ using namespace Foam; int main(int argc, char *argv[]) { - timeSelector::addOptions(true, false); argList::addNote ( "Collapses small edges to a point.\n" "Optionally collapse small faces to a point and thin faces to an edge." ); - + timeSelector::addOptions(true, false); // constant(true), zero(false) argList::addBoolOption ( "collapseFaces", diff --git a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C index 577f743570..0b276b24b0 100644 --- a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C +++ b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Checks for multiple patch faces on same cell and combines them. + Checks for multiple patch faces on the same cell and combines them. Multiple patch faces can result from e.g. removal of refined neighbouring cells, leaving 4 exposed faces with same owner. @@ -343,6 +343,11 @@ label mergeEdges(const scalar minCos, polyMesh& mesh) int main(int argc, char *argv[]) { + argList::addNote + ( + "Checks for multiple patch faces on the same cell and combines them." + ); + #include "addOverwriteOption.H" argList::addArgument("featureAngle [0..180]"); diff --git a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C index c522d8f48a..2c482069c7 100644 --- a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C +++ b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Manipulates mesh elements. + Manipulate mesh elements. Actions are: (boundary)points: @@ -336,6 +336,11 @@ label findCell(const primitiveMesh& mesh, const point& nearPoint) int main(int argc, char *argv[]) { + argList::addNote + ( + "Manipulate mesh elements.\n" + "For example, moving points, splitting/collapsing edges etc." + ); #include "addOverwriteOption.H" #include "addDictOption.H" diff --git a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C index 5ea938de40..9946caf392 100644 --- a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C +++ b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Refines a hex mesh by 2x2x2 cell splitting. + Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet. \*---------------------------------------------------------------------------*/ @@ -56,6 +56,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet" + ); #include "addOverwriteOption.H" #include "addRegionOption.H" argList::addArgument("cellSet"); diff --git a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C index 0579c5ef69..9c094f67bf 100644 --- a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C +++ b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Utility to refine cells next to patches. + Refine cells next to specified patches. Arguments: 1: List of patch name regular expressions @@ -61,6 +61,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Refine cells next to specified patches.\n" + "The list of patches may contain regular expressions.\n" + ); + #include "addOverwriteOption.H" argList::addArgument("patches"); argList::addArgument("edgeFraction"); diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C index 44a4aabf25..1e3b1522c5 100644 --- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C +++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C @@ -28,8 +28,8 @@ Group grpMeshAdvancedUtilities Description - Tries to figure out what the refinement level is on refined cartesian - meshes. Run BEFORE snapping. + Attempt to determine the refinement levels of a refined cartesian mesh. + Run BEFORE snapping. Writes - volScalarField 'refinementLevel' with current refinement level. @@ -98,9 +98,14 @@ bool limitRefinementLevel } - int main(int argc, char *argv[]) { + argList::addNote + ( + "Attempt to determine refinement levels of a refined cartesian mesh.\n" + "Run BEFORE snapping!" + ); + argList::addBoolOption ( "readLevel", diff --git a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C index 19b3b3e548..2b41619c45 100644 --- a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C +++ b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Utility to remove faces (combines cells on both sides). + Remove faces specified in faceSet by combining cells on both sides. Takes faceSet of candidates for removal and writes faceSet with faces that will actually be removed. (because e.g. would cause two faces between the @@ -53,6 +53,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Remove faces specified in faceSet by combining cells on both sides" + ); #include "addOverwriteOption.H" argList::addArgument("faceSet"); diff --git a/applications/utilities/mesh/advanced/selectCells/selectCells.C b/applications/utilities/mesh/advanced/selectCells/selectCells.C index 31f918a919..077285c8d0 100644 --- a/applications/utilities/mesh/advanced/selectCells/selectCells.C +++ b/applications/utilities/mesh/advanced/selectCells/selectCells.C @@ -335,6 +335,11 @@ label selectOutsideCells int main(int argc, char *argv[]) { + argList::addNote + ( + "Select cells in relation to surface" + ); + argList::noParallel(); #include "setRootCase.H" diff --git a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C index ee395ee800..aac8ee79f1 100644 --- a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C +++ b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C @@ -28,7 +28,7 @@ Group grpMeshAdvancedUtilities Description - Utility to refine cells near to a surface. + Refine cells near to a surface. \*---------------------------------------------------------------------------*/ @@ -623,6 +623,10 @@ void classifyCells int main(int argc, char *argv[]) { + argList::addNote + ( + "Refine cells near to a surface" + ); argList::noParallel(); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L index d3fd7fe772..796de5b65c 100644 --- a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L +++ b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts an ANSYS input mesh file, exported from I-DEAS, + Convert an ANSYS input mesh file (exported from I-DEAS) to OpenFOAM format. \*---------------------------------------------------------------------------*/ @@ -298,6 +298,12 @@ label findFace(const polyMesh& mesh, const face& f) int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert an ANSYS input mesh file (exported from I-DEAS)" + " to OpenFOAM format" + ); + argList::noParallel(); argList::addArgument("ANSYS input file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C index b0dc6584d1..faf3277b8c 100644 --- a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C +++ b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C @@ -86,7 +86,7 @@ int main(int argc, char *argv[]) "Translate OPENFOAM data to CCM format" ); - Foam::timeSelector::addOptions(); + timeSelector::addOptions(); argList::noParallel(); argList::addBoolOption ( diff --git a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C index 484f5955a9..dcc5dee866 100644 --- a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C +++ b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a CFX 4 mesh to OpenFOAM format. + Convert a CFX 4 mesh to OpenFOAM format. \*---------------------------------------------------------------------------*/ @@ -48,6 +48,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a CFX 4 mesh to OpenFOAM format" + ); + argList::noParallel(); argList::addArgument("CFX geom file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C index 8c295588fe..10269dfc92 100644 --- a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C +++ b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C @@ -28,8 +28,8 @@ Group grpMeshConversionUtilities Description - Reads in a datToFoam mesh file and outputs a points file. Used in - conjunction with blockMesh. + Reads in a datToFoam mesh file and outputs a points file. + Used in conjunction with blockMesh. \*---------------------------------------------------------------------------*/ @@ -45,6 +45,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Reads in a datToFoam mesh file and outputs a points file.\n" + "Used in conjunction with blockMesh." + ); + argList::noParallel(); argList::addArgument("dat file"); diff --git a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C index 63a5c71749..80b6a66f37 100644 --- a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C +++ b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts an AVL/FIRE polyhedral mesh to OPENFOAM + Convert AVL/FIRE polyhedral mesh to OpenFOAM format Usage \b fireToFoam [OPTION] firePolyMesh @@ -60,7 +60,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Convert AVL/FIRE polyhedral mesh to OPENFOAM format" + "Convert AVL/FIRE polyhedral mesh to OpenFOAM format" ); argList::noParallel(); diff --git a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L index f8659f1e82..c8bf3c35c4 100644 --- a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a Fluent mesh to OpenFOAM format. + Convert a Fluent mesh to OpenFOAM format. \*---------------------------------------------------------------------------*/ @@ -773,6 +773,10 @@ endOfSection {space}")"{space} int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a Fluent mesh to OpenFOAM format" + ); argList::noParallel(); argList::addArgument("Fluent mesh file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L index e029457d42..2a81b4c1a8 100644 --- a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a Fluent mesh to OpenFOAM format + Convert a Fluent mesh to OpenFOAM format, including multiple region and region boundary handling. \*---------------------------------------------------------------------------*/ @@ -865,6 +865,11 @@ label findFace(const primitiveMesh& mesh, const face& f) int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a Fluent mesh to OpenFOAM format," + " including multiple region and region boundary handling" + ); argList::noParallel(); argList::addArgument("Fluent mesh file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C index d532e27d5f..b634af7544 100644 --- a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C +++ b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Writes out the OpenFOAM mesh in Fluent mesh format. + Write an OpenFOAM mesh in Fluent mesh format. \*---------------------------------------------------------------------------*/ @@ -42,6 +42,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Write an OpenFOAM mesh in Fluent mesh format" + ); argList::noParallel(); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C index 9a9759df22..8f892fe260 100644 --- a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C +++ b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C @@ -25,7 +25,7 @@ Application foamToFireMesh Description - Reads an OpenFOAM mesh and writes an AVL/FIRE fpma format + Write an OpenFOAM mesh in AVL/FIRE fpma format Usage \b foamToFireMesh [OPTION] @@ -58,7 +58,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Read OpenFOAM mesh and write an AVL/FIRE fpma format" + "Write an OpenFOAM mesh in AVL/FIRE fpma format" ); argList::noParallel(); timeSelector::addOptions(); diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C index c5e4c06ef8..57a5345369 100644 --- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C +++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Reads an OpenFOAM mesh and writes a STARCD/PROSTAR (v4) bnd/cel/vrt format. + Write an OpenFOAM mesh in STARCD/PROSTAR (v4) bnd/cel/vrt format. Usage \b foamToStarMesh [OPTION] @@ -67,7 +67,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Read OpenFOAM mesh and write a STARCD/PROSTAR (v4) bnd/cel/vrt format" + "Write an OpenFOAM mesh in STARCD/PROSTAR (v4) bnd/cel/vrt format" ); argList::noParallel(); timeSelector::addOptions(); diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C index 01b72c42e9..d54a389546 100644 --- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C +++ b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Reads an OpenFOAM mesh and writes the boundaries in a surface format. + Extract boundaries from an OpenFOAM mesh and write in a surface format Usage \b foamToSurface [OPTION] @@ -56,6 +56,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Extract boundaries from an OpenFOAM mesh and write in a surface format" + ); argList::noParallel(); argList::addArgument("outputFile.ext"); timeSelector::addOptions(); diff --git a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L index dfd13995bf..c51a01ab80 100644 --- a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L +++ b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a GAMBIT mesh to OpenFOAM format. + Convert a GAMBIT mesh to OpenFOAM format. \*---------------------------------------------------------------------------*/ @@ -625,6 +625,11 @@ mtype {space}"MTYPE:"{space} int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a GAMBIT mesh to OpenFOAM format" + ); + argList::noParallel(); argList::addArgument("GAMBIT file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C index 51e9221577..acafed87c5 100644 --- a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C +++ b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C @@ -766,6 +766,11 @@ void readCells int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a gmsh .msh file to OpenFOAM" + ); + argList::noParallel(); argList::addArgument(".msh file"); argList::addBoolOption diff --git a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C index 6759d39ce4..67775f3e2f 100644 --- a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C +++ b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C @@ -648,6 +648,10 @@ label findPatch(const List& dofGroups, const face& f) int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert I-Deas unv format to OpenFOAM" + ); argList::noParallel(); argList::addArgument(".unv file"); argList::addBoolOption diff --git a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C index 7dd4c2a6a1..8f64f5e616 100644 --- a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C +++ b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a KIVA3v grid to OpenFOAM format. + Convert a KIVA3v grid to OpenFOAM. \*---------------------------------------------------------------------------*/ @@ -58,6 +58,10 @@ enum kivaVersions int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a KIVA3v grid to OpenFOAM" + ); argList::noParallel(); argList::addOption ( diff --git a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C index ae2973be24..cc6f1ebd23 100644 --- a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C +++ b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts .msh file generated by the Adventure system. + Convert .msh file generated by the Adventure system. Note: the .msh format does not contain any boundary information. It is purely a description of the internal mesh. @@ -59,6 +59,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert an Adventure .msh file to OpenFOAM" + ); argList::noParallel(); argList::addArgument(".msh file"); argList::addBoolOption diff --git a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C index 48b55bd14b..bd91cc1b28 100644 --- a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C +++ b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts neutral file format as written by Netgen v4.4. + Convert a neutral file format (Netgen v4.4) to OpenFOAM. Example: @@ -92,6 +92,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert a neutral file format (Netgen v4.4) to OpenFOAM" + ); argList::addArgument("Neutral file"); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C index 31beb1eb9b..69c00af00a 100644 --- a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C +++ b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C @@ -58,6 +58,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Plot3d mesh (ascii/formatted format) converter" + ); argList::noParallel(); argList::addArgument("PLOT3D geom file"); argList::addOption diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C index 13d08dfdd0..1a18f874ab 100644 --- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C +++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts a STARCD/PROSTAR (v4) mesh into OpenFOAM format. + Convert a STARCD/PROSTAR (v4) mesh into OpenFOAM format. Usage \b star4ToFoam [OPTION] prostarMesh diff --git a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C index 7917e5053d..8b11cdf887 100644 --- a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C +++ b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C @@ -28,7 +28,7 @@ Group grpMeshConversionUtilities Description - Converts .ele and .node and .face files, written by tetgen. + Convert tetgen .ele and .node and .face files to an OpenFOAM mesh. Make sure to use add boundary attributes to the smesh file (5 fifth column in the element section) @@ -101,6 +101,11 @@ label findFace(const primitiveMesh& mesh, const face& f) int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert tetgen .ele and .node and .face files to an OpenFOAM mesh" + ); + argList::addArgument("file prefix"); argList::addBoolOption ( diff --git a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C index 9b5e480554..1d1fc344f1 100644 --- a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C +++ b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C @@ -28,11 +28,12 @@ Group grpMeshConversionUtilities Description - Converts ascii .vtk (legacy format) file generated by vtk/paraview. - - Note: the .vtk format does not contain any boundary information. It is - purely a description of the internal mesh. + Convert legacy VTK file (ascii) containing an unstructured grid + to an OpenFOAM mesh without boundary information. +Note + The .vtk format does not contain any boundary information. + It is purely a description of the internal mesh. Not extensively tested. \*---------------------------------------------------------------------------*/ @@ -50,6 +51,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert legacy VTK file (ascii) containing an unstructured grid" + " to an OpenFOAM mesh without boundary information" + ); + argList::noParallel(); argList::addArgument(".vtk ascii file"); diff --git a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C index fefdd463cd..967ffb5234 100644 --- a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C +++ b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C @@ -261,6 +261,11 @@ void changeFrontBackPatches int main(int argc, char *argv[]) { + argList::addNote + ( + "Extrude mesh from existing patch." + ); + #include "addRegionOption.H" #include "setRootCase.H" #include "createTimeExtruded.H" diff --git a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C index 44bd1b4367..9569e7a253 100644 --- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C +++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C @@ -1462,7 +1462,10 @@ void extrudeGeometricProperties int main(int argc, char *argv[]) { - argList::addNote("Create region mesh by extruding a faceZone or faceSet"); + argList::addNote + ( + "Create region mesh by extruding a faceZone or faceSet" + ); #include "addRegionOption.H" #include "addOverwriteOption.H" diff --git a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C index 82f0dd43a9..40f8f31c66 100644 --- a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C +++ b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C @@ -28,8 +28,8 @@ Group grpMeshGenerationUtilities Description - Takes 2D mesh (all faces 2 points only, no front and back faces) and - creates a 3D mesh by extruding with specified thickness. + Create a 3D mesh by extruding a 2D mesh with specified thickness. + For the 2D mesh, all faces are 2 points only, no front and back faces. Note Not sure about the walking of the faces to create the front and back faces. @@ -110,6 +110,11 @@ static const Enum ExtrudeModeNames int main(int argc, char *argv[]) { + argList::addNote + ( + "Create a 3D mesh from a 2D mesh by extruding with specified thickness" + ); + argList::addArgument("surfaceFormat"); #include "addOverwriteOption.H" diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C index d1a5fd797d..3c2a8be40a 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C @@ -45,6 +45,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Conformal Voronoi automatic mesh generator" + ); argList::addBoolOption ( "checkGeometry", diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C index b2218d48d8..f6545e6dda 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C @@ -53,6 +53,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Conformal Voronoi 2D automatic mesh generator" + ); + argList::noParallel(); argList::addOption("pointsFile", "filename"); diff --git a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C index 9ca3abd566..1a1e4b7d5d 100644 --- a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C +++ b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C @@ -43,6 +43,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Attach topologically detached mesh using prescribed mesh modifiers" + ); + #include "addOverwriteOption.H" argList::noParallel(); diff --git a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C index 8e9e884847..216f0b1f78 100644 --- a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C +++ b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C @@ -73,6 +73,11 @@ void collectFeatureEdges(const boundaryMesh& bMesh, labelList& markedEdges) int main(int argc, char *argv[]) { + argList::addNote + ( + "Divides external faces into patches based on feature angle" + ); + #include "addOverwriteOption.H" argList::noParallel(); diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C index df9e19dd24..c86db130f2 100644 --- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C +++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C @@ -81,6 +81,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Checks validity of a mesh" + ); + timeSelector::addOptions(); #include "addRegionOption.H" argList::addBoolOption @@ -112,7 +117,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "meshQuality", - "Read user-defined mesh quality criterions from system/meshQualityDict" + "Read user-defined mesh quality criteria from system/meshQualityDict" ); argList::addOption ( diff --git a/applications/utilities/mesh/manipulation/createPatch/createPatch.C b/applications/utilities/mesh/manipulation/createPatch/createPatch.C index 596b646dcc..d3acb0013d 100644 --- a/applications/utilities/mesh/manipulation/createPatch/createPatch.C +++ b/applications/utilities/mesh/manipulation/createPatch/createPatch.C @@ -28,12 +28,12 @@ Group grpMeshManipulationUtilities Description - Utility to create patches out of selected boundary faces. Faces come either + Create patches out of selected boundary faces, which are either from existing patches or from a faceSet. More specifically it: - - creates new patches (from selected boundary faces). Synchronise faces - on coupled patches. + - creates new patches (from selected boundary faces). + Synchronise faces on coupled patches. - synchronises points on coupled boundaries - remove patches with 0 faces in them @@ -510,6 +510,12 @@ void syncPoints int main(int argc, char *argv[]) { + argList::addNote + ( + "Create patches out of selected boundary faces, which are either" + " from existing patches or from a faceSet" + ); + #include "addOverwriteOption.H" #include "addRegionOption.H" #include "addDictOption.H" diff --git a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C index 81f027fcf7..673990720e 100644 --- a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C +++ b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C @@ -44,6 +44,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Deforms a polyMesh using a displacement field U and a scaling factor" + " supplied as an argument" + ); + argList::addArgument("scaling factor"); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C index 9c2a48d6ee..3cd919caf3 100644 --- a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C +++ b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C @@ -44,6 +44,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Flattens the front and back planes of a 2D cartesian mesh" + ); + #include "setRootCase.H" #include "createTime.H" #include "createPolyMesh.H" diff --git a/applications/utilities/mesh/manipulation/insideCells/insideCells.C b/applications/utilities/mesh/manipulation/insideCells/insideCells.C index a3044092d2..b26c63cf53 100644 --- a/applications/utilities/mesh/manipulation/insideCells/insideCells.C +++ b/applications/utilities/mesh/manipulation/insideCells/insideCells.C @@ -28,7 +28,8 @@ Group grpMeshManipulationUtilities Description - Picks up cells with cell centre 'inside' of surface. + Create a cellSet for cells with their centres 'inside' the defined + surface. Requires surface to be closed and singly connected. \*---------------------------------------------------------------------------*/ @@ -50,8 +51,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Create a cellSet for cells with their centres inside the defined " - "surface.\n" + "Create a cellSet for cells with their centres 'inside' the defined" + " surface.\n" "Surface must be closed and singly connected." ); diff --git a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C index 1262ac3fda..6d74e39d28 100644 --- a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C +++ b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C @@ -44,6 +44,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Mirrors a mesh around a given plane." + ); + #include "addOverwriteOption.H" #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C index a56d685d0f..fa73c3d8f3 100644 --- a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C +++ b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C @@ -164,11 +164,16 @@ void writeWeights(const polyMesh& mesh) int main(int argc, char *argv[]) { + argList::addNote + ( + "Mesh motion and topological mesh changes utility" + ); + #include "addRegionOption.H" argList::addBoolOption ( "checkAMI", - "Check AMI weights" + "Check AMI weights and write VTK files of the AMI patches" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C index a9c3181d59..42e56b305c 100644 --- a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C +++ b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C @@ -40,13 +40,15 @@ Description int main(int argc, char *argv[]) { - #include "setRootCase.H" + argList::addNote + ( + "A solver utility for moving meshes for engine calculations" + ); + #include "setRootCase.H" #include "createEngineTime.H" #include "createEngineMesh.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - Info<< "\nStarting time loop\n" << endl; while (runTime.loop()) diff --git a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C index d368859170..f435c70f61 100644 --- a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C +++ b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C @@ -28,7 +28,7 @@ Group grpMeshManipulationUtilities Description - Solver for moving meshes. + A solver utility for moving meshes. \*---------------------------------------------------------------------------*/ @@ -43,6 +43,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "A solver utility for moving meshes" + ); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C index 95508b6d82..145add013b 100644 --- a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C +++ b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C @@ -28,7 +28,7 @@ Group grpMeshManipulationUtilities Description - Read obj line (not surface!) file and convert into vtk. + Read obj line (not surface) file and convert into legacy VTK file. \*---------------------------------------------------------------------------*/ @@ -110,6 +110,11 @@ labelList parseVertices(const string& line) int main(int argc, char *argv[]) { + argList::addNote + ( + "Read obj line (not surface) file and convert into legacy VTK file" + ); + argList::noParallel(); argList::addArgument("OBJ file"); argList::addArgument("output VTK file"); diff --git a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C index 972503c9ec..dd7cbb1dc2 100644 --- a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C +++ b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C @@ -28,7 +28,7 @@ Group grpMeshManipulationUtilities Description - Corrects orientation of faceZone. + Corrects teh orientation of faceZone. - correct in parallel - excludes coupled faceZones from walk - correct for non-manifold faceZones - restarts walk @@ -49,6 +49,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Corrects the orientation of faceZone" + ); #include "addRegionOption.H" argList::addArgument("faceZone"); argList::addArgument("outsidePoint"); diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C index a1cbb287f6..ade2e37574 100644 --- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C +++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C @@ -28,8 +28,7 @@ Group grpMeshManipulationUtilities Description - Calculates the dual of a polyMesh. Adheres to all the feature and patch - edges. + Creates the dual of a polyMesh, adhering to all the feature and patch edges. Usage \b polyDualMesh featureAngle @@ -47,8 +46,8 @@ Usage Normally only constructs a single face between two cells. This single face might be too distorted. splitAllFaces will create a single face for every original cell the face passes through. The mesh will thus have - multiple faces inbetween two cells! (so is not strictly upper-triangular - anymore - checkMesh will complain) + multiple faces in between two cells! (so is not strictly + upper-triangular anymore - checkMesh will complain) - \par -doNotPreserveFaceZones: By default all faceZones are preserved by marking all faces, edges and @@ -360,6 +359,12 @@ void dumpFeatures int main(int argc, char *argv[]) { + argList::addNote + ( + "Creates the dual of a polyMesh," + " adhering to all the feature and patch edges." + ); + #include "addOverwriteOption.H" argList::noParallel(); @@ -367,7 +372,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "splitAllFaces", - "Have multiple faces inbetween cells" + "Have multiple faces in between cells" ); argList::addBoolOption ( @@ -378,7 +383,7 @@ int main(int argc, char *argv[]) ( "doNotPreserveFaceZones", "Disable the default behaviour of preserving faceZones by having" - " multiple faces inbetween cells" + " multiple faces in between cells" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C index 4e15db3fe6..c23210e68b 100644 --- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C +++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C @@ -611,7 +611,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Renumber mesh to minimise bandwidth" + "Renumber mesh cells to reduce the bandwidth" ); #include "addRegionOption.H" diff --git a/applications/utilities/mesh/manipulation/setSet/setSet.C b/applications/utilities/mesh/manipulation/setSet/setSet.C index e37212d160..560cb5db07 100644 --- a/applications/utilities/mesh/manipulation/setSet/setSet.C +++ b/applications/utilities/mesh/manipulation/setSet/setSet.C @@ -28,7 +28,7 @@ Group grpMeshManipulationUtilities Description - Manipulate a cell/face/point/ set or zone interactively. + Manipulate a cell/face/point Set or Zone interactively. \*---------------------------------------------------------------------------*/ @@ -710,10 +710,17 @@ commandStatus parseAction(const word& actionName) int main(int argc, char *argv[]) { + argList::addNote + ( + "Manipulate a cell/face/point Set or Zone interactively." + ); + // Specific to topoSet/setSet: quite often we want to block upon writing // a set so we can immediately re-read it. So avoid use of threading // for set writing. - timeSelector::addOptions(true, false); + + timeSelector::addOptions(true, false); // constant(true), zero(false) + #include "addRegionOption.H" argList::addBoolOption("noVTK", "Do not write VTK files"); argList::addBoolOption("loop", "Execute batch commands for all timesteps"); diff --git a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C index ebf513b2d3..7e56a82115 100644 --- a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C +++ b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C @@ -60,12 +60,12 @@ using namespace Foam; int main(int argc, char *argv[]) { - timeSelector::addOptions(true, false); argList::addNote ( "Add point/face/cell Zones from similarly named point/face/cell Sets" ); + timeSelector::addOptions(true, false); // constant(true), zero(false) argList::addBoolOption ( "noFlipMap", diff --git a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C index 93efe4341f..0540853a99 100644 --- a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C +++ b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C @@ -73,8 +73,13 @@ void interpolateFields int main(int argc, char *argv[]) { - // constant, not false - timeSelector::addOptions(true, false); + argList::addNote + ( + "Map fields to a mesh with all internal faces removed" + " (singleCellFvMesh) which gets written to region 'singleCell'" + ); + + timeSelector::addOptions(true, false); // constant(true), zero(false) #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C index 0fdd9f128b..5626b4367c 100644 --- a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C +++ b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C @@ -113,6 +113,11 @@ void checkPatch(const polyBoundaryMesh& bMesh, const word& name) int main(int argc, char *argv[]) { + argList::addNote + ( + "Splits mesh by making internal faces external at defined faceSet" + ); + argList::noParallel(); argList::noFunctionObjects(); // Never use function objects diff --git a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C index 2b9ff9c3b8..83f844fe82 100644 --- a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C +++ b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C @@ -34,7 +34,7 @@ Description cell-face-cell walking without crossing - boundary faces - additional faces from faceset (-blockedFaces faceSet). - - any face inbetween differing cellZones (-cellZones) + - any face between differing cellZones (-cellZones) Output is: - volScalarField with regions as different scalars (-detectOnly) diff --git a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C index 95bc75b8a3..cdcc054103 100644 --- a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C +++ b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C @@ -28,14 +28,14 @@ Group grpMeshManipulationUtilities Description - Selects a section of mesh based on a cellSet. + Create a mesh subset for a particular region of interest based on a + cellSet or cellZone. - The utility sub-sets the mesh to choose only a part of interest. Check - the setSet/cellSet/topoSet utilities to see how to select cells based on + See setSet/topoSet utilities on how to define select cells based on various shapes. - The mesh will subset all points, faces and cells needed to make a sub-mesh - but will not preserve attached boundary types. + Will subset all points, faces and cells needed to make a sub-mesh, + but not preserve attached boundary types. \*---------------------------------------------------------------------------*/ @@ -372,8 +372,10 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Select a mesh subset based on a cellSet or on cellZone(s) specified " - "as the first command argument." + "Create a mesh subset for a particular region of interest based on a" + " cellSet or cellZone(s) specified as the first command argument.\n" + "See setSet/topoSet utilities on how to select cells based on" + " various shapes." ); #include "addOverwriteOption.H" @@ -465,7 +467,7 @@ int main(int argc, char *argv[]) else if (args.found("patch")) { exposedPatchIDs.first() = - getExposedPatchId(mesh, args["patch"]); + getExposedPatchId(mesh, args.opt("patch")); } else { diff --git a/applications/utilities/mesh/manipulation/topoSet/topoSet.C b/applications/utilities/mesh/manipulation/topoSet/topoSet.C index abc0cccfda..bda18339c4 100644 --- a/applications/utilities/mesh/manipulation/topoSet/topoSet.C +++ b/applications/utilities/mesh/manipulation/topoSet/topoSet.C @@ -28,7 +28,8 @@ Group grpMeshManipulationUtilities Description - Operates on cellSets/faceSets/pointSets through a dictionary. + Operates on cellSets/faceSets/pointSets through a dictionary, + normally system/topoSetDict \*---------------------------------------------------------------------------*/ @@ -199,7 +200,13 @@ polyMesh::readUpdateState meshReadUpdate(polyMesh& mesh) int main(int argc, char *argv[]) { - timeSelector::addOptions(true, false); + argList::addNote + ( + "Operates on cellSets/faceSets/pointSets through a dictionary," + " normally system/topoSetDict" + ); + + timeSelector::addOptions(true, false); // constant(true), zero(false) #include "addDictOption.H" #include "addRegionOption.H" argList::addBoolOption diff --git a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C index 4dbc6a4a75..5292d86e14 100644 --- a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C +++ b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C @@ -28,8 +28,8 @@ Group grpMeshManipulationUtilities Description - Reads in a mesh with hanging vertices and zips up the cells to guarantee - that all polyhedral cells of valid shape are closed. + Reads in a mesh with hanging vertices and 'zips' up the cells + to guarantee that all polyhedral cells of valid shape are closed. Meshes with hanging vertices may occur as a result of split hex mesh conversion or integration or coupled math face pairs. @@ -48,6 +48,14 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Reads in a mesh with hanging vertices and 'zips' up the cells" + " to guarantee that all polyhedral cells of valid shape are closed.\n" + "Meshes with hanging vertices may occur as a result of split" + " hex mesh conversion or integration or coupled math face pairs." + ); + #include "addRegionOption.H" #include "setRootCase.H" diff --git a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C index ce2e7ae101..509b8cd999 100644 --- a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C +++ b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C @@ -25,7 +25,7 @@ Application foamDictionary Description - Interrogates and manipulates dictionaries. + Interrogate and manipulate dictionaries. Usage \b foamDictionary [OPTION] dictionary @@ -262,7 +262,10 @@ void removeDict(dictionary& dict, const dictionary& dictToRemove) int main(int argc, char *argv[]) { - argList::addNote("Manipulates dictionaries"); + argList::addNote + ( + "Interrogate and manipulate dictionaries" + ); argList::noBanner(); argList::noJobInfo(); diff --git a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C index e43bb0710c..4a56962209 100644 --- a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C +++ b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C @@ -235,6 +235,11 @@ bool writeOptionalMeshObject int main(int argc, char *argv[]) { + argList::addNote + ( + "Converts all IOobjects associated with a case into the format" + " specified in the controlDict" + ); timeSelector::addOptions(); argList::addBoolOption ( diff --git a/applications/utilities/miscellaneous/foamHelp/addToolOption.H b/applications/utilities/miscellaneous/foamHelp/addToolOption.H index 8abb062b00..fdef14d7ca 100644 --- a/applications/utilities/miscellaneous/foamHelp/addToolOption.H +++ b/applications/utilities/miscellaneous/foamHelp/addToolOption.H @@ -1,12 +1,12 @@ argList::addArgument("tool"); -argList::notes.append("Valid options include:"); +argList::addNote("Valid options include:"); for (const word& tool : helpType::dictionaryConstructorTablePtr_->sortedToc()) { - argList::notes.append(" " + tool); + argList::addNote(" " + tool); } -argList::notes.append +argList::addNote ( "\nNOTE the must actually appear *before* any options" ); diff --git a/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C b/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C index 7c1db951c1..008000da3c 100644 --- a/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C +++ b/applications/utilities/miscellaneous/foamListRegions/foamListRegions.C @@ -30,12 +30,13 @@ Group Description List regions from constant/regionProperties. - To simplify parsing of the output, the normal banner information - is suppressed. - Usage \b foamListRegions [OPTION] +Note + The OpenFOAM banner information is suppressed so that the output can be + piped into another command. + \*---------------------------------------------------------------------------*/ #include "argList.H" @@ -48,7 +49,10 @@ using namespace Foam; int main(int argc, char *argv[]) { - argList::addNote("List regions from constant/regionProperties"); + argList::addNote + ( + "List regions from constant/regionProperties" + ); argList::noBanner(); argList::noParallel(); diff --git a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C index c8b35074ab..8c4d43020d 100644 --- a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C +++ b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C @@ -28,8 +28,8 @@ Group grpPostProcessingUtilities Description - List times using timeSelector. - The normal banner information is suppressed. + List times using the timeSelector, or use to remove selected time + directories. Usage \b foamListTimes [OPTION] @@ -44,6 +44,10 @@ Usage - \par -verbose Report progress during removal +Note + The OpenFOAM banner information is suppressed so that the output can be + piped into another command. + \*---------------------------------------------------------------------------*/ #include "argList.H" @@ -58,9 +62,12 @@ using namespace Foam; int main(int argc, char *argv[]) { - argList::addNote("List times using timeSelector"); - - timeSelector::addOptions(true, true); + argList::addNote + ( + "List times using the timeSelector," + " or use to remove selected time directories" + ); + timeSelector::addOptions(true, true); // constant(true), zero(true) argList::noBanner(); argList::noParallel(); argList::noJobInfo(); diff --git a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C index ce8c452f42..96009c8314 100644 --- a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C +++ b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C @@ -188,9 +188,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Restore field names by removing the ending. The fields are " - "selected\n" - "automatically or can be specified as optional command arguments.\n" + "Restore field names by removing the ending. Fields are selected" + " automatically or can be specified as optional command arguments" ); profiling::disable(); // Disable profiling (and its output) @@ -225,7 +224,7 @@ int main(int argc, char *argv[]) // Non-mandatory arguments argList::addArgument("fieldName ... fieldName"); - timeSelector::addOptions(true, true); + timeSelector::addOptions(true, true); // constant(true), zero(true) #include "setRootCaseNonMandatoryArgs.H" dryrun = args.found("dry-run"); diff --git a/applications/utilities/miscellaneous/patchSummary/patchSummary.C b/applications/utilities/miscellaneous/patchSummary/patchSummary.C index c843ce59c1..b9eadef2a9 100644 --- a/applications/utilities/miscellaneous/patchSummary/patchSummary.C +++ b/applications/utilities/miscellaneous/patchSummary/patchSummary.C @@ -28,7 +28,7 @@ Group grpMiscUtilities Description - Writes fields and boundary condition info for each patch at each requested + Write field and boundary condition info for each patch at each requested time instance. Default action is to write a single entry for patches/patchGroups with the @@ -48,6 +48,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Write field and boundary condition info for each patch" + " at each requested time instance" + ); + timeSelector::addOptions(); #include "addRegionOption.H" diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C index d7354e91ac..beed8776ae 100644 --- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C +++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C @@ -289,8 +289,8 @@ int main(int argc, char *argv[]) "Only decompose geometry if the number of domains has changed" ); - // Include explicit constant options, have zero from time range - timeSelector::addOptions(true, false); + // Allow explicit -constant, have zero from time range + timeSelector::addOptions(true, false); // constant(true), zero(false) #include "setRootCase.H" diff --git a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C index 91c03b49ef..d1480120b9 100644 --- a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C +++ b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C @@ -84,7 +84,7 @@ int main(int argc, char *argv[]) // Enable -constant ... if someone really wants it // Enable -withZero to prevent accidentally trashing the initial fields - timeSelector::addOptions(true, true); + timeSelector::addOptions(true, true); // constant(true), zero(true) argList::noParallel(); #include "addRegionOption.H" argList::addBoolOption diff --git a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C index 8bc73b9040..072535b47f 100644 --- a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C +++ b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C @@ -452,7 +452,8 @@ int main(int argc, char *argv[]) // Enable -constant ... if someone really wants it // Enable -withZero to prevent accidentally trashing the initial fields - timeSelector::addOptions(true, true); + timeSelector::addOptions(true, true); // constant(true), zero(true) + argList::noParallel(); argList::addOption ( diff --git a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C index 4d994c3b6d..7cd4726305 100644 --- a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C +++ b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C @@ -2261,6 +2261,13 @@ void redistributeLagrangian int main(int argc, char *argv[]) { + argList::addNote + ( + "Redistribute decomposed mesh and fields according" + " to the decomposeParDict settings.\n" + "Optionally run in decompose/reconstruct mode" + ); + argList::noFunctionObjects(); // Never use function objects // enable -constant ... if someone really wants it diff --git a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C index 448964a785..c89903b526 100644 --- a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C +++ b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Translates OpenFOAM data to Fluent format. + Translate OpenFOAM data to Fluent format. \*---------------------------------------------------------------------------*/ @@ -41,8 +41,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Translate OpenFOAM data to Fluent format" + ); argList::noParallel(); - timeSelector::addOptions(false); // no constant + timeSelector::addOptions(false); // constant(false), zero(false) #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C index 26aa258221..afc95c7f53 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C @@ -28,8 +28,7 @@ Group grpPostProcessingUtilitie Description - Translates OpenFOAM data to EnSight format. - + Translate OpenFOAM data to EnSight format. An Ensight part is created for the internalMesh and for each patch. Usage @@ -127,6 +126,11 @@ getZeroGradInternalField(IOobject& io, const fvMeshSubsetProxy& proxy) int main(int argc, char *argv[]) { + argList::addNote + ( + "Translate OpenFOAM data to Ensight format with a part for" + " the internalMesh and for each patch." + ); timeSelector::addOptions(); #include "addRegionOption.H" diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C index 6112c199a6..19e1e7ab23 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C @@ -28,8 +28,8 @@ Group grpPostProcessingUtilities Description - Translates OpenFOAM data to Ensight format. - An Ensight part is created for each cellZone and patch. + Translate OpenFOAM data to Ensight format with an Ensight part + for each cellZone and patch. Usage \b foamToEnsightParts [OPTION] @@ -111,10 +111,16 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Translate OpenFOAM data to Ensight format with an Ensight part" + " for each cellZone and patch." + ); + // Enable -constant // Probably don't need -withZero though, since the fields are vetted // afterwards anyhow - timeSelector::addOptions(true, false); + timeSelector::addOptions(true, false); // constant(true), zero(false) #include "addRegionOption.H" argList::noParallel(); diff --git a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C index 65eeadaca9..04be4c0edd 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C +++ b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Translates foam output to GMV readable files. + Translate OpenFOAM output to GMV readable files. A free post-processor with available binaries from http://www-xdiv.lanl.gov/XCM/gmv/ @@ -47,6 +47,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Translate OpenFOAM output to GMV readable files" + ); + const wordList fieldTypes ({ "volScalarField", diff --git a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C index 295e34c98e..ecd62c9d17 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C +++ b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Converts polyMesh results to tetDualMesh. + Convert polyMesh results to tetDualMesh. \*---------------------------------------------------------------------------*/ @@ -140,6 +140,11 @@ void ReadAndMapFields int main(int argc, char *argv[]) { + argList::addNote + ( + "Convert polyMesh results to tetDualMesh" + ); + #include "addOverwriteOption.H" #include "addTimeOptions.H" diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C index dd37ad5c1b..f79efb579a 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C @@ -248,7 +248,10 @@ vtk::outputOptions getOutputOptions(const argList& args) int main(int argc, char *argv[]) { - argList::addNote("OpenFOAM to VTK writer"); + argList::addNote + ( + "General OpenFOAM to VTK file writer" + ); timeSelector::addOptions(); // Infrequently needed, mark as advanced. diff --git a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C index 76af6283ef..2c627c6d3c 100644 --- a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C +++ b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Translates a STAR-CD SMAP data file into OpenFOAM field format. + Translate a STARCD SMAP data file into OpenFOAM field format. \*---------------------------------------------------------------------------*/ @@ -39,6 +39,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Translate a STARCD SMAP data file into OpenFOAM field format" + ); + argList::noParallel(); argList::addArgument("SMAP fileName"); diff --git a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C index 1a9d3624d2..d61ba155f3 100644 --- a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C +++ b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C @@ -28,8 +28,8 @@ Group grpPostProcessingUtilities Description - Generates a VTK file of particle tracks for cases that were computed using - a tracked-parcel-type cloud. + Generate a legacy VTK file of particle tracks for cases that were + computed using a tracked-parcel-type cloud. \*---------------------------------------------------------------------------*/ @@ -49,6 +49,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Generate a legacy VTK file of particle tracks for cases that were" + " computed using a tracked-parcel-type cloud" + ); + timeSelector::addOptions(); #include "addRegionOption.H" diff --git a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C index 821d949de5..9830ce3bdf 100644 --- a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C +++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C @@ -28,8 +28,8 @@ Group grpPostProcessingUtilitie Description - Generates a VTK file of particle tracks for cases that were computed using - a steady-state cloud + Generate a legacy VTK file of particle tracks for cases that were + computed using a steady-state cloud Note: - Case must be re-constructed (if running in parallel) before use @@ -115,6 +115,12 @@ void writeVTK(OFstream& os, const scalar& value) int main(int argc, char *argv[]) { + argList::addNote + ( + "Generate a legacy VTK file of particle tracks for cases that were" + " computed using a steady-state cloud" + ); + argList::noParallel(); timeSelector::addOptions(); #include "addRegionOption.H" diff --git a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C index d61edb57ef..4c8bec0cfb 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C @@ -81,8 +81,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Extract force/moment information from existing calculations based " - "on the lumpedPoints pressure zones." + "Extract force/moment information from existing calculations based" + " on the lumpedPoints pressure zones." ); argList::addBoolOption diff --git a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C index f603e34896..6221844504 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C @@ -27,6 +27,7 @@ Application Description This utility can be used to produce VTK files to visualize the response points/rotations and the corresponding movement of the building surfaces. + Uses the tabulated responses from the specified file. Optionally, it can also be used to a dummy responder for the externalFileCoupler logic, which makes it useful as a debugging facility @@ -52,8 +53,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Visualize lumpedPoint movements or provide a slave responder " - "for diagnostic purposes." + "Visualize lumpedPoint movements or provide a slave responder" + " for diagnostic purposes." ); argList::noParallel(); diff --git a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C index 2d94cf2c69..72b6d0a85a 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C @@ -25,7 +25,7 @@ Application lumpedPointZones Description - Produces a VTK PolyData file \c lumpedPointZones.vtp in which the + Produce a VTK PolyData file \c lumpedPointZones.vtp in which the segmentation of the pressure integration zones can be visualized for diagnostic purposes. Does not use external coupling. @@ -46,8 +46,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Create lumpedPointZones.vtp to verify the segmentation of " - "pressure integration zones used by lumpedPoint BC." + "Create lumpedPointZones.vtp to verify the segmentation of" + " pressure integration zones used by lumpedPoint BC." ); argList::noParallel(); // The VTP writer is not yet in parallel diff --git a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C index 707d1eaac2..1a0960cf47 100644 --- a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C +++ b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Calculate the geometric compression ratio. + Calculate the engine geometric compression ratio. Note: if you have valves and/or extra volumes it will not work, since it calculates the volume at BDC and TCD. @@ -43,6 +43,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Calculate the engine geometric compression ratio" + ); + #include "setRootCase.H" #include "createEngineTime.H" #include "createEngineMesh.H" diff --git a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C index 57bcfa9510..e65345d2f9 100644 --- a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C +++ b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilitie Description - Generates a graph of a probability distribution function. + Generate a graph of a probability distribution function. \*---------------------------------------------------------------------------*/ @@ -41,6 +41,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Generate a graph of a probability distribution function" + ); + #include "setRootCase.H" #include "createTime.H" #include "createFields.H" diff --git a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C index c5602a6496..fa47bca48f 100644 --- a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C +++ b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Post-processes data from channel flow calculations. + Post-process data from channel flow calculations. For each time: calculate: txx, txy,tyy, txy, eps, prod, vorticity, enstrophy and helicity. Assuming that the mesh @@ -48,6 +48,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Post-process data from channel flow calculations" + ); + argList::noParallel(); timeSelector::addOptions(); diff --git a/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C b/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C index f2da76d089..15c5a8f281 100644 --- a/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C +++ b/applications/utilities/postProcessing/miscellaneous/profilingSummary/profilingSummary.C @@ -69,11 +69,11 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Collect profiling information from processor directories and\n" - "summarize the time spent and number of calls as (max avg min) values." + "Collect profiling information from processor directories and" + " summarize time spent and number of calls as (max avg min) values." ); - timeSelector::addOptions(true, true); + timeSelector::addOptions(true, true); // constant(true), zero(true) argList::noParallel(); argList::noFunctionObjects(); // Never use function objects diff --git a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C index 5f934dc020..3ddf0f8252 100644 --- a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C +++ b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C @@ -188,6 +188,11 @@ void fieldInterpolator::interpolate() int main(int argc, char *argv[]) { + argList::addNote + ( + "Interpolate fields between time-steps. Eg, for animation." + ); + timeSelector::addOptions(); #include "addRegionOption.H" argList::addOption diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C index a97edc1854..9f01b669c2 100644 --- a/applications/utilities/postProcessing/noise/noise.C +++ b/applications/utilities/postProcessing/noise/noise.C @@ -28,7 +28,7 @@ Group grpPostProcessingUtilities Description - Utility to perform noise analysis of pressure data. + Perform noise analysis of pressure data. The utility provides a light wrapper around the run-time selectable noise model. Current options include: @@ -102,6 +102,11 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Perform noise analysis of pressure data" + ); + argList::noCheckProcessorDirectories(); #include "addDictOption.H" diff --git a/applications/utilities/postProcessing/postProcess/postProcess.C b/applications/utilities/postProcessing/postProcess/postProcess.C index f0a2b99b64..767fb9ff95 100644 --- a/applications/utilities/postProcessing/postProcess/postProcess.C +++ b/applications/utilities/postProcessing/postProcess/postProcess.C @@ -133,7 +133,14 @@ void executeFunctionObjects int main(int argc, char *argv[]) { - Foam::timeSelector::addOptions(); + argList::addNote + ( + "Execute the set of functionObjects specified in the selected" + " dictionary or on the command-line for the" + " selected set of times on the selected set of fields" + ); + + timeSelector::addOptions(); #include "addProfilingOption.H" #include "addRegionOption.H" #include "addFunctionObjectOptions.H" @@ -150,7 +157,7 @@ int main(int argc, char *argv[]) } #include "createTime.H" - Foam::instantList timeDirs = Foam::timeSelector::select0(runTime, args); + instantList timeDirs = timeSelector::select0(runTime, args); #include "createNamedMesh.H" // Initialize the set of selected fields from the command-line options diff --git a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C index ffde5b2b38..84ae8b3590 100644 --- a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C +++ b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C @@ -273,8 +273,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Apply a simplified boundary-layer model to the velocity and\n" - "turbulence fields based on the 1/7th power-law." + "Apply a simplified boundary-layer model to the velocity and" + " turbulence fields based on the 1/7th power-law." ); #include "addRegionOption.H" diff --git a/applications/utilities/preProcessing/boxTurb/boxTurb.C b/applications/utilities/preProcessing/boxTurb/boxTurb.C index faa9b37e43..a37eb981bf 100644 --- a/applications/utilities/preProcessing/boxTurb/boxTurb.C +++ b/applications/utilities/preProcessing/boxTurb/boxTurb.C @@ -28,8 +28,8 @@ Group grpPreProcessingUtilities Description - Makes a box of turbulence which conforms to a given energy - spectrum and is divergence free. + Create a box of divergence-free turbulence conforming to a given + energy spectrum. \*---------------------------------------------------------------------------*/ @@ -45,6 +45,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Create a box of divergence-free turbulence conforming to a given" + " energy spectrum" + ); + argList::noParallel(); #include "setRootCase.H" diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C index d9a0922984..f767b62d9f 100644 --- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C +++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C @@ -390,6 +390,12 @@ bool merge int main(int argc, char *argv[]) { + argList::addNote + ( + "Utility to change dictionary entries" + " (such as the patch type for fields and polyMesh/boundary files)." + ); + #include "addDictOption.H" argList::addOption ( diff --git a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C index 9da5d76795..0ced2d52ed 100644 --- a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C +++ b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C @@ -25,7 +25,7 @@ Application createBoxTurb Description - Creates a box of isotropic turbulence based on a user-specified + Create a box of isotropic turbulence based on a user-specified energy spectrum. Based on the reference @@ -67,6 +67,12 @@ Foam::vector randomUnitVector(Random& rndGen) int main(int argc, char *argv[]) { + argList::addNote + ( + "Create a box of isotropic turbulence based on a user-specified" + " energy spectrum." + ); + argList::addBoolOption ( "createBlockMesh", diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C index 1be51398da..b318fedb94 100644 --- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C +++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C @@ -28,7 +28,7 @@ Group grpPreProcessingUtilities Description - Application to generate the patch geometry (points and faces) for use + Generate the patch geometry (points and faces) for use with the externalCoupled functionObject. Usage @@ -68,6 +68,12 @@ See also int main(int argc, char *argv[]) { + argList::addNote + ( + "Generate the patch geometry (points and faces) for use" + " with the externalCoupled functionObject." + ); + #include "addRegionOption.H" #include "addRegionsOption.H" argList::addArgument("patchGroup"); diff --git a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C index 40c72fc2ab..68b7e607a9 100644 --- a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C +++ b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C @@ -208,6 +208,12 @@ void createFieldFiles // Main program: int main(int argc, char *argv[]) { + argList::addNote + ( + "Create a 0/ directory with fields appropriate for the chosen" + " solver and turbulence model." + ); + argList::addOption ( "templateDir", diff --git a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C index 666311ea50..f41dffe896 100644 --- a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C +++ b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C @@ -40,6 +40,12 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Initialise a case for dsmcFoam from the system/dsmcInitialise" + " dictionary" + ); + #include "setRootCase.H" #include "createTime.H" #include "createNamedMesh.H" diff --git a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C index c781b81c71..46791cebf9 100644 --- a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C +++ b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C @@ -28,7 +28,7 @@ Group grpPreProcessingUtilities Description - Generates a swirling flow for engine calulations. + Generate a swirl flow for engine calculations. \*---------------------------------------------------------------------------*/ @@ -39,6 +39,10 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Generate a swirl flow for engine calculations" + ); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C index 03427de8ed..62c2c2e2ee 100644 --- a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C +++ b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C @@ -53,6 +53,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Agglomerate boundary faces using the pairPatchAgglomeration" + " algorithm. Writes a map of fine to coarse grid." + ); + #include "addRegionOption.H" #include "addDictOption.H" #include "setRootCase.H" diff --git a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C index 7bd8e9d1d3..320557b7d8 100644 --- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C +++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C @@ -393,6 +393,11 @@ void rewriteFields int main(int argc, char *argv[]) { + argList::addNote + ( + "Tool to upgrade mesh and fields for split cyclics" + ); + timeSelector::addOptions(); argList::addOptionCompat("dry-run", {"test", 1806}); diff --git a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C index 2c04a689c2..8c497fda95 100644 --- a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C +++ b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C @@ -39,6 +39,10 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Initialises fields for a molecular dynamics (MD) simulation" + ); #include "setRootCase.H" #include "createTime.H" #include "createNamedMesh.H" diff --git a/applications/utilities/preProcessing/setAlphaField/setAlphaField.C b/applications/utilities/preProcessing/setAlphaField/setAlphaField.C index 6647f088ac..9853791143 100644 --- a/applications/utilities/preProcessing/setAlphaField/setAlphaField.C +++ b/applications/utilities/preProcessing/setAlphaField/setAlphaField.C @@ -75,6 +75,12 @@ shapeSelector::shapeTypeNames int main(int argc, char *argv[]) { + argList::addNote + ( + "Uses isoCutCell to create a volume fraction field from a" + " cylinder, sphere or a plane." + ); + #include "setRootCase.H" #include "createTime.H" #include "createNamedMesh.H" diff --git a/applications/utilities/preProcessing/setFields/setFields.C b/applications/utilities/preProcessing/setFields/setFields.C index 0e551df0e4..01510ad72e 100644 --- a/applications/utilities/preProcessing/setFields/setFields.C +++ b/applications/utilities/preProcessing/setFields/setFields.C @@ -28,7 +28,7 @@ Group grpPreProcessingUtilities Description - Set values on a selected set of cells/patchfaces through a dictionary. + Set values on a selected set of cells/patch-faces via a dictionary. \*---------------------------------------------------------------------------*/ @@ -396,6 +396,11 @@ public: int main(int argc, char *argv[]) { + argList::addNote + ( + "Set values on a selected set of cells/patch-faces via a dictionary" + ); + #include "addDictOption.H" #include "addRegionOption.H" #include "setRootCase.H" diff --git a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C index 5bae07c86a..c80fec2be3 100644 --- a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C +++ b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C @@ -256,6 +256,12 @@ void insertMatrixElements int main(int argc, char *argv[]) { + argList::addNote + ( + "Calculate view factors from face agglomeration array." + " The finalAgglom generated by faceAgglomerate utility." + ); + #include "addRegionOption.H" #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C index e31e42e738..13ed9d6c07 100644 --- a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C +++ b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTable.C @@ -39,6 +39,11 @@ Description int main(int argc, char *argv[]) { + argList::addNote + ( + "Generates a table suitable for use by tabulated wall functions" + ); + #include "setRootCase.H" #include "createTime.H" #include "createNamedMesh.H" diff --git a/applications/utilities/surface/surfaceAdd/surfaceAdd.C b/applications/utilities/surface/surfaceAdd/surfaceAdd.C index 48bb9abcfe..1b76e56ca8 100644 --- a/applications/utilities/surface/surfaceAdd/surfaceAdd.C +++ b/applications/utilities/surface/surfaceAdd/surfaceAdd.C @@ -28,8 +28,8 @@ Group grpSurfaceUtilities Description - Add two surfaces. Does geometric merge on points. Does not check for - overlapping/intersecting triangles. + Add two surfaces. Does geometric merge on points. + Does not check for overlapping/intersecting triangles. Keeps patches separate by renumbering. @@ -52,6 +52,7 @@ int main(int argc, char *argv[]) argList::addNote ( "Add two surfaces via a geometric merge on points." + " Does not check for overlapping/intersecting triangles." ); argList::noParallel(); diff --git a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C index d0cdb3a944..2d8099236e 100644 --- a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C +++ b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C @@ -31,33 +31,33 @@ Description Generates the extendedFeatureEdgeMesh for the interface between a boolean operation on two surfaces. - Assumes that the orientation of the surfaces iscorrect: + Assumes that the orientation of the surfaces is correct: - if the operation is union or intersection, that both surface's normals - (n) have the same orientation with respect to a point, i.e. surfaces and b - are orientated the same with respect to point x: + (n) have the same orientation with respect to a point, i.e. surfaces + A and B are orientated the same with respect to point x: \verbatim _______ | |--> n | ___|___ x - |a | | |--> n - |___|___| b| + |A | | |--> n + |___|___| B| | | |_______| \endverbatim - if the operation is a subtraction, the surfaces should be oppositely - oriented with respect to a point, i.e. for (a - b), then b's orientation - should be such that x is "inside", and a's orientation such that x is + oriented with respect to a point, i.e. for (A - B), then B's orientation + should be such that x is "inside", and A's orientation such that x is "outside" \verbatim _______ | |--> n | ___|___ x - |a | | | - |___|___| b| + |A | | | + |___|___| B| | n <--| |_______| @@ -65,8 +65,8 @@ Description When the operation is peformed - for union, all of the edges generates where one surfaces cuts another are all "internal" for union, and "external" for - intersection, b - a and a - b. This has been assumed, formal (dis)proof is - invited. + intersection, (B - A) and (A - B). + This has been assumed, formal (dis)proof is invited. \*---------------------------------------------------------------------------*/ @@ -1507,6 +1507,12 @@ autoPtr createEdgeMesh int main(int argc, char *argv[]) { + argList::addNote + ( + "Generates the extendedFeatureEdgeMesh for the interface between" + " a boolean operation on two surfaces." + ); + argList::noParallel(); argList::addArgument("action"); argList::addArgument("surfaceFile1"); diff --git a/applications/utilities/surface/surfaceCheck/surfaceCheck.C b/applications/utilities/surface/surfaceCheck/surfaceCheck.C index 71993246e8..f648c8a962 100644 --- a/applications/utilities/surface/surfaceCheck/surfaceCheck.C +++ b/applications/utilities/surface/surfaceCheck/surfaceCheck.C @@ -28,7 +28,7 @@ Group grpSurfaceUtilities Description - Checks geometric and topological quality of a surface. + Check geometric and topological quality of a surface. Usage \b surfaceCheck [OPTION] surfaceFile @@ -317,6 +317,11 @@ void writeEdgeSet int main(int argc, char *argv[]) { + argList::addNote + ( + "Check geometric and topological quality of a surface" + ); + argList::noParallel(); argList::addArgument("surfaceFile"); argList::addBoolOption diff --git a/applications/utilities/surface/surfaceClean/surfaceClean.C b/applications/utilities/surface/surfaceClean/surfaceClean.C index 138ea2d402..c6e725ff69 100644 --- a/applications/utilities/surface/surfaceClean/surfaceClean.C +++ b/applications/utilities/surface/surfaceClean/surfaceClean.C @@ -52,6 +52,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Clean surface by removing baffles, sliver faces," + " collapsing small edges, etc." + ); + argList::noParallel(); argList::addArgument("surfaceFile"); argList::addArgument("min length"); diff --git a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C index df7b9f2b17..754c0be069 100644 --- a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C +++ b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C @@ -71,6 +71,11 @@ int mapVertex(::List& collapse_map, int a, int mx) int main(int argc, char *argv[]) { + argList::addNote + ( + "Surface coarsening using 'bunnylod'" + ); + argList::noParallel(); argList::addArgument("surfaceFile"); argList::addArgument("reductionFactor"); diff --git a/applications/utilities/surface/surfaceFind/surfaceFind.C b/applications/utilities/surface/surfaceFind/surfaceFind.C index 8b985357c2..709481d5b7 100644 --- a/applications/utilities/surface/surfaceFind/surfaceFind.C +++ b/applications/utilities/surface/surfaceFind/surfaceFind.C @@ -29,6 +29,7 @@ Group Description Finds nearest face and vertex. + Uses a zero origin unless otherwise specified. \*---------------------------------------------------------------------------*/ @@ -44,6 +45,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Find nearest face and vertex." + " Uses a zero origin unless otherwise specified" + ); + argList::noParallel(); argList::addArgument("surfaceFile"); argList::addOption("x", "X", "The point x-coordinate (if non-zero)"); diff --git a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C index a62ecb2877..5f83dfe06f 100644 --- a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C +++ b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C @@ -270,7 +270,7 @@ int main(int argc, char *argv[]) argList::addNote ( "Hook surfaces to other surfaces by moving and retriangulating their" - "boundary edges to match other surface boundary edges" + " boundary edges to match other surface boundary edges" ); argList::noParallel(); argList::addArgument("hookTolerance"); diff --git a/applications/utilities/surface/surfaceInertia/surfaceInertia.C b/applications/utilities/surface/surfaceInertia/surfaceInertia.C index c1935bc7da..88a977c5c3 100644 --- a/applications/utilities/surface/surfaceInertia/surfaceInertia.C +++ b/applications/utilities/surface/surfaceInertia/surfaceInertia.C @@ -54,8 +54,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Calculates the inertia tensor and principal axes and moments " - "of the specified surface.\n" + "Calculates the inertia tensor and principal axes and moments" + " of the specified surface.\n" "Inertia can either be of the solid body or of a thin shell." ); diff --git a/applications/utilities/surface/surfaceInflate/surfaceInflate.C b/applications/utilities/surface/surfaceInflate/surfaceInflate.C index 731d583065..82d104ed2f 100644 --- a/applications/utilities/surface/surfaceInflate/surfaceInflate.C +++ b/applications/utilities/surface/surfaceInflate/surfaceInflate.C @@ -563,7 +563,10 @@ void lloydsSmoothing int main(int argc, char *argv[]) { - argList::addNote("Inflates surface according to point normals."); + argList::addNote + ( + "Inflates surface according to point normals." + ); argList::noParallel(); argList::addNote diff --git a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C index 6485163063..abe37f073b 100644 --- a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C +++ b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C @@ -28,7 +28,7 @@ Group grpSurfaceUtilities Description - Smooths a surface using lambda/mu smoothing. + Smooth a surface using lambda/mu smoothing. To get laplacian smoothing, set lambda to the relaxation factor and mu to zero. @@ -131,6 +131,13 @@ void getFixedPoints int main(int argc, char *argv[]) { + argList::addNote + ( + "Smooth a surface using lambda/mu smoothing.\n" + "For laplacian smoothing, set lambda to the relaxation factor" + " and mu to zero." + ); + argList::noParallel(); argList::validOptions.clear(); argList::addArgument("surfaceFile"); diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C index a030599286..5a44082175 100644 --- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C +++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C @@ -28,7 +28,7 @@ Group grpSurfaceUtilities Description - Converts between surface formats with optional scaling or + Convert between surface formats with optional scaling or transformations (rotate/translate) on a coordinateSystem. Usage @@ -76,7 +76,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "convert between surface formats, using MeshSurface library components" + "Convert between surface formats, using MeshSurface library components" ); argList::noParallel(); diff --git a/applications/utilities/surface/surfacePatch/surfacePatch.C b/applications/utilities/surface/surfacePatch/surfacePatch.C index 09085ff4f3..a2b2169dd2 100644 --- a/applications/utilities/surface/surfacePatch/surfacePatch.C +++ b/applications/utilities/surface/surfacePatch/surfacePatch.C @@ -52,6 +52,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Add patches (regions) to a surface with a user-selectable method" + ); argList::noParallel(); #include "addDictOption.H" diff --git a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C index 3c2f829aa6..2853f651a3 100644 --- a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C +++ b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C @@ -104,9 +104,9 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Redistribute a triSurface. " - "The specified surface must be located in the constant/triSurface " - "directory" + "Redistribute a triSurface." + " The specified surface must be located in the constant/triSurface" + " directory" ); argList::addArgument("triSurfaceMesh"); diff --git a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C index ab27396d4a..d7ec473afb 100644 --- a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C +++ b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C @@ -54,6 +54,10 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Refine by splitting all three edges of triangle" + ); argList::noParallel(); argList::addArgument("surfaceFile"); argList::addArgument("output surfaceFile"); diff --git a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C index 1ba612cc58..9c930f85e6 100644 --- a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C +++ b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C @@ -44,6 +44,13 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "Strips any baffle parts of a surface.\n" + "A baffle region is one which is reached by walking from an open edge," + " and stopping when a multiply connected edge is reached." + ); + argList::noParallel(); argList::validOptions.clear(); argList::addArgument("input surface file"); diff --git a/applications/utilities/surface/surfaceSubset/surfaceSubset.C b/applications/utilities/surface/surfaceSubset/surfaceSubset.C index 052b05a228..5e41538818 100644 --- a/applications/utilities/surface/surfaceSubset/surfaceSubset.C +++ b/applications/utilities/surface/surfaceSubset/surfaceSubset.C @@ -28,8 +28,8 @@ Group grpSurfaceUtilities Description - A surface analysis tool which sub-sets the triSurface - to choose only a part of interest. Based on subsetMesh. + A surface analysis tool that subsets the triSurface to choose a + region of interest. Based on subsetMesh. \*---------------------------------------------------------------------------*/ @@ -51,6 +51,12 @@ using namespace Foam; int main(int argc, char *argv[]) { + argList::addNote + ( + "A surface analysis tool that subsets the triSurface to choose a" + " region of interest." + ); + argList::noParallel(); argList::addArgument("surfaceSubsetDict"); argList::addArgument("surfaceFile"); diff --git a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C index eccc4949db..8692bc32c7 100644 --- a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C +++ b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C @@ -28,7 +28,7 @@ Group grpThermophysicalUtilities Description - Calculates the adiabatic flame temperature for a given fuel over a + Calculate adiabatic flame temperature for a given fuel over a range of unburnt temperatures and equivalence ratios. \*---------------------------------------------------------------------------*/ @@ -57,8 +57,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Calculates the adiabatic flame temperature for a given fuel\n" - "over a range of unburnt temperatures and equivalence ratios." + "Calculate the adiabatic flame temperature for a given fuel over a " + " range of unburnt temperatures and equivalence ratios." ); argList::noParallel(); diff --git a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C index 0458642a44..c84b2ff2a2 100644 --- a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C +++ b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C @@ -28,7 +28,7 @@ Group grpSurfaceUtilities Description - Converts CHEMKINIII thermodynamics and reaction data files into + Convert CHEMKINIII thermodynamics and reaction data files into OpenFOAM format. \*---------------------------------------------------------------------------*/ @@ -49,8 +49,8 @@ int main(int argc, char *argv[]) argList::addNote ( - "Converts CHEMKINIII thermodynamics and reaction data files into\n" - "OpenFOAM format." + "Convert CHEMKINIII thermodynamics and reaction data files into" + " OpenFOAM format." ); argList::noParallel(); diff --git a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C index fc3478900b..b3153ad0b4 100644 --- a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C +++ b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C @@ -28,7 +28,7 @@ Group grpThermophysicalUtilities Description - Calculates the equilibrium level of carbon monoxide. + Calculate the equilibrium level of carbon monoxide. \*---------------------------------------------------------------------------*/ @@ -59,7 +59,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Calculates the equilibrium level of carbon monoxide." + "Calculate the equilibrium level of carbon monoxide." ); argList::noParallel(); diff --git a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C index a7f1eb6659..7f593ff57b 100644 --- a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C +++ b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C @@ -28,9 +28,9 @@ Group grpThermophysicalUtilities Description - Calculates the equilibrium flame temperature for a given fuel and + Calculate the equilibrium flame temperature for a given fuel and pressure for a range of unburnt gas temperatures and equivalence - ratios; includes the effects of dissociation on O2, H2O and CO2. + ratios. Includes the effects of dissociation on O2, H2O and CO2. \*---------------------------------------------------------------------------*/ @@ -59,9 +59,10 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Calculates the equilibrium flame temperature for a given fuel\n" - "and pressure for a range of unburnt gas temperatures and equivalence\n" - "ratios; includes the effects of dissociation on O2, H2O and CO2." + "Calculate the equilibrium flame temperature for a given fuel and" + " pressure for a range of unburnt gas temperatures and equivalence" + " ratios.\n" + "Includes the effects of dissociation on O2, H2O and CO2." ); argList::noParallel(); diff --git a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C index 235e43b1a5..75c45e3cf7 100644 --- a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C +++ b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C @@ -28,7 +28,7 @@ Group grpThermophysicalUtilities Description - Calculates the adiabatic flame temperature for a given mixture + Calculate adiabatic flame temperature for a given mixture at a given temperature. \*---------------------------------------------------------------------------*/ @@ -57,8 +57,8 @@ int main(int argc, char *argv[]) { argList::addNote ( - "Calculates the adiabatic flame temperature for a given mixture\n" - "at a given temperature." + "Calculate adiabatic flame temperature for a given mixture" + " at a given temperature" ); argList::noParallel(); From a1cc72f8ac1f16ef9cef21ecaf018e22c548846a Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 11 Dec 2018 16:26:45 +0100 Subject: [PATCH 4/6] SUBMODULES: update for -help usage --- modules/avalanche | 2 +- modules/cfmesh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/avalanche b/modules/avalanche index a82a2f62a9..a83eb8c203 160000 --- a/modules/avalanche +++ b/modules/avalanche @@ -1 +1 @@ -Subproject commit a82a2f62a93c60cfe8dfcd4dfe206f8ac798b285 +Subproject commit a83eb8c203ada545580a621b02b63782f2518d96 diff --git a/modules/cfmesh b/modules/cfmesh index 024454c8db..768075fbef 160000 --- a/modules/cfmesh +++ b/modules/cfmesh @@ -1 +1 @@ -Subproject commit 024454c8dbef41a19d4e401b2c32ca4f03090d00 +Subproject commit 768075fbef083b2b66e8c79cfaf5fc97e6d18187 From 98158f54092b7b4caac863a8e3962708e2fc2255 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 11 Dec 2018 16:25:28 +0100 Subject: [PATCH 5/6] TUT: add End marker for tutorials --- .../utilities/preProcessing/createBoxTurb/createBoxTurb.C | 2 +- .../RAS/externalCoupledSquareBendLiq/externalSolver | 3 +++ .../chtMultiRegionFoam/externalCoupledHeater/externalSolver | 3 +++ .../externalCoupledHeater/externalSolver | 3 +++ 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C index 0ced2d52ed..db6e7a479b 100644 --- a/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C +++ b/applications/utilities/preProcessing/createBoxTurb/createBoxTurb.C @@ -88,6 +88,7 @@ int main(int argc, char *argv[]) { // Create a box block mesh with cyclic patches #include "createBlockMesh.H" + Info<< "\nEnd\n" << endl; return 0; } @@ -182,7 +183,6 @@ int main(int argc, char *argv[]) runTime.printExecutionTime(Info); Info<< "End\n" << endl; - return 0; } diff --git a/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver b/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver index 2b64cfef4a..dc5c6bbd21 100755 --- a/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver +++ b/tutorials/compressible/rhoPimpleFoam/RAS/externalCoupledSquareBendLiq/externalSolver @@ -211,4 +211,7 @@ case "$action" in ;; esac +# For log collector: +echo "End" + #------------------------------------------------------------------------------ diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver b/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver index dc8b42fe15..559fdd1ae3 100755 --- a/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver +++ b/tutorials/heatTransfer/chtMultiRegionFoam/externalCoupledHeater/externalSolver @@ -170,4 +170,7 @@ log "done" # Remove the lock file too \rm -f $lockFile 2>/dev/null +# For log collector: +echo "End" + #------------------------------------------------------------------------------ diff --git a/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver b/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver index d83dd3109c..6123b21c00 100755 --- a/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver +++ b/tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver @@ -171,4 +171,7 @@ log "done" # Remove the lock file too \rm -f $lockFile 2>/dev/null +# For log collector: +echo "End" + #------------------------------------------------------------------------------ From 08b70bb2222bae25a979902ba413dd9be35557e9 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 11 Dec 2018 16:40:14 +0100 Subject: [PATCH 6/6] STYLE: remove unused variable (vtm writer) --- src/fileFormats/vtk/file/foamVtmWriter.C | 9 +-------- src/fileFormats/vtk/file/foamVtmWriter.H | 6 ------ 2 files changed, 1 insertion(+), 14 deletions(-) diff --git a/src/fileFormats/vtk/file/foamVtmWriter.C b/src/fileFormats/vtk/file/foamVtmWriter.C index d935c22c76..3a83eb00d5 100644 --- a/src/fileFormats/vtk/file/foamVtmWriter.C +++ b/src/fileFormats/vtk/file/foamVtmWriter.C @@ -314,20 +314,13 @@ void Foam::vtk::vtmWriter::dump(Ostream& os) const Foam::vtk::vtmWriter::vtmWriter() : - vtmWriter(true, false) + vtmWriter(true) {} Foam::vtk::vtmWriter::vtmWriter(bool autoName) -: - vtmWriter(autoName, false) -{} - - -Foam::vtk::vtmWriter::vtmWriter(bool autoName, bool autoCollapse) : autoName_(autoName), - autoCollapse_(autoCollapse), hasTime_(false), entries_(), blocks_(), diff --git a/src/fileFormats/vtk/file/foamVtmWriter.H b/src/fileFormats/vtk/file/foamVtmWriter.H index 24b9bed0fd..c4c9dd530a 100644 --- a/src/fileFormats/vtk/file/foamVtmWriter.H +++ b/src/fileFormats/vtk/file/foamVtmWriter.H @@ -176,9 +176,6 @@ class vtmWriter //- Auto-generate names from 'file' entry? bool autoName_; - //- Collapse empty blocks and combine block/dataset etc. - bool autoCollapse_; - //- Has a TimeValue for FieldData? bool hasTime_; @@ -214,9 +211,6 @@ public: //- Construct with specified behaviour for autoName explicit vtmWriter(bool autoName); - //- Construct with specified behaviour for autoName, autoCollapse - vtmWriter(bool autoName, bool autoCollapse); - //- Destructor ~vtmWriter() = default;