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: doxygen documentation updates

Browse Source
This commit is contained in:
andy
2012-07-12 17:12:52 +01:00
parent c40bc965ed
commit a80d4d9b69
152 changed files with 1131 additions and 555 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -21,18 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::codedFunctionObject
\ingroup grpUtilitiesFunctionObjects
Description
functionObject using dynamic code compilation.
SourceFiles
codedFunctionObject.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::dsmcFields
\ingroup grpUtilitiesFunctionObjects
Description
Calculate intensive fields:
- UMean
@ -38,7 +37,6 @@ Description
SourceFiles
dsmcFields.C
IOdsmcFields.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::pressureCoefficient
\ingroup grpUtilitiesFunctionObjects
Description
Calculates pressure coefficient, \f$c_p\f$
@ -41,7 +40,6 @@ Description
SourceFiles
pressureCoefficient.C
IOpressureCoefficient.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::staticPressure
\ingroup grpUtilitiesFunctionObjects
Description
Converts kinematic pressure to static pressure, from the name of the
pressure field, and density, i.e.
@ -36,7 +35,6 @@ Description
SourceFiles
staticPressure.C
IOstaticPressure.H
@}
\*---------------------------------------------------------------------------*/

39
src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H
View File

@ -21,39 +21,38 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::timeActivatedFileUpdate
\ingroup grpUtilitiesFunctionObjects
Description
Performs a file copy/replacement once a specified time has been reached.
Example usage to update the fvSolution dictionary at various times
throughout the calculation:
fileUpdate1
{
type timeActivatedFileUpdate;
functionObjectLibs ("libutilityFunctionObjects.so");
outputControl timeStep;
outputInterval 1;
fileToUpdate "$FOAM_CASE/system/fvSolution";
timeVsFile
(
(-1 "$FOAM_CASE/system/fvSolution.0")
(0.10 "$FOAM_CASE/system/fvSolution.10")
(0.20 "$FOAM_CASE/system/fvSolution.20")
(0.35 "$FOAM_CASE/system/fvSolution.35")
);
}
\verbatim
fileUpdate1
{
type timeActivatedFileUpdate;
functionObjectLibs ("libutilityFunctionObjects.so");
outputControl timeStep;
outputInterval 1;
fileToUpdate "$FOAM_CASE/system/fvSolution";
timeVsFile
(
(-1 "$FOAM_CASE/system/fvSolution.0")
(0.10 "$FOAM_CASE/system/fvSolution.10")
(0.20 "$FOAM_CASE/system/fvSolution.20")
(0.35 "$FOAM_CASE/system/fvSolution.35")
);
}
\endverbatim
SourceFiles
timeActivatedFileUpdate.C
IOtimeActivatedFileUpdate.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::yPlusLES
\ingroup grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for LES models. Values written to
time folders as field 'yPlusLES'
@ -34,7 +33,6 @@ Description
SourceFiles
yPlusLES.C
IOyPlusLES.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H
View File

@ -21,12 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpUtilitiesFunctionObjects
@{
Class
Foam::yPlusRAS
\ingroup grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for RAS models. Values written to
time folders as field 'yPlusRAS'
@ -34,7 +33,6 @@ Description
SourceFiles
yPlusRAS.C
IOyPlusRAS.H
@}
\*---------------------------------------------------------------------------*/