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

Corrected documentation for Doxygen

Browse Source
This commit is contained in:
Henry Weller
2016-06-21 11:04:34 +01:00
parent 3990302a54
commit 7200384f18
4 changed files with 33 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/OpenFOAM/db/Time/Time.H
View File

@ -372,7 +372,7 @@ public:
const word& constantName = "constant" const word& constantName = "constant"
); );
//- Write time dictionary to the <time>/uniform directory //- Write time dictionary to the \<time\>/uniform directory
virtual bool writeTimeDict() const; virtual bool writeTimeDict() const;
//- Write using given format, version and compression //- Write using given format, version and compression

42
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -40,51 +40,51 @@ Description
functionObject the following entry would be specified: functionObject the following entry would be specified:
\verbatim \verbatim
functions functions
{
<functionObjectName>
{ {
<functionObjectName> type functionObjectType;
{ libs ("libMyFunctionObjectlib.so");
type functionObjectType; region defaultRegion;
libs ("libMyFunctionObjectlib.so"); enabled yes;
region defaultRegion; timeStart 0;
enabled yes; timeEnd 10;
timeStart 0; writeControl writeTime;
timeEnd 10; writeInterval 1;
writeControl writeTime; ...
writeInterval 1;
...
}
} }
}
\endverbatim \endverbatim
Where: 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 implementation | yes | libs | Libraries containing 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 |
timeEnd | End time | no | timeEnd | End time | no |
evaluateControl | See time controls below | no | timeStep evaluateControl | See time controls below | no | timeStep
evaluateInterval | Steps between output | no | evaluateInterval | Steps between output | no |
writeControl | See time controls below | no | timeStep writeControl | See time controls below | no | timeStep
writeInterval | Steps between output | no | writeInterval | Steps between output | no |
\endtable \endtable
Time controls: Time controls:
\table \table
Option | Description Option | Description
timeStep | Execute/write every 'writeInterval' time-steps timeStep | Execute/write every 'writeInterval' time-steps
writeTime | Execute/write every 'writeInterval' output times writeTime | Execute/write every 'writeInterval' output times
adjustableRunTime | Execute/write every 'writeInterval' run time period adjustableRunTime | Execute/write every 'writeInterval' run time period
runTime | Execute/write every 'writeInterval' run time period runTime | Execute/write every 'writeInterval' run time period
clockTime | Execute/write every 'writeInterval' clock time period clockTime | Execute/write every 'writeInterval' clock time period
cpuTime | Execute/write every 'writeInterval' CPU time period cpuTime | Execute/write every 'writeInterval' CPU time period
none | Execute/write every time-step none | Execute/write every time-step
\endtable \endtable
The sub-dictionary name \c <functionObjectName> is chosen by the user, and The sub-dictionary name \c \<functionObjectName\> is chosen by the user, and
is typically used as the name of the output directory for any data written is typically used as the name of the output directory for any data written
by the functionObject. The \c type entry defines the type of function by the functionObject. The \c type entry defines the type of function
object properties that follow. FunctionObjects are packaged into separate object properties that follow. FunctionObjects are packaged into separate

13
src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H
View File

@ -27,18 +27,25 @@ Class
Description Description
Fixed temperature equation constraint Fixed temperature equation constraint
Sources described by: Usage
\verbatim
fixedTemperature
{
type fixedTemperatureConstraint;
active yes;
fixedTemperatureConstraintCoeffs fixedTemperatureConstraintCoeffs
{ {
mode uniform; // uniform or lookup mode uniform; // uniform or lookup
// For uniform option // For uniform option
temperature constant 500; // fixed temperature with time [K] temperature constant 500; // fixed temperature with time [K]
// For lookup option // For lookup option
// T <Tname>; // optional temperature field name // T <Tname>; // optional temperature field name
} }
}
\endverbatim
Note: Note:
The 'uniform' option allows the use of a time-varying uniform temperature The 'uniform' option allows the use of a time-varying uniform temperature

1
src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H
View File

@ -27,6 +27,7 @@ Class
Description Description
Constrain the field values within a specified region. Constrain the field values within a specified region.
Usage
For example to set the turbulence properties within a porous region: For example to set the turbulence properties within a porous region:
\verbatim \verbatim
porosityTurbulence porosityTurbulence