zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Applying Gijs' patch: Update header documentation for utilities

Browse Source
This commit is contained in:
andy
2013-02-21 10:54:34 +00:00
parent 63cc7b534a
commit 951c8436aa
130 changed files with 362 additions and 282 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
applications/utilities/preProcessing/applyWallFunctionBoundaryConditions/applyWallFunctionBoundaryConditions.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,10 +25,10 @@ Application
applyWallFunctionBounaryConditions
Description
Updates OpenFOAM RAS cases to use the new (v1.6) wall function framework
Updates OpenFOAM RAS cases to use the new (v1.6) wall function framework.
Attempts to determine whether case is compressible or incompressible, or
can be supplied with -compressible command line argument
can be supplied with -compressible command line argument.
\*---------------------------------------------------------------------------*/
@ -332,7 +332,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"compressible",
"force use of compressible wall functions. default is auto-detect."
"force use of compressible wall functions. Default is auto-detect."
);
#include "setRootCase.H"

4
applications/utilities/preProcessing/boxTurb/boxTurb.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Application
boxTurb3D
boxTurb
Description
Makes a box of turbulence which conforms to a given energy

5
applications/utilities/preProcessing/changeDictionary/changeDictionary.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -381,7 +381,6 @@ bool merge
}
// Main program:
int main(int argc, char *argv[])
{
@ -399,7 +398,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"literalRE",
"treat regular expressions literally (ie, as a keyword)"
"treat regular expressions literally (i.e., as a keyword)"
);
argList::addBoolOption
(

6
applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,11 +22,11 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Application
dsmcFoam
dsmcInitialise
Description
Initialise a case for dsmcFoam by reading the initialisation dictionary
system/dsmcInitialise
system/dsmcInitialise.
\*---------------------------------------------------------------------------*/

4
applications/utilities/preProcessing/engineSwirl/engineSwirl.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,7 +25,7 @@ Application
engineSwirl
Description
Generates a swirling flow for engine calulations
Generates a swirling flow for engine calulations.
\*---------------------------------------------------------------------------*/

5
applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,7 +25,7 @@ Application
foamUpgradeCyclics
Description
Tool to upgrade mesh and fields for split cyclics
Tool to upgrade mesh and fields for split cyclics.
Usage
@ -388,7 +388,6 @@ void rewriteFields
}
// Main program:
int main(int argc, char *argv[])
{

12
applications/utilities/preProcessing/foamUpgradeFvSolution/foamUpgradeFvSolution.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,11 +25,10 @@ Application
foamUpgradeFvSolution
Description
Simple tool to upgrade the syntax of system/fvSolution::solvers
Simple tool to upgrade the syntax of system/fvSolution.solvers.
Usage
- foamUpgradeFvSolution [OPTION]
foamUpgradeFvSolution [OPTION]
\param -test \n
Suppress writing the updated fvSolution file
@ -44,7 +43,6 @@ Usage
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Main program:
int main(int argc, char *argv[])
{
@ -60,8 +58,8 @@ int main(int argc, char *argv[])
"suppress writing the updated system/fvSolution file"
);
# include "setRootCase.H"
# include "createTime.H"
#include "setRootCase.H"
#include "createTime.H"
IOdictionary solutionDict
(

6
applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Application
viewFactorGenerator
viewFactorsGen
Description
View factors are calculated based on a face agglomeration array
@ -572,7 +572,7 @@ int main(int argc, char *argv[])
label totalPatches = coarsePatches.size();
reduce(totalPatches, maxOp<label>());
// Matrix sum in j(Fij) for each i (if enclosure sum = 1
// Matrix sum in j(Fij) for each i (if enclosure sum = 1)
scalarSquareMatrix sumViewFactorPatch
(
totalPatches,

4
applications/utilities/preProcessing/wallFunctionTable/wallFunctionTableApp.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,7 +25,7 @@ Application
wallFunctionTable
Description
Generates a table suitable for use by tabulated wall functions
Generates a table suitable for use by tabulated wall functions.
\*---------------------------------------------------------------------------*/