diff --git a/src/OpenFOAM/db/Time/Time.H b/src/OpenFOAM/db/Time/Time.H index 2d1fefe6dd0676107459fb94f464aa63ad656fd2..cbb186b6313e168a7fe150ea95fa00bef71c7d5f 100644 --- a/src/OpenFOAM/db/Time/Time.H +++ b/src/OpenFOAM/db/Time/Time.H @@ -372,7 +372,7 @@ public: const word& constantName = "constant" ); - //- Write time dictionary to the <time>/uniform directory + //- Write time dictionary to the \<time\>/uniform directory virtual bool writeTimeDict() const; //- Write using given format, version and compression diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H index 2405cac9daafc2b665b79d9aa414b5eecc5196c3..cfe7e3a5444b88e86ebef21e5d958058d6e8e3b5 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H @@ -40,51 +40,51 @@ Description functionObject the following entry would be specified: \verbatim - functions + functions + { + <functionObjectName> { - <functionObjectName> - { - type functionObjectType; - libs ("libMyFunctionObjectlib.so"); - region defaultRegion; - enabled yes; - timeStart 0; - timeEnd 10; - writeControl writeTime; - writeInterval 1; - ... - } + type functionObjectType; + libs ("libMyFunctionObjectlib.so"); + region defaultRegion; + enabled yes; + timeStart 0; + timeEnd 10; + writeControl writeTime; + writeInterval 1; + ... } + } \endverbatim Where: \table Property | Description | Required | Default value 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 | enabled | On/off switch | no | yes timeStart| Start time | no | timeEnd | End time | no | - evaluateControl | See time controls below | no | timeStep - evaluateInterval | Steps between output | no | - writeControl | See time controls below | no | timeStep - writeInterval | Steps between output | no | + evaluateControl | See time controls below | no | timeStep + evaluateInterval | Steps between output | no | + writeControl | See time controls below | no | timeStep + writeInterval | Steps between output | no | \endtable Time controls: \table Option | Description 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 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 none | Execute/write every time-step \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 by the functionObject. The \c type entry defines the type of function object properties that follow. FunctionObjects are packaged into separate diff --git a/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H b/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H index 64b9f5cd6be0e089966bd193b20cc531671bbc6f..afab78ad5273a0aab8946c2698ab0ec754500a63 100644 --- a/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H +++ b/src/fvOptions/constraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H @@ -27,18 +27,25 @@ Class Description Fixed temperature equation constraint - Sources described by: +Usage + \verbatim + fixedTemperature + { + type fixedTemperatureConstraint; + active yes; fixedTemperatureConstraintCoeffs { - mode uniform; // uniform or lookup + mode uniform; // uniform or lookup // For uniform option temperature constant 500; // fixed temperature with time [K] // For lookup option - // T <Tname>; // optional temperature field name + // T <Tname>; // optional temperature field name } + } + \endverbatim Note: The 'uniform' option allows the use of a time-varying uniform temperature diff --git a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H index 72ed262638ae45e117e75d4411047e779405a9f9..dcd557f6246ade8d62050152910f3a70c5b98516 100644 --- a/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H +++ b/src/fvOptions/constraints/fixedValueConstraint/FixedValueConstraint.H @@ -27,6 +27,7 @@ Class Description Constrain the field values within a specified region. +Usage For example to set the turbulence properties within a porous region: \verbatim porosityTurbulence