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/field/fieldAverage/fieldAverage/fieldAverage.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 grpFieldFunctionObjects
@{
Class
Foam::fieldAverage
\ingroup grpFieldFunctionObjects
Description
Calculates the field averages given list of fieldAverageItems, e.g.
@ -83,7 +82,6 @@ Description
SourceFiles
fieldAverage.C
fieldAverageTemplates.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.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 grpFieldFunctionObjects
@{
class
Foam::fieldCoordinateSystemTransform
\ingroup grpFieldFunctionObjects
Description
Transforms fields from global cartesian co-ordinates to local co-ordinate
system
@ -35,7 +34,6 @@ SourceFiles
fieldCoordinateSystemTransform.C
fieldCoordinateSystemTransformTemplates.C
IOfieldCoordinateSystemTransform.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.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 grpFieldFunctionObjects
@{
Class
Foam::fieldMinMax
\ingroup grpFieldFunctionObjects
Description
Calculates scalar minimim and maximum field values.
@ -39,7 +38,6 @@ Description
SourceFiles
fieldMinMax.C
IOfieldMinMax.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.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 grpFieldFunctionObjects
@{
Class
Foam::fieldValue
\ingroup grpFieldFunctionObjects
Description
Base class for field value -based function objects.
SourceFiles
fieldValue.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.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 grpFieldFunctionObjects
@{
Class
Foam::nearWallFields
\ingroup grpFieldFunctionObjects
Description
Samples near-patch volFields
@ -56,7 +55,6 @@ Description
SourceFiles
nearWallFields.C
IOnearWallFields.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/processorField/processorField.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 grpFieldFunctionObjects
@{
Class
Foam::processorField
\ingroup grpFieldFunctionObjects
Description
Writes a scalar field whose value is the local processor ID. Output
field name is processorID.
@ -34,7 +33,6 @@ Description
SourceFiles
processorField.C
IOprocessorField.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/readFields/readFields.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 grpFieldFunctionObjects
@{
Class
Foam::readFields
\ingroup grpFieldFunctionObjects
Description
Reads fields from the time folders and adds them to the mesh database
for further post-processing.
@ -34,7 +33,6 @@ Description
SourceFiles
readFields.C
IOreadFields.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.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 grpFieldFunctionObjects
@{
Class
Foam::regionSizeDistribution
\ingroup grpFieldFunctionObjects
Description
Looks up a field, interpolates it to the faces and determines a connected
region from a patch where the field is above a certain value.
@ -36,7 +35,6 @@ Description
SourceFiles
regionSizeDistribution.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/streamLine/streamLine.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 grpFieldFunctionObjects
@{
Class
Foam::streamLine
\ingroup grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.
SourceFiles
streamLine.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.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 grpFieldFunctionObjects
@{
Class
Foam::surfaceInterpolateFields
\ingroup grpFieldFunctionObjects
Description
Linear interpolates volFields to surfaceFields
@ -52,7 +51,6 @@ Description
SourceFiles
surfaceInterpolateFields.C
IOsurfaceInterpolateFields.H
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.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 grpFieldFunctionObjects
@{
Class
Foam::turbulenceFields
\ingroup grpFieldFunctionObjects
Description
Stores turbulence fields on the mesh database for further manipulation.
@ -37,7 +36,6 @@ Description
SourceFiles
turbulenceFields.C
@}
\*---------------------------------------------------------------------------*/

6
src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.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 grpFieldFunctionObjects
@{
Class
Foam::wallBoundedStreamLine
\ingroup grpFieldFunctionObjects
Description
Generation of streamlines. Samples along track of passive particle.
SourceFiles
wallBoundedStreamLine.C
@}
\*---------------------------------------------------------------------------*/