Commit 354d0ae7 authored by andy's avatar andy
Browse files

ENH: First pass through doxygen info updates for function objects

parent 5ebb8dc4
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
......
......@@ -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
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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
@}
\*---------------------------------------------------------------------------*/
......
......@@ -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