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: Documentation updates

Browse Source
This commit is contained in:
andy
2013-06-13 12:58:03 +01:00
parent 15994afca1
commit ea94da2168
6 changed files with 26 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,8 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::XiGModel::basicSubGrid Foam::XiGModels::basicSubGrid
Description Description
@ -39,13 +38,14 @@ Description
and the removal: and the removal:
\f[ - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}} \f[
\frac{\Xi_{sub}-1}{\Xi_{sub}} \f] - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}}
\frac{\Xi_{sub}-1}{\Xi_{sub}}
\f]
Finally, \f$ G_{sub} \f$ is added to generation rate \f$ G_{in} \f$ Finally, \f$ G_{sub} \f$ is added to generation rate \f$ G_{in} \f$
due to the turbulence. due to the turbulence.
SourceFiles SourceFiles
basicSubGrid.C basicSubGrid.C
@ -64,7 +64,7 @@ namespace XiGModels
{ {
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class basicSubGrid Declaration Class basicSubGrid Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
class basicSubGrid class basicSubGrid

5
applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::XiEqModel::SCOPEXiEq Foam::XiEqModels::SCOPEXiEq
Description Description
Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
@ -120,7 +120,6 @@ public:
//- Update properties from given dictionary //- Update properties from given dictionary
virtual bool read(const dictionary& XiEqProperties); virtual bool read(const dictionary& XiEqProperties);
}; };

8
src/meshTools/searchableSurface/searchablePlate.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -54,7 +54,7 @@ namespace Foam
// Forward declaration of classes // Forward declaration of classes
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
Class searchablePlate Declaration Class searchablePlate Declaration
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
class searchablePlate class searchablePlate
@ -112,7 +112,7 @@ public:
( (
const IOobject& io, const IOobject& io,
const point& origin, const point& origin,
const point& span const vector& span
); );
//- Construct from dictionary (used by searchableSurface) //- Construct from dictionary (used by searchableSurface)
@ -122,6 +122,7 @@ public:
const dictionary& dict const dictionary& dict
); );
//- Destructor //- Destructor
virtual ~searchablePlate(); virtual ~searchablePlate();
@ -254,7 +255,6 @@ public:
notImplemented("searchablePlate::writeData(Ostream&) const"); notImplemented("searchablePlate::writeData(Ostream&) const");
return false; return false;
} }
}; };

20
src/postProcessing/functionObjects/doc/functionObjects.dox
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -57,14 +57,14 @@ functions
{ {
myFunctionObject // user-defined name of function object entry myFunctionObject // user-defined name of function object entry
{ {
type functionObjectType; type functionObjectType;
libs ("libMyFunctionObjectlib.so"); functionObjectLibs ("libMyFunctionObjectlib.so");
region defaultRegion; region defaultRegion;
enabled yes; enabled yes;
timeStart 0; timeStart 0;
timeEnd 10; timeEnd 10;
outputControl outputTime; outputControl outputTime;
outputInterval 1; outputInterval 1;
... ...
} }
} }
@ -74,7 +74,7 @@ Where:
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
type | type of function object | yes | type | type of function object | yes |
libs | libraries containing object implementation | yes | functionObjectLibs | libraries containing object implementation | yes |
region | name of region for multi-region cases | no | region | name of region for multi-region cases | no |
enabled | on/off switch | no | yes enabled | on/off switch | no | yes
timeStart| start time | no | timeStart| start time | no |

2
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H
View File

@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::iompressible::epsilonLowReWallFunctionFvPatchScalarField Foam::compressible::epsilonLowReWallFunctionFvPatchScalarField
Group Group
grpCmpWallFunctions grpCmpWallFunctions

4
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::compressible:::mutURoughWallFunctionFvPatchScalarField Foam::compressible::mutURoughWallFunctionFvPatchScalarField
Group Group
grpCmpWallFunctions grpCmpWallFunctions