Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Development
openfoam
Commits
6a53ed41
Commit
6a53ed41
authored
Jun 17, 2016
by
Henry Weller
Browse files
Doxygen documentation: Standardized the 'See also' heading
parent
b3f3562d
Changes
288
Hide whitespace changes
Inline
Side-by-side
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatFixedDmdtWallBoilingWallFunction/alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -32,7 +32,7 @@ Description
A simple alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField with
a fixed volumetric phase-change mass flux.
See
A
lso
See
a
lso
Foam::compressible::
alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField
...
...
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H
View file @
6a53ed41
...
...
@@ -55,7 +55,7 @@ Usage
}
\endverbatim
See
A
lso
See
a
lso
Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField
SourceFiles
...
...
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -51,7 +51,7 @@ Description
Daejeon, Korea, September 10-12 2012
\endverbatim
See
A
lso
See
a
lso
Foam::fixedValueFvPatchField
SourceFiles
...
...
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/copiedFixedValue/copiedFixedValueFvPatchScalarField.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -30,7 +30,7 @@ Group
Description
Copies the boundary values from a user specified field.
See
A
lso
See
a
lso
Foam::fixedValueFvPatchField
SourceFiles
...
...
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -36,7 +36,7 @@ Description
- Set 'fixedMultiPhaseHeatFlux' boundary for one of the phases
- Use 'copiedFixedValue' for all the other phases.
See
A
lso
See
a
lso
Foam::fixedValueFvPatchField
SourceFiles
...
...
applications/test/FixedList/Test-FixedList.C
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
6
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of FixedList
See
A
lso
See
a
lso
Foam::FixedList
\*---------------------------------------------------------------------------*/
...
...
applications/test/List/Test-List.C
View file @
6a53ed41
...
...
@@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of List
See
A
lso
See
a
lso
Foam::List
\*---------------------------------------------------------------------------*/
...
...
applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
View file @
6a53ed41
...
...
@@ -44,7 +44,7 @@ Note
will be used if available. Otherwise the cellZones are used when
creating the cellTable information.
See
A
lso
See
a
lso
Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD
\*---------------------------------------------------------------------------*/
...
...
applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -40,7 +40,7 @@ Description
Note
To use the \c -fixedValue option, the \c -field option should also be used
See
A
lso
See
a
lso
Foam::helpType
Foam::fvPatchField
...
...
applications/utilities/miscellaneous/foamHelp/helpTypes/helpFunctionObject/helpFunctionObject.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -33,7 +33,7 @@ Description
\c -browse \<patch type\> | open documentation for object in browser
\endplaintable
See
A
lso
See
a
lso
Foam::helpType
Foam::functionObject
...
...
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H
View file @
6a53ed41
...
...
@@ -53,7 +53,7 @@ Usage
objectNames | objects to write | yes |
\endtable
See
A
lso
See
a
lso
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::timeControl
...
...
applications/utilities/postProcessing/noise/noise.C
View file @
6a53ed41
...
...
@@ -71,7 +71,7 @@ Usage
- one-third-octave-band PFL spectrum
- one-third-octave-band pressure spectrum
See
A
lso
See
a
lso
CSV.H
noiseFFT.H
...
...
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-201
4
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-201
6
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -41,7 +41,7 @@ Note:
The addressing is patch-local, i.e. point indices for each patch point
used for face addressing starts at index 0.
See
A
lso
See
a
lso
externalCoupledMixedFvPatchField
\*---------------------------------------------------------------------------*/
...
...
bin/foamExec
View file @
6a53ed41
...
...
@@ -43,7 +43,7 @@
#
# foamEtcFile must be found in the same directory as this script
#
# See
A
lso
# See
a
lso
# foamEtcFile
#
#------------------------------------------------------------------------------
...
...
bin/tools/doxyFilter.sed
View file @
6a53ed41
...
...
@@ -123,8 +123,8 @@ s/^ //
}
/
^
See
*
A
lso
*$
/,/
^
[^
]
/
{
/
^
See
*
A
lso
/
c
\
/
^
See
*
[
Aa
]
lso
*$
/,/
^
[^
]
/
{
/
^
See
*
[
Aa
]
lso
/
c
\
\\see
s
/
^
//
}
...
...
etc/config.csh/example/prefs.csh
View file @
6a53ed41
...
...
@@ -30,7 +30,7 @@
# The prefs.csh file will be sourced by the OpenFOAM etc/cshrc when it is
# found by foamEtcFile.
#
# See
A
lso
# See
a
lso
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched
#
...
...
etc/config.sh/example/prefs.sh
View file @
6a53ed41
...
...
@@ -30,7 +30,7 @@
# The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is
# found by foamEtcFile.
#
# See
A
lso
# See
a
lso
# 'foamEtcFile -help' or 'foamEtcFile -list' for information about the
# paths searched
#
...
...
src/ODE/ODESolvers/RKDP45/RKDP45.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-201
5
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-201
6
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -43,7 +43,7 @@ Description
Springer-Verlag, Berlin. 1993, ISBN 3-540-56670-8.
\endverbatim
See
A
lso
See
a
lso
Foam::RKF45
Foam::RKCK45
...
...
src/OSspecific/POSIX/cpuTime/cpuTime.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011
-2016
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -27,7 +27,7 @@ Class
Description
Starts timing CPU usage and return elapsed time from start.
See
A
lso
See
a
lso
clockTime
SourceFiles
...
...
src/OSspecific/POSIX/regExp.H
View file @
6a53ed41
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
6
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -30,7 +30,7 @@ Description
The PCRE '(?i)' extension is provided to compile the regular expression
as being case-insensitive.
See
A
lso
See
a
lso
The manpage regex(7) for more information about POSIX regular expressions.
These differ somewhat from \c Perl and \c sed regular expressions.
...
...
Prev
1
2
3
4
5
…
15
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment