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

Doxygen docs: Corrected doxyFilter to preserve line numbers

Browse Source 
Also corrected many formatting errors in the comments in C and H files
This commit is contained in:
Henry
2011-02-07 22:50:49 +00:00
parent 9c9e092f52
commit b3cde56f27
30 changed files with 143 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -39,7 +39,7 @@ Description
to Cavitation Prediction,” to Cavitation Prediction,”
Computers and Fluids, Computers and Fluids,
29(8):849-875, 2000. 29(8):849-875, 2000.
@verbatim @endverbatim
SourceFiles SourceFiles
Kunz.C Kunz.C

4
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H
View File

@ -2,7 +2,7 @@
========Merkle= | ========Merkle= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -33,7 +33,7 @@ Description
"Computational modeling of the dynamics of sheet cavitation", "Computational modeling of the dynamics of sheet cavitation",
in Proceedings Third International Symposium on Cavitation in Proceedings Third International Symposium on Cavitation
Grenoble, France 1998. Grenoble, France 1998.
@verbatim @endverbatim
SourceFiles SourceFiles
Merkle.C Merkle.C

4
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -33,7 +33,7 @@ Description
"Physical and Numerical Modeling of Unsteady Cavitation Dynamics", "Physical and Numerical Modeling of Unsteady Cavitation Dynamics",
Proc. 4th International Conference on Multiphase Flow, Proc. 4th International Conference on Multiphase Flow,
New Orleans, U.S.A., 2001. New Orleans, U.S.A., 2001.
@verbatim @endverbatim
SourceFiles SourceFiles
SchnerrSauer.C SchnerrSauer.C

8
applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,9 +30,9 @@ Description
- create baffles in original mesh with directMappedWall patches - create baffles in original mesh with directMappedWall patches
- if extruding boundary faces: - if extruding boundary faces:
- convert boundary faces to directMappedWall patches - convert boundary faces to directMappedWall patches
- extrude edges of faceZone as a <zone>_sidePatch - extrude edges of faceZone as a \<zone\>_sidePatch
- extrude edges inbetween different faceZones as a - extrude edges inbetween different faceZones as a
(nonuniformTransform)cyclic <zoneA>_<zoneB> (nonuniformTransform)cyclic \<zoneA\>_\<zoneB\>
- extrudes into master direction (i.e. away from the owner cell - extrudes into master direction (i.e. away from the owner cell
if flipMap is false) if flipMap is false)
- not parallel - not parallel
@ -106,7 +106,7 @@ becomes
Usage Usage
- extrudeToRegionMesh <regionName> <faceZones> <thickness> - extrudeToRegionMesh \<regionName\> \<faceZones\> \<thickness\>
@param \<regionName\> \n @param \<regionName\> \n
Name of mesh to create. Name of mesh to create.

2
bin/tools/doxyFilter
View File

@ -3,7 +3,7 @@
# ========= | # ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration | # \\ / O peration |
# \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. # \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
# \\/ M anipulation | # \\/ M anipulation |
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# License # License

6
bin/tools/doxyFilter.awk
View File

@ -2,7 +2,7 @@
# ========= | # ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration | # \\ / O peration |
# \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. # \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
# \\/ M anipulation | # \\/ M anipulation |
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# License # License
@ -57,7 +57,7 @@ BEGIN {
# start comment block # start comment block
if (state == 1) if (state == 1)
{ {
printf "/*!\n" printf "/*! "
state = 2 state = 2
} }
@ -79,7 +79,7 @@ BEGIN {
# end comment block # end comment block
if (state == 2) if (state == 2)
{ {
printf "*/\n" printf "*/ "
} }
state = 0 state = 0
print print

113
bin/tools/doxyFilter.sed
View File

@ -11,34 +11,20 @@
/^License/,/\*\//{ /^License/,/\*\//{
/^License/,\%http://www.gnu.org/licenses%{ /^License/,\%http://www.gnu.org/licenses%{
s?^License.*?\*\/\ s?^License.*?\*\/\
\/\*! @file %filePath%\ \/\*! \\file %filePath%\
<b>Original source file</b> <a href="%filePath%">%fileName%</a>\ <b>Original source file</b> <a href="%filePath%">%fileName%</a>\
\
\
\
\
\
\
\
\
? ?
/^ /d /^ /d
} }
# old FSF address
/^License/,/MA 0211.-130. USA/{
s?^License.*?\*\/\
\/\*! @file %filePath%\
<b>Original source file</b> <a href="%filePath%">%fileName%</a>\
?
/^ /d
}
# remove entry
/^Primitive *$/{
N
N
d
}
# remove entry
/^Implementation *$/{
N
N
d
}
# remove entry # remove entry
/^Application *$/{ /^Application *$/{
@ -47,12 +33,6 @@ N
d d
} }
# remove entry
/^Type *$/{
N
N
d
}
# remove entry # remove entry
/^Global *$/{ /^Global *$/{
@ -62,96 +42,109 @@ d
} }
# Primitive
# typename
# =>
# \\relates typename
#
/^Primitive *$/,/^[^ ]/{
s/^Primitive *$//
s/^ /\\relates /
}
# Class # Class
# Foam::className # Foam::className
# => # =>
# @class Foam::className # \\class Foam::className
# #
/^Class *$/,/^[^ ]/{ /^Class *$/,/^[^ ]/{
/^Class/d s/^Class *$//
s/^ /@class / s/^ /\\class /
} }
# Namespace # Namespace
# namespaceName # namespaceName
# => # =>
# @namespace namespaceName # \namespace namespaceName
# #
/^Namespace *$/,/^[^ ]/{ /^Namespace *$/,/^[^ ]/{
/^Namespace/d s/^Namespace//
s/^ /@namespace / s/^ /\\namespace /
} }
# Typedef # Typedef
# Foam::def # Foam::def
# => # =>
# @class Foam::def # \typedef Foam::def
# This is not strictly correct, but makes it easier to find the typedefs
/^Typedef *$/,/^[^ ]/{ /^Typedef *$/,/^[^ ]/{
/^Typedef/d s/^Typedef//
s/^ /@class / s/^ /\\typedef /
} }
# add anchor and use @brief # add anchor and use \brief
# the first paragraph will be 'brief' and the others 'detail' # the first paragraph will be 'brief' and the others 'detail'
/^Description *$/,/^[^ ]/{ /^Description *$/,/^[^ ]/{
/^Description/c\ /^Description/c\
<a class="anchor" name="Description"></a>\ <a class="anchor" name="Description"></a> \\brief
@brief
s/^ // s/^ //
} }
/^Usage *$/,/^[^ ]/{ /^Usage *$/,/^[^ ]/{
/^Usage/c\ /^Usage/c\
@par Usage \\par Usage
s/^ // s/^ //
} }
/^See *Also *$/,/^[^ ]/{ /^See *Also *$/,/^[^ ]/{
/^See *Also/c\ /^See *Also/c\
@see \\see
s/^ //
}
/^Author *$/,/^[^ ]/{
/^Author/c\
@author
s/^ // s/^ //
} }
/^Note *$/,/^[^ ]/{ /^Note *$/,/^[^ ]/{
/^Note/c\ /^Note/c\
@note \\note
s/^ // s/^ //
} }
# remove ToDo paragraph to avoid them showing on related pages # remove ToDo paragraph to avoid them showing on related pages
/^To[Dd]o *$/,/^ *$/d /^To[Dd]o *$/,/^[^ ]/{
s/^To[Dd]o *$//
s/^ .*//
}
/^Warning *$/,/^[^ ]/{ /^Warning *$/,/^[^ ]/{
/^Warning/c\ /^Warning/c\
@warning \\warning
s/^ // s/^ //
} }
/^Deprecated *$/,/^[^ ]/{ /^Deprecated *$/,/^[^ ]/{
/^Deprecated/c\ /^Deprecated/c\
@deprecated \\deprecated
s/^ // s/^ //
} }
/SourceFiles/,/^[ ]*$/{
s?SourceFiles?@par Source files\ /^SourceFiles *$/,/^$/{
<ul>\ s?SourceFiles?\\par Source files\
<li><a href="%filePath%">%fileName%</a></li>? <ul><li><a href="%filePath%">%fileName%</a></li>?
s?^[ ]*$?</ul>\ s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
? s?^$?</ul>?
}
/fileName%<\/a><\/li>$/{
N
s?\n$?</ul>?g
s/<\/li>\n/<\/li> /
s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>? s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
} }

6
doc/Doxygen/Doxyfile
View File

@ -1104,7 +1104,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create # When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads. # a tag file that is based on the input files it reads.
GENERATE_TAGFILE = GENERATE_TAGFILE = DTAGS
# If the ALLEXTERNALS tag is set to YES all external classes will be listed # If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes # in the class index. If set to NO only the inherited external classes
@ -1254,7 +1254,7 @@ DOTFILE_DIRS =
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50 DOT_GRAPH_MAX_NODES = 10
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable # graphs generated by dot. A depth value of 3 means that only nodes reachable
@ -1264,7 +1264,7 @@ DOT_GRAPH_MAX_NODES = 50
# code bases. Also note that the size of a graph can be further restricted by # code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 3 MAX_DOT_GRAPH_DEPTH = 1
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, which results in a white background. # background. This is disabled by default, which results in a white background.

5
doc/doxygen/Doxyfile
View File

@ -581,7 +581,8 @@ WARN_LOGFILE =
# limit input for testing purposes # limit input for testing purposes
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \ INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
$(WM_PROJECT_DIR)/src/OpenFOAM/containers \ $(WM_PROJECT_DIR)/src/OpenFOAM/containers \
$(WM_PROJECT_DIR)/src/OpenFOAM/primitives $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \
$(WM_PROJECT_DIR)/src/finiteVolume/fvMesh
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -1353,7 +1354,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create # When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads. # a tag file that is based on the input files it reads.
GENERATE_TAGFILE = GENERATE_TAGFILE = DTAGS
# If the ALLEXTERNALS tag is set to YES all external classes will be listed # If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes # in the class index. If set to NO only the inherited external classes

4
src/OSspecific/POSIX/fileMonitor.C
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -109,7 +109,6 @@ namespace Foam
//! @cond internalClass
//- Internal tracking via stat(3p) or inotify(7) //- Internal tracking via stat(3p) or inotify(7)
class fileMonitorWatcher class fileMonitorWatcher
{ {
@ -288,7 +287,6 @@ namespace Foam
} }
}; };
//! @endcond
} }

7
src/OpenFOAM/db/runTimeSelection/globalFunctions/addToGlobalFunctionSelectionTable.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
@file Foam::addToGlobalFunctionSelectionTable Global
Foam::addToGlobalFunctionSelectionTable
Description Description
Macros for easy insertion into global function selection tables Macros for easy insertion into global function selection tables
@ -33,7 +34,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// add to hash-table of functions with 'lookup' as the key // add to hash-table of functions with 'lookup' as the key
#define addNamedToGlobalFunctionSelectionTable\ #define addNamedToGlobalFunctionSelectionTable\
(memberFunction,argNames,lookup,functionPtr) \ (memberFunction,argNames,lookup,functionPtr) \
@ -46,7 +46,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif #endif
// ************************************************************************* // // ************************************************************************* //

7
src/OpenFOAM/db/runTimeSelection/globalFunctions/globalFunctionSelectionTables.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
@file Foam::globalFunctionSelectionTables Global
Foam::globalFunctionSelectionTables
Description Description
Macros to enable the easy declaration of global function selection tables. Macros to enable the easy declaration of global function selection tables.
@ -35,7 +36,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// external use: // external use:
// ~~~~~~~~~~~~~ // ~~~~~~~~~~~~~
// declare a run-time selection: // declare a run-time selection:
@ -138,7 +138,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif #endif
// ************************************************************************* // // ************************************************************************* //

6
src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/addToStaticMemberFunctionSelectionTable.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
@file Foam::addToStaticMemberFunctionSelectionTable Global
Foam::addToStaticMemberFunctionSelectionTable
Description Description
Macros for easy insertion into member function selection tables Macros for easy insertion into member function selection tables
@ -47,7 +48,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif #endif
// ************************************************************************* // // ************************************************************************* //

7
src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/staticMemberFunctionSelectionTables.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
@file Foam::staticMemberFunctionSelectionTables Global
Foam::staticMemberFunctionSelectionTables
Description Description
Macros to enable the easy declaration of member function selection tables. Macros to enable the easy declaration of member function selection tables.
@ -35,7 +36,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// external use: // external use:
// ~~~~~~~~~~~~~ // ~~~~~~~~~~~~~
// declare a run-time selection: // declare a run-time selection:
@ -140,7 +140,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif #endif
// ************************************************************************* // // ************************************************************************* //

4
src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -25,7 +25,7 @@ Class
Foam::interpolationTable Foam::interpolationTable
Description Description
An interpolation/look-up table of scalar vs <Type> values. An interpolation/look-up table of scalar vs \<Type\> values.
The reference scalar values must be monotonically increasing. The reference scalar values must be monotonically increasing.
The handling of out-of-bounds values depends on the current setting The handling of out-of-bounds values depends on the current setting

4
src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::DiagonalMatrix<Type> Foam::DiagonalMatrix
Description Description
DiagonalMatrix<Type> is a 2D diagonal matrix of objects DiagonalMatrix<Type> is a 2D diagonal matrix of objects

2
src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H
View File

@ -27,7 +27,7 @@ Class
Description Description
Templated basic entry that holds a constant value. Templated basic entry that holds a constant value.
Usage - for entry <entryName> having the value <value>: Usage - for entry \<entryName\> having the value <value>:
@verbatim @verbatim
<entryName> constant <value> <entryName> constant <value>
@endverbatim @endverbatim

2
src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H
View File

@ -27,7 +27,7 @@ Class
Description Description
Templated table container data entry. Items are stored in a list of Templated table container data entry. Items are stored in a list of
Tuple2's. First column is always stored as scalar entries. Data is read Tuple2's. First column is always stored as scalar entries. Data is read
in the form, e.g. for an entry <entryName> that is (scalar, vector): in the form, e.g. for an entry \<entryName\> that is (scalar, vector):
@verbatim @verbatim
<entryName> table <entryName> table

2
src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H
View File

@ -26,7 +26,7 @@ Class
Description Description
Polynomial container data entry for scalars. Items are stored in a list of Polynomial container data entry for scalars. Items are stored in a list of
Tuple2's. Data is input in the form, e.g. for an entry <entryName> that Tuple2's. Data is input in the form, e.g. for an entry \<entryName\> that
describes y = x^2 + 2x^3 describes y = x^2 + 2x^3
@verbatim @verbatim

10
src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
View File

@ -49,21 +49,21 @@ namespace Foam
//- An optimized version of Hasher //- An optimized version of Hasher
// @param[in] data - an array of uint32_t values // @param[in] data - an array of uint32_t values
// @param[in] len - the number of values (not bytes) // @param[in] length - the number of values (not bytes)
// @param[in] seed - the previous hash, or an arbitrary value // @param[in] seed - the previous hash, or an arbitrary value
unsigned HasherInt(const uint32_t*, size_t length, unsigned seed = 0); unsigned HasherInt(const uint32_t* data, size_t length, unsigned seed = 0);
//- An optimized version of Hasher, returning dual hash values //- An optimized version of Hasher, returning dual hash values
// @param[in] data - an array of uint32_t values // @param[in] data - an array of uint32_t values
// @param[in] len - the number of values (not bytes) // @param[in] length - the number of values (not bytes)
// @param[in] hash1 - the previous hash, or an arbitrary value // @param[in] hash1 - the previous hash, or an arbitrary value
// on output, the primary hash value // on output, the primary hash value
// @param[in] hash1 - the previous hash, or an arbitrary value // @param[in] hash1 - the previous hash, or an arbitrary value
// on output, the secondary hash value // on output, the secondary hash value
unsigned HasherDual unsigned HasherDual
( (
const uint32_t*, const uint32_t* data,
size_t len, size_t length,
unsigned& hash1, unsigned& hash1,
unsigned& hash2 unsigned& hash2
); );

4
src/finiteVolume/cfdTools/general/porousMedia/PorousZones.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::PorousZones<ZoneType> Foam::PorousZones
Description Description
A centralized ZoneType collection. A centralized ZoneType collection.

14
src/finiteVolume/fvMesh/fvMesh.H
View File

@ -1,8 +1,8 @@
/*---------------------------------------------------------------------------*\ /*---------------------------------------------------------------------------*\
========= | ========= |
\\ / F ield | OpenFOAM: The Open So \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -42,6 +42,16 @@ SourceFiles
fvMesh.C fvMesh.C
fvMeshGeometry.C fvMeshGeometry.C
See Also
hmm
Usage
oeuoeuoeu
ToDo
oeuoeuoeu
oeueouoeu
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef fvMesh_H #ifndef fvMesh_H

6
src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolation/surfaceInterpolate.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -156,14 +156,14 @@ namespace fvc
); );
//- Interpolate tmp field onto faces using 'interpolate(<name>)' //- Interpolate tmp field onto faces using 'interpolate(\<name\>)'
template<class Type> template<class Type>
static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
( (
const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
); );
//- Interpolate tmp field onto faces using 'interpolate(<name>)' //- Interpolate tmp field onto faces using 'interpolate(\<name\>)'
template<class Type> template<class Type>
static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
( (

2
src/lagrangian/basic/Cloud/Cloud.H
View File

@ -381,7 +381,7 @@ public:
IOstream::compressionType cmp IOstream::compressionType cmp
) const; ) const;
//- Write positions to <cloudName>_positions.obj file //- Write positions to \<cloudName\>_positions.obj file
void writePositions() const; void writePositions() const;

10
src/postProcessing/foamCalcFunctions/basic/addSubtract/addSubtract.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,10 +28,10 @@ Description
adds/subtracts a field or value to/from a base field. adds/subtracts a field or value to/from a base field.
New field name specified by -resultName option, or automatically as: New field name specified by -resultName option, or automatically as:
<baseFieldName>_add_<addSubtractFieldName> \<baseFieldName\>_add_<addSubtractFieldName>
<baseFieldName>_add_value \<baseFieldName\>_add_value
<baseFieldName>_subtract_<addSubtractFieldName> \<baseFieldName\>_subtract_<addSubtractFieldName>
<baseFieldName>_subtract_value \<baseFieldName\>_subtract_value
Example usage: Example usage:
addSubtract p add -value 100000 -resultName pAbs addSubtract p add -value 100000 -resultName pAbs

4
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::compressible::RASModels::mutRoughWallFunctionFvPatchScalarField Foam::compressible::RASModels::mutkRoughWallFunctionFvPatchScalarField
Description Description
Boundary condition for turbulent (kinematic) viscosity when using wall Boundary condition for turbulent (kinematic) viscosity when using wall

4
src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::LESmodels::SpalartAllmaras Foam::incompressible::LESModels::SpalartAllmaras
Description Description
SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows

4
src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::LESmodels::SpalartAllmarasDDES Foam::incompressible::LESModels::SpalartAllmarasDDES
Description Description
SpalartAllmaras DDES LES turbulence model for incompressible flows SpalartAllmaras DDES LES turbulence model for incompressible flows

4
src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::LESmodels::SpalartAllmarasIDDES Foam::incompressible::LESModels::SpalartAllmarasIDDES
Description Description
SpalartAllmarasIDDES LES turbulence model for incompressible flows SpalartAllmarasIDDES LES turbulence model for incompressible flows

4
src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::LESmodels::kOmegaSSTSAS Foam::incompressible::LESModels::kOmegaSSTSAS
Description Description
kOmegaSSTSAS LES turbulence model for incompressible flows kOmegaSSTSAS LES turbulence model for incompressible flows