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 documentation: Standardized the 'See also' heading

Browse Source
This commit is contained in:
Henry Weller
2016-06-17 17:31:34 +01:00
parent b3f3562d3c
commit 6a53ed41ba
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
\\ / 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.
SeeAlso
See also
Foam::compressible::
alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField

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

@ -55,7 +55,7 @@ Usage
}
\endverbatim
SeeAlso
See also
Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField
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
\\ / 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
SeeAlso
See also
Foam::fixedValueFvPatchField
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
\\ / 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.
SeeAlso
See also
Foam::fixedValueFvPatchField
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
\\ / 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.
SeeAlso
See also
Foam::fixedValueFvPatchField
SourceFiles

4
applications/test/FixedList/Test-FixedList.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of FixedList
See Also
See also
Foam::FixedList
\*---------------------------------------------------------------------------*/

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

@ -27,7 +27,7 @@ Application
Description
Simple tests and examples of use of List
See Also
See also
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
creating the cellTable information.
See Also
See also
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
\\ / 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
SeeAlso
See also
Foam::helpType
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
\\ / 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
SeeAlso
See also
Foam::helpType
Foam::functionObject

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

@ -53,7 +53,7 @@ Usage
objectNames | objects to write | yes |
\endtable
SeeAlso
See also
Foam::functionObjects::fvMeshFunctionObject
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 pressure spectrum
SeeAlso
See also
CSV.H
noiseFFT.H

4
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2016 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.
SeeAlso
See also
externalCoupledMixedFvPatchField
\*---------------------------------------------------------------------------*/