Commit ea94da21 authored by andy's avatar andy
Browse files

ENH: Documentation updates

parent 15994afc
......@@ -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
......@@ -22,8 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::XiGModel::basicSubGrid
Foam::XiGModels::basicSubGrid
Description
......@@ -39,13 +38,14 @@ Description
and the removal:
\f[ - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}}
\frac{\Xi_{sub}-1}{\Xi_{sub}} \f]
\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$
due to the turbulence.
SourceFiles
basicSubGrid.C
......@@ -64,7 +64,7 @@ namespace XiGModels
{
/*---------------------------------------------------------------------------*\
Class basicSubGrid Declaration
Class basicSubGrid Declaration
\*---------------------------------------------------------------------------*/
class basicSubGrid
......
......@@ -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
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::XiEqModel::SCOPEXiEq
Foam::XiEqModels::SCOPEXiEq
Description
Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
......@@ -120,7 +120,6 @@ public:
//- Update properties from given dictionary
virtual bool read(const dictionary& XiEqProperties);
};
......
......@@ -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
......@@ -54,7 +54,7 @@ namespace Foam
// Forward declaration of classes
/*---------------------------------------------------------------------------*\
Class searchablePlate Declaration
Class searchablePlate Declaration
\*---------------------------------------------------------------------------*/
class searchablePlate
......@@ -112,7 +112,7 @@ public:
(
const IOobject& io,
const point& origin,
const point& span
const vector& span
);
//- Construct from dictionary (used by searchableSurface)
......@@ -122,6 +122,7 @@ public:
const dictionary& dict
);
//- Destructor
virtual ~searchablePlate();
......@@ -254,7 +255,6 @@ public:
notImplemented("searchablePlate::writeData(Ostream&) const");
return false;
}
};
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2013 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -57,14 +57,14 @@ functions
{
myFunctionObject // user-defined name of function object entry
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
timeStart 0;
timeEnd 10;
outputControl outputTime;
outputInterval 1;
type functionObjectType;
functionObjectLibs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
timeStart 0;
timeEnd 10;
outputControl outputTime;
outputInterval 1;
...
}
}
......@@ -74,7 +74,7 @@ Where:
\table
Property | Description | Required | Default value
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 |
enabled | on/off switch | no | yes
timeStart| start time | no |
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::iompressible::epsilonLowReWallFunctionFvPatchScalarField
Foam::compressible::epsilonLowReWallFunctionFvPatchScalarField
Group
grpCmpWallFunctions
......
......@@ -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
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::compressible:::mutURoughWallFunctionFvPatchScalarField
Foam::compressible::mutURoughWallFunctionFvPatchScalarField
Group
grpCmpWallFunctions
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment