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

6
src/postProcessing/functionObjects/IO/partialWrite/partialWrite.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::partialWrite
@ -33,6 +36,7 @@ Description
SourceFiles
partialWrite.C
IOpartialWrite.H
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.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::removeRegisteredObject
@ -30,6 +33,7 @@ Description
SourceFiles
removeRegisteredObject.C
IOremoveRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.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::writeRegisteredObject
@ -30,6 +33,7 @@ Description
SourceFiles
writeRegisteredObject.C
IOwriteRegisteredObject.H
@}
\*---------------------------------------------------------------------------*/

13
src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H
View File

@ -21,19 +21,22 @@ 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::cloudInfo
Description
Outputs cloud information to file
Currently outputs:
- total current number of parcels
- total current mass of parcels
This function object outputs lagrangian cloud information to a file. The
current outputs include:
- total current number of parcels
- total current mass of parcels
SourceFiles
cloudInfo.C
IOcloudInfo.H
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.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::fieldAverage
@ -79,6 +82,7 @@ Description
SourceFiles
fieldAverage.C
fieldAverageTemplates.C
@}
\*---------------------------------------------------------------------------*/

8
src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.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,7 +21,10 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
\addtogroup functionObjects
@{
class
Foam::fieldCoordinateSystemTransform
Description
@ -31,6 +34,7 @@ Description
SourceFiles
fieldCoordinateSystemTransform.C
IOfieldCoordinateSystemTransform.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.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::fieldMinMax
@ -36,6 +39,7 @@ Description
SourceFiles
fieldMinMax.C
IOfieldMinMax.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.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::fieldValue
@ -29,6 +32,7 @@ Description
SourceFiles
fieldValue.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.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::nearWallFields
@ -53,6 +56,7 @@ Description
SourceFiles
nearWallFields.C
IOnearWallFields.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/processorField/processorField.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::processorField
@ -31,6 +34,7 @@ Description
SourceFiles
processorField.C
IOprocessorField.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/readFields/readFields.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::readFields
@ -31,6 +34,7 @@ Description
SourceFiles
readFields.C
IOreadFields.H
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.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::regionSizeDistribution
@ -33,6 +36,7 @@ Description
SourceFiles
regionSizeDistribution.C
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/streamLine/streamLine.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::streamLine
@ -29,6 +32,7 @@ Description
SourceFiles
streamLine.C
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.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::surfaceInterpolateFields
@ -49,6 +52,7 @@ Description
SourceFiles
surfaceInterpolateFields.C
IOsurfaceInterpolateFields.H
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.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::turbulenceFields
@ -34,6 +37,7 @@ Description
SourceFiles
turbulenceFields.C
@}
\*---------------------------------------------------------------------------*/

4
src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.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::wallBoundedStreamLine
@ -29,6 +32,7 @@ Description
SourceFiles
wallBoundedStreamLine.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.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::forceCoeffs
@ -31,6 +34,7 @@ Description
SourceFiles
forceCoeffs.C
IOforceCoeffs.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/forces/forces/forces.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::forces
@ -51,6 +54,7 @@ Note
SourceFiles
forces.C
IOforces.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.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::abortCalculation
@ -36,6 +39,7 @@ Description
SourceFiles
abortCalculation.C
IOabortCalculation.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/systemCall/systemCall.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::systemCall
@ -30,6 +33,7 @@ Description
SourceFiles
systemCall.C
IOsystemCall.H
@}
\*---------------------------------------------------------------------------*/

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
@}
\*---------------------------------------------------------------------------*/

6
src/sampling/probes/probes.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::probes
@ -31,6 +34,7 @@ Description
SourceFiles
probes.C
@}
\*---------------------------------------------------------------------------*/

4
src/sampling/sampledSet/sampledSet/sampledSet.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::sampledSet
@ -35,6 +38,7 @@ Description
SourceFiles
sampledSet.C
@}
\*---------------------------------------------------------------------------*/

4
src/sampling/sampledSurface/sampledSurface/sampledSurface.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::sampledSurface
@ -43,6 +46,7 @@ Description
SourceFiles
sampledSurface.C
sampledSurfaceTemplates.C
@}
\*---------------------------------------------------------------------------*/