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: First pass through doxygen info updates for function objects

Browse Source
This commit is contained in:
andy
2012-07-11 12:26:08 +01:00
parent 5ebb8dc482
commit 354d0ae7ce
30 changed files with 147 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::codedFunctionObject
@ -29,6 +32,7 @@ Description
SourceFiles
codedFunctionObject.C
@}
\*---------------------------------------------------------------------------*/
@ -90,6 +94,7 @@ protected:
// Get the dictionary to initialize the codeContext
virtual const dictionary& codeDict() const;
private:
//- Disallow default bitwise copy construct

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::dsmcFields
@ -35,6 +38,7 @@ Description
SourceFiles
dsmcFields.C
IOdsmcFields.H
@}
\*---------------------------------------------------------------------------*/
@ -69,6 +73,7 @@ class dsmcFields
//- on/off switch
bool active_;
// Private Member Functions
//- Disallow default bitwise copy construct

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

@ -21,13 +21,18 @@ 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 functionObjects
@{
Class
Foam::pressureCoefficient
Description
Calculates pressure coefficient, c_p
Calculates pressure coefficient, \f$c_p\f$
c_p = p/p_dyn,inf
\f[
c_p = p/p_{dyn,inf}
\f]
where:
@ -36,6 +41,7 @@ Description
SourceFiles
pressureCoefficient.C
IOpressureCoefficient.H
@}
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::staticPressure
@ -33,6 +36,7 @@ Description
SourceFiles
staticPressure.C
IOstaticPressure.H
@}
\*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::timeActivatedFileUpdate
@ -50,6 +53,7 @@ Description
SourceFiles
timeActivatedFileUpdate.C
IOtimeActivatedFileUpdate.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::yPlusLES
@ -31,6 +34,7 @@ Description
SourceFiles
yPlusLES.C
IOyPlusLES.H
@}
\*---------------------------------------------------------------------------*/

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

@ -21,6 +21,9 @@ 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 functionObjects
@{
Class
Foam::yPlusRAS
@ -31,6 +34,7 @@ Description
SourceFiles
yPlusRAS.C
IOyPlusRAS.H
@}
\*---------------------------------------------------------------------------*/