zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen documentation: Standardized the 'See also' heading

Browse Source
This commit is contained in:
Henry Weller
2016-06-17 17:31:34 +01:00
parent 2ca0a6f362
commit 8a5304edf6
288 changed files with 343 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField with A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField with
a fixed volumetric phase-change mass flux. a fixed volumetric phase-change mass flux.
SeeAlso See also
Foam::compressible:: Foam::compressible::
alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField

2
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -55,7 +55,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField
SourceFiles SourceFiles

4
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -51,7 +51,7 @@ Description
Daejeon, Korea, September 10-12 2012 Daejeon, Korea, September 10-12 2012
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

4
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Group
Description Description
Copies the boundary values from a user specified field. Copies the boundary values from a user specified field.
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

4
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -36,7 +36,7 @@ Description
- Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases - Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases
- Use 'copiedFixedValue' for all the other phases. - Use 'copiedFixedValue' for all the other phases.
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

4
applications/test/FixedList/Test-FixedList.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ Application
Description Description
Simple tests and examples of use of FixedList Simple tests and examples of use of FixedList
See Also See also
Foam::FixedList Foam::FixedList
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
applications/test/List/Test-List.C
View File

@ -27,7 +27,7 @@ Application
Description Description
Simple tests and examples of use of List Simple tests and examples of use of List
See Also See also
Foam::List Foam::List
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
View File

@ -44,7 +44,7 @@ Note
will be used if available. Otherwise the cellZones are used when will be used if available. Otherwise the cellZones are used when
creating the cellTable information. creating the cellTable information.
See Also See also
Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.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) 2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -40,7 +40,7 @@ Description
Note Note
To use the \c -fixedValue option, the \c -field option should also be used To use the \c -fixedValue option, the \c -field option should also be used
SeeAlso See also
Foam::helpType Foam::helpType
Foam::fvPatchField Foam::fvPatchField

4
applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.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) 2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -33,7 +33,7 @@ Description
\c -browse \<patch type\> | open documentation for object in browser \c -browse \<patch type\> | open documentation for object in browser
\endplaintable \endplaintable
SeeAlso See also
Foam::helpType Foam::helpType
Foam::functionObject Foam::functionObject

2
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H
View File

@ -53,7 +53,7 @@ Usage
objectNames | objects to write | yes | objectNames | objects to write | yes |
\endtable \endtable
SeeAlso See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::timeControl Foam::functionObjects::timeControl

2
applications/utilities/postProcessing/noise/noise.C
View File

@ -71,7 +71,7 @@ Usage
- one-third-octave-band PFL spectrum - one-third-octave-band PFL spectrum
- one-third-octave-band pressure spectrum - one-third-octave-band pressure spectrum
SeeAlso See also
CSV.H CSV.H
noiseFFT.H noiseFFT.H

4
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.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) 2013-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -41,7 +41,7 @@ Note:
The addressing is patch-local, i.e. point indices for each patch point The addressing is patch-local, i.e. point indices for each patch point
used for face addressing starts at index 0. used for face addressing starts at index 0.
SeeAlso See also
externalCoupledMixedFvPatchField externalCoupledMixedFvPatchField
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
bin/foamExec
View File

@ -43,7 +43,7 @@
# #
# foamEtcFile must be found in the same directory as this script # foamEtcFile must be found in the same directory as this script
# #
# SeeAlso # See also
# foamEtcFile # foamEtcFile
# #
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------

4
bin/tools/doxyFilter.sed
View File

@ -123,8 +123,8 @@ s/^ //
} }
/^See *Also *$/,/^[^ ]/{ /^See *[Aa]lso *$/,/^[^ ]/{
/^See *Also/c\ /^See *[Aa]lso/c\
\\see \\see
s/^ // s/^ //
} }

2
etc/config.csh/example/prefs.csh
View File

@ -30,7 +30,7 @@
# The prefs.csh file will be sourced by the OpenFOAM etc/cshrc when it is # The prefs.csh file will be sourced by the OpenFOAM etc/cshrc when it is
# found by foamEtcFile. # found by foamEtcFile.
# #
# See Also # See also
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the # 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched # paths searched
# #

2
etc/config.sh/example/prefs.sh
View File

@ -30,7 +30,7 @@
# The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is # The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is
# found by foamEtcFile. # found by foamEtcFile.
# #
# See Also # See also
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the # 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched # paths searched
# #

4
src/ODE/ODESolvers/RKDP45/RKDP45.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) 2013-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -43,7 +43,7 @@ Description
Springer-Verlag, Berlin. 1993, ISBN 3-540-56670-8. Springer-Verlag, Berlin. 1993, ISBN 3-540-56670-8.
\endverbatim \endverbatim
SeeAlso See also
Foam::RKF45 Foam::RKF45
Foam::RKCK45 Foam::RKCK45

4
src/OSspecific/POSIX/cpuTime/cpuTime.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ Class
Description Description
Starts timing CPU usage and return elapsed time from start. Starts timing CPU usage and return elapsed time from start.
SeeAlso See also
clockTime clockTime
SourceFiles SourceFiles

4
src/OSspecific/POSIX/regExp.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
The PCRE '(?i)' extension is provided to compile the regular expression The PCRE '(?i)' extension is provided to compile the regular expression
as being case-insensitive. as being case-insensitive.
SeeAlso See also
The manpage regex(7) for more information about POSIX regular expressions. The manpage regex(7) for more information about POSIX regular expressions.
These differ somewhat from \c Perl and \c sed regular expressions. These differ somewhat from \c Perl and \c sed regular expressions.

4
src/OSspecific/POSIX/signals/sigInt.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the The standard interupt handler is overridden to ensure that the
runningJob file is removed. runningJob file is removed.
See Also See also
Foam::JobInfo Foam::JobInfo
SourceFiles SourceFiles

4
src/OSspecific/POSIX/signals/sigQuit.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the The standard interupt handler is overridden to ensure that the
runningJob file is removed. runningJob file is removed.
See Also See also
Foam::JobInfo Foam::JobInfo
SourceFiles SourceFiles

4
src/OSspecific/POSIX/signals/sigSegv.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
The standard interupt handler is overridden to ensure that the The standard interupt handler is overridden to ensure that the
runningJob file is removed. runningJob file is removed.
See Also See also
Foam::JobInfo Foam::JobInfo
SourceFiles SourceFiles

2
src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H
View File

@ -36,7 +36,7 @@ Note
gcc 2.95.2 so it has to be instantiated for T when an instantiation of gcc 2.95.2 so it has to be instantiated for T when an instantiation of
DictionaryBase is requested DictionaryBase is requested
See Also See also
Dictionary and UDictionary Dictionary and UDictionary
SourceFiles SourceFiles

2
src/OpenFOAM/containers/HashTables/Map/Map.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A HashTable to objects of type \<T\> with a label key. A HashTable to objects of type \<T\> with a label key.
See Also See also
PtrMap PtrMap
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/containers/HashTables/PtrMap/PtrMap.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A HashTable of pointers to objects of type \<T\> with a label key. A HashTable of pointers to objects of type \<T\> with a label key.
See Also See also
Map, HashPtrTable Map, HashPtrTable
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/containers/Lists/IndirectList/IndirectList.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A List with indirect addressing. A List with indirect addressing.
SeeAlso See also
Foam::UIndirectList for a version without any allocation for the Foam::UIndirectList for a version without any allocation for the
addressing. addressing.

2
src/OpenFOAM/containers/Lists/PackedList/PackedBoolList.H
View File

@ -35,7 +35,7 @@ SourceFiles
PackedBoolListI.H PackedBoolListI.H
PackedBoolList.C PackedBoolList.C
SeeAlso See also
Foam::PackedList Foam::PackedList
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/containers/Lists/PackedList/PackedList.H
View File

@ -89,7 +89,7 @@ Note
\endverbatim \endverbatim
In both cases, the supplied indices can be randomly ordered. In both cases, the supplied indices can be randomly ordered.
SeeAlso See also
Foam::DynamicList Foam::DynamicList
SourceFiles SourceFiles

2
src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H
View File

@ -36,7 +36,7 @@ Description
The usual expansion of environment variables and other constructs The usual expansion of environment variables and other constructs
(eg, the \c ~OpenFOAM/ expansion) is retained. (eg, the \c ~OpenFOAM/ expansion) is retained.
See Also See also
fileName, string::expand() fileName, string::expand()
SourceFiles SourceFiles

2
src/OpenFOAM/db/dictionary/functionEntries/includeEtcEntry/includeEtcEntry.H
View File

@ -51,7 +51,7 @@ Description
The usual expansion of environment variables and other constructs is The usual expansion of environment variables and other constructs is
retained. retained.
See Also See also
findEtcFile, fileName, string::expand() findEtcFile, fileName, string::expand()
SourceFiles SourceFiles

2
src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H
View File

@ -55,7 +55,7 @@ Description
#includeFunc mag(p) #includeFunc mag(p)
\endverbatim \endverbatim
See Also See also
Foam::functionObjectList Foam::functionObjectList
SourceFiles SourceFiles

4
src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
The \c \#includeIfPresent directive is similar to the \c \#include The \c \#includeIfPresent directive is similar to the \c \#include
directive, but does not generate an error if the file does not exist. directive, but does not generate an error if the file does not exist.
See Also See also
Foam::functionEntries::includeEntry Foam::functionEntries::includeEntry
SourceFiles SourceFiles

2
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -97,7 +97,7 @@ Class
Description Description
Abstract base-class for Time/database function objects. Abstract base-class for Time/database function objects.
See Also See also
Foam::functionObjectList Foam::functionObjectList
Foam::functionObjects::timeControl Foam::functionObjects::timeControl

2
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
View File

@ -28,7 +28,7 @@ Description
List of function objects with start(), execute() and end() functions List of function objects with start(), execute() and end() functions
that is called for each object. that is called for each object.
See Also See also
Foam::functionObject Foam::functionObject
Foam::functionObjects::timeControl Foam::functionObjects::timeControl

2
src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H
View File

@ -28,7 +28,7 @@ Description
Specialization of Foam::functionObject for a region and providing a Specialization of Foam::functionObject for a region and providing a
reference to the region Foam::objectRegistry. reference to the region Foam::objectRegistry.
SeeAlso See also
Foam::functionObject Foam::functionObject
SourceFiles SourceFiles

2
src/OpenFOAM/db/functionObjects/writeFile/writeFile.H
View File

@ -27,7 +27,7 @@ Class
Description Description
functionObject base class for writing single files functionObject base class for writing single files
See Also See also
Foam::regionFunctionObject Foam::regionFunctionObject
Foam::functionObject Foam::functionObject

2
src/OpenFOAM/db/functionObjects/writeFiles/writeFiles.H
View File

@ -27,7 +27,7 @@ Class
Description Description
functionObject base class for writing files functionObject base class for writing files
See Also See also
Foam::functionObject Foam::functionObject
Foam::OutputFilterFunctionObject Foam::OutputFilterFunctionObject

2
src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H
View File

@ -71,7 +71,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
codedFixedValueFvPatchField codedFixedValueFvPatchField
SourceFiles SourceFiles

2
src/OpenFOAM/fields/pointPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValuePointPatchField.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A time-varying form of a uniform fixed value boundary condition. A time-varying form of a uniform fixed value boundary condition.
See Also See also
Foam::timeVaryingUniformFixedValueFvField Foam::timeVaryingUniformFixedValueFvField
SourceFiles SourceFiles

4
src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ Class
Description Description
Geometric agglomerated algebraic multigrid preconditioner. Geometric agglomerated algebraic multigrid preconditioner.
See Also See also
GAMGSolver for more details. GAMGSolver for more details.
SourceFiles SourceFiles

4
src/OpenFOAM/memory/Xfer/Xfer.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -59,7 +59,7 @@ Description
labelList plainLst(dynLst.xfer()); labelList plainLst(dynLst.xfer());
\endcode \endcode
SeeAlso See also
xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp xferCopy, xferCopyTo, xferMove, xferMoveTo, xferTmp
SourceFiles SourceFiles

2
src/OpenFOAM/memory/refCount/refCount.H
View File

@ -27,7 +27,7 @@ Class
Description Description
Reference counter for various OpenFOAM components. Reference counter for various OpenFOAM components.
SeeAlso See also
Foam::tmp Foam::tmp
Foam::token::compound Foam::token::compound

2
src/OpenFOAM/memory/tmp/tmp.H
View File

@ -30,7 +30,7 @@ Description
SourceFiles SourceFiles
tmpI.H tmpI.H
SeeAlso See also
Foam::refCount Foam::refCount
Foam::autoPtr Foam::autoPtr

2
src/OpenFOAM/memory/tmpNrc/tmpNrc.H
View File

@ -30,7 +30,7 @@ Description
SourceFiles SourceFiles
tmpNrcI.H tmpNrcI.H
SeeAlso See also
Foam::autoPtr Foam::autoPtr
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/degenerateMatcher.H
View File

@ -28,7 +28,7 @@ Description
Collection of all hex degenerate matchers (hex, wedge, prism etc.) Collection of all hex degenerate matchers (hex, wedge, prism etc.)
Has static member function to match a shape. Has static member function to match a shape.
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/hexMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for hex cells A cellMatcher for hex cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/prismMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for prism cells A cellMatcher for prism cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/pyrMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for pyr cells A cellMatcher for pyr cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/tetMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for tet cells A cellMatcher for tet cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/tetWedgeMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for tetWedge cells A cellMatcher for tetWedge cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/cellMatcher/wedgeMatcher.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A cellMatcher for wedge cells A cellMatcher for wedge cells
See Also See also
cellMatcher cellMatcher
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/face/face.H
View File

@ -27,7 +27,7 @@ Class
Description Description
A face is a list of labels corresponding to mesh vertices. A face is a list of labels corresponding to mesh vertices.
SeeAlso See also
Foam::triFace Foam::triFace
SourceFiles SourceFiles

2
src/OpenFOAM/meshes/meshShapes/triFace/triFace.H
View File

@ -28,7 +28,7 @@ Description
A triangular face using a FixedList of labels corresponding to mesh A triangular face using a FixedList of labels corresponding to mesh
vertices. vertices.
SeeAlso See also
Foam::face, Foam::triangle Foam::face, Foam::triangle
SourceFiles SourceFiles

4
src/OpenFOAM/meshes/pointMesh/pointMeshMapper/MapPointField.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,7 +28,7 @@ Description
Map point field on topology change. This is a partial template Map point field on topology change. This is a partial template
specialisation for GeoMesh=pointMesh specialisation for GeoMesh=pointMesh
See Also See also
MapGeometricFields MapGeometricFields
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
src/OpenFOAM/meshes/pointMesh/pointPatches/constraint/symmetry/symmetryPointPatch.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) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
SourceFiles SourceFiles
symmetryPointPatch.C symmetryPointPatch.C
SeeAlso See also
symmetryPlanePointPatch symmetryPlanePointPatch
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H
View File

@ -68,7 +68,7 @@ Note
of shared edges. Doing full analysis of how many patches use the edge of shared edges. Doing full analysis of how many patches use the edge
would be too complicated would be too complicated
SeeAlso See also
mapDistribute mapDistribute
globalIndexAndTransform globalIndexAndTransform

4
src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetry/symmetryPolyPatch.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) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
SourceFiles SourceFiles
symmetryPolyPatch.C symmetryPolyPatch.C
SeeAlso See also
symmetryPlanePolyPatch symmetryPlanePolyPatch
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/primitives/MatrixSpace/MatrixSpace.H
View File

@ -33,7 +33,7 @@ Description
SourceFiles SourceFiles
MatrixSpaceI.H MatrixSpaceI.H
SeeAlso See also
Foam::VectorSpace Foam::VectorSpace
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
src/OpenFOAM/primitives/Pair/Pair.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,7 +28,7 @@ Description
An ordered pair of two objects of type \<T\> with first() and second() An ordered pair of two objects of type \<T\> with first() and second()
elements. elements.
SeeAlso See also
Foam::Tuple2 for storing two objects of dissimilar types. Foam::Tuple2 for storing two objects of dissimilar types.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
src/OpenFOAM/primitives/Tensor/Tensor.H
View File

@ -33,7 +33,7 @@ Description
SourceFiles SourceFiles
TensorI.H TensorI.H
SeeAlso See also
Foam::MatrixSpace Foam::MatrixSpace
Foam::Vector Foam::Vector

4
src/OpenFOAM/primitives/Tuple2/Tuple2.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) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ Class
Description Description
A 2-tuple for storing two objects of different types. A 2-tuple for storing two objects of different types.
SeeAlso See also
Foam::Pair for storing two objects of identical types. Foam::Pair for storing two objects of identical types.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
src/OpenFOAM/primitives/chars/wchar/wchar.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
SourceFiles SourceFiles
wcharIO.C wcharIO.C
SeeAlso See also
http://en.wikipedia.org/wiki/UTF-8 http://en.wikipedia.org/wiki/UTF-8
http://en.wikibooks.org/wiki/Unicode/Character_reference http://en.wikibooks.org/wiki/Unicode/Character_reference

4
src/OpenFOAM/primitives/functions/Polynomial/polynomialFunction.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -39,7 +39,7 @@ Description
- integralMinus1() to return a new, integral coeff polynomial where - integralMinus1() to return a new, integral coeff polynomial where
the base poly starts at order -1 the base poly starts at order -1
SeeAlso See also
Foam::Polynomial for a templated implementation Foam::Polynomial for a templated implementation
SourceFiles SourceFiles

4
src/OpenFOAM/primitives/hashes/Hasher/Hasher.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
and has been reported to have better characteristics. and has been reported to have better characteristics.
It is also what postgresql seems to be using. It is also what postgresql seems to be using.
SeeAlso See also
http://burtleburtle.net/bob/c/lookup3.c http://burtleburtle.net/bob/c/lookup3.c
and HasherInt.H for a specialized version and HasherInt.H for a specialized version

4
src/OpenFOAM/primitives/hashes/Hasher/HasherInt.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ InNamespace
Description Description
Optimized hashing functions. Optimized hashing functions.
SeeAlso See also
Hasher.H Hasher.H
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
src/OpenFOAM/primitives/hashes/SHA1/SHA1.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Description
Adapted from the gnulib implementation. Adapted from the gnulib implementation.
SeeAlso See also
Foam::SHA1Digest Foam::SHA1Digest
SourceFiles SourceFiles

4
src/OpenFOAM/primitives/hashes/SHA1/SHA1Digest.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -27,7 +27,7 @@ Class
Description Description
The SHA1 message digest. The SHA1 message digest.
SeeAlso See also
Foam::SHA1 Foam::SHA1
SourceFiles SourceFiles

2
src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensor/CompactSpatialTensor.H
View File

@ -39,7 +39,7 @@ Description
SourceFiles SourceFiles
CompactSpatialTensorI.H CompactSpatialTensorI.H
SeeAlso See also
Foam::MatrixSpace Foam::MatrixSpace
Foam::SpatialTensor Foam::SpatialTensor

2
src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H
View File

@ -38,7 +38,7 @@ Description
SourceFiles SourceFiles
CompactSpatialTensorTI.H CompactSpatialTensorTI.H
SeeAlso See also
Foam::MatrixSpace Foam::MatrixSpace
Foam::CompactSpatialTensor Foam::CompactSpatialTensor

2
src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialTensor/SpatialTensor.H
View File

@ -39,7 +39,7 @@ Description
SourceFiles SourceFiles
SpatialTensorI.H SpatialTensorI.H
SeeAlso See also
Foam::MatrixSpace Foam::MatrixSpace
Foam::Tensor Foam::Tensor
Foam::SpatialVector Foam::SpatialVector

2
src/OpenFOAM/primitives/spatialVectorAlgebra/SpatialVector/SpatialVector.H
View File

@ -39,7 +39,7 @@ Description
SourceFiles SourceFiles
SpatialVectorI.H SpatialVectorI.H
SeeAlso See also
Foam::VectorSpace Foam::VectorSpace
Foam::Vector Foam::Vector

4
src/OpenFOAM/primitives/strings/string/string.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) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
Used as a base class for word and fileName. Used as a base class for word and fileName.
See Also See also
Foam::findEtcFile() for information about the site/user OpenFOAM Foam::findEtcFile() for information about the site/user OpenFOAM
configuration directory configuration directory

2
src/OpenFOAM/primitives/triad/triad.H
View File

@ -27,7 +27,7 @@ Class
Description Description
Representation of a 3D Cartesian coordinate system as a Vector of vectors. Representation of a 3D Cartesian coordinate system as a Vector of vectors.
See Also See also
Foam::quaternion Foam::quaternion
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/RAS/buoyantKEpsilon/buoyantKEpsilon.H
View File

@ -53,7 +53,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::RASModels::kEpsilon Foam::RASModels::kEpsilon
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H
View File

@ -66,7 +66,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
View File

@ -106,7 +106,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
mixedFvPatchField mixedFvPatchField
externalCoupledMixedFvPatchField externalCoupledMixedFvPatchField

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
View File

@ -85,7 +85,7 @@ Usage
- Only supply \c h and \c Ta, or \c q in the dictionary (see above) - Only supply \c h and \c Ta, or \c q in the dictionary (see above)
- \c kappa and \c kappaName are inherited from temperatureCoupledBase. - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso See also
Foam::temperatureCoupledBase Foam::temperatureCoupledBase
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
View File

@ -58,7 +58,7 @@ Usage
\endverbatim \endverbatim
SeeAlso See also
Foam::temperatureCoupledBase Foam::temperatureCoupledBase
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
View File

@ -73,7 +73,7 @@ Usage
- \c kappa and \c kappaName are inherited from temperatureCoupledBase. - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso See also
Foam::temperatureCoupledBase Foam::temperatureCoupledBase
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
View File

@ -70,7 +70,7 @@ Usage
- \c kappa and \c kappaName are inherited from temperatureCoupledBase. - \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso See also
Foam::temperatureCoupledBase Foam::temperatureCoupledBase
SourceFiles SourceFiles

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -53,7 +53,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

4
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatPhaseChangeWallFunction/alphatPhaseChangeWallFunctionFvPatchScalarField.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,7 +30,7 @@ Group
Description Description
Abstract base-class for all alphatWallFunctions supporting phase-change. Abstract base-class for all alphatWallFunctions supporting phase-change.
SeeAlso See also
Foam::fixedValueFvPatchScalarField Foam::fixedValueFvPatchScalarField
Foam::alphatWallFunctionFvPatchScalarField Foam::alphatWallFunctionFvPatchScalarField

2
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H
View File

@ -65,7 +65,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

4
src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/LienCubicKE/LienCubicKE.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -48,7 +48,7 @@ Description
wall-functions is also included to allow for low- and high-Reynolds number wall-functions is also included to allow for low- and high-Reynolds number
operation. operation.
See Also See also
Foam::incompressible::RASModels::ShihQuadraticKE Foam::incompressible::RASModels::ShihQuadraticKE
SourceFiles SourceFiles

2
src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -52,7 +52,7 @@ Usage
Note Note
The units of kinematic turbulent thermal conductivity are [m2/s] The units of kinematic turbulent thermal conductivity are [m2/s]
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/LES/Smagorinsky/Smagorinsky.H
View File

@ -61,7 +61,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::LESModels::kEqn Foam::LESModels::kEqn
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/LES/WALE/WALE.H
View File

@ -48,7 +48,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::LESModels::Smagorinsky Foam::LESModels::Smagorinsky
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/LES/kOmegaSSTDES/kOmegaSSTDES.H
View File

@ -45,7 +45,7 @@ Description
Group Group
grpLESTurbulence grpLESTurbulence
SeeAlso See also
Foam::kOmegaSST Foam::kOmegaSST
SourceFiles SourceFiles

4
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -46,7 +46,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::atmBoundaryLayer, Foam::atmBoundaryLayer,
Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField,
Foam::atmBoundaryLayerInletKFvPatchScalarField Foam::atmBoundaryLayerInletKFvPatchScalarField

4
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.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) 2014-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -46,7 +46,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::atmBoundaryLayer, Foam::atmBoundaryLayer,
Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField,
Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField

4
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.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) 2011-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -47,7 +47,7 @@ Description
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::atmBoundaryLayer, Foam::atmBoundaryLayer,
Foam::atmBoundaryLayerInletKFvPatchScalarField, Foam::atmBoundaryLayerInletKFvPatchScalarField,
Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField

2
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H
View File

@ -67,7 +67,7 @@ Usage
Note Note
In the event of reverse flow, a zero-gradient condition is applied In the event of reverse flow, a zero-gradient condition is applied
SeeAlso See also
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
View File

@ -67,7 +67,7 @@ Usage
Note Note
In the event of reverse flow, a zero-gradient condition is applied In the event of reverse flow, a zero-gradient condition is applied
SeeAlso See also
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField

2
src/TurbulenceModels/turbulenceModels/RAS/kOmegaSST/kOmegaSST.H
View File

@ -27,7 +27,7 @@ Class
Group Group
grpRASTurbulence grpRASTurbulence
SeeAlso See also
Foam::kOmegaSST Foam::kOmegaSST
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/RAS/v2f/v2f.H
View File

@ -86,7 +86,7 @@ Note
viscosity wall function should be used, e.g. nutUWallFunction. Turbulence viscosity wall function should be used, e.g. nutUWallFunction. Turbulence
k variants (nutk...) for this case will not behave correctly. k variants (nutk...) for this case will not behave correctly.
SeeAlso See also
Foam::RASModels::v2fBase Foam::RASModels::v2fBase
Foam::RASModels::kEpsilon Foam::RASModels::kEpsilon
Foam::kLowReWallFunctionFvPatchScalarField Foam::kLowReWallFunctionFvPatchScalarField

4
src/TurbulenceModels/turbulenceModels/RAS/v2f/v2fBase.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) 2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -31,7 +31,7 @@ Description
Abstract base-class for v2-f models to provide BCs access to the v2 and f Abstract base-class for v2-f models to provide BCs access to the v2 and f
fields. fields.
SeeAlso See also
Foam::RASModels::v2f Foam::RASModels::v2f
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H
View File

@ -55,7 +55,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::epsilonWallFunctionFvPatchScalarField Foam::epsilonWallFunctionFvPatchScalarField
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H
View File

@ -60,7 +60,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedInternalValueFvPatchField Foam::fixedInternalValueFvPatchField
SourceFiles SourceFiles

2
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H
View File

@ -51,7 +51,7 @@ Usage
} }
\endverbatim \endverbatim
SeeAlso See also
Foam::fixedValueFvPatchField Foam::fixedValueFvPatchField
SourceFiles SourceFiles

Some files were not shown because too many files have changed in this diff Show More