Skip to content

GitLab

Commit b3f3562d authored by Henry Weller's avatar Henry Weller
Browse files

Doxygen documentation: Use the standard 'Usage' rather than the '\heading....'

parent a7ecd24a
Hide whitespace changes
Inline Side-by-side
Showing with 107 additions and 111 deletions
applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H
View file @ b3f3562d
......@@ -44,7 +44,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -33,7 +33,7 @@ Description
thermal diffusivity (usually\c alphat) based on the Jayatilleke model for
the Eulerian multiphase solvers.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H
View file @ b3f3562d
......@@ -46,7 +46,7 @@ Description
}
\endverbatim
\heading Function object usage
Usage
\table
Property | Description | Required | Default value
type | type name: writeVTK | yes |
......
applications/utilities/postProcessing/noise/noise.C
View file @ b3f3562d
......@@ -32,8 +32,7 @@ Description
or user-specified dictionary using the -dict option. Pressure data is
read using a CSV reader:
\heading Usage
Usage
\verbatim
pRef 101325;
N 65536;
......
bin/tools/doxyFilter.sed
View file @ b3f3562d
......@@ -164,6 +164,7 @@ 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
......@@ -171,12 +172,8 @@ s/<\/li>\n/<\/li> /
s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
}
s/.*\*\//\*\//
# Convert /heading in source files to bold font and add some space
s#\\heading \(.*\)#<br><b>\1</b>#g
s/.*\*\//\*\//
}
#------------------------------------------------------------------------------
etc/codeTemplates/BC/BC.H
View file @ b3f3562d
......@@ -43,7 +43,7 @@ Description
Q_{t} | TYPE function of time [units]
\endtable
\heading Patch usage
Usage
\table
Property | Description | Req'd? | Default
......
etc/codeTemplates/functionObject/FUNCTIONOBJECT.H
View file @ b3f3562d
......@@ -42,7 +42,7 @@ Description
}
\endverbatim
\heading Function object usage
Usage
\table
Property | Description | Required | Default value
type | type name: FUNCTIONOBJECT | yes |
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -50,7 +50,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
View file @ b3f3562d
......@@ -83,7 +83,7 @@ Description
read the return values, and pass program execution back to OpenFOAM.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
View file @ b3f3562d
......@@ -48,7 +48,7 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo
thermophysical package.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
View file @ b3f3562d
......@@ -37,15 +37,15 @@ Description
transformed kappa vector. Field name definable in 'alphaAni',
named 'Anialpha' in solid solver by default
\heading Keywords provided by this class
\table
\par Keywords provided by this class:
\table
Property | Description | Required | Default value
kappaMethod | Thermal conductivity method | yes |
kappa | Name of thermal conductivity field | no | none
alphaAni | Name of the non-isotropic alpha | no | Anialpha
\endtable
\endtable
Usage examples:
Usage
\verbatim
nonIsotropicWall
{
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H
View file @ b3f3562d
......@@ -36,7 +36,7 @@ Description
Baffle and solid properties need to be specified on the master side
of the baffle.
\heading Patch usage
Usage
Example of the boundary condition specification using constant
solid thermo :
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
View file @ b3f3562d
......@@ -29,7 +29,7 @@ Description
heat source either specified in terms of an absolute power [W], or as a
flux [W/m^2].
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
View file @ b3f3562d
......@@ -42,7 +42,7 @@ Description
where KDelta is heat-transfer coefficient K * deltaCoeffs
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
View file @ b3f3562d
......@@ -35,7 +35,7 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo
or \c fluidThermo thermophysical package.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -31,7 +31,7 @@ Description
This boundary condition provides a thermal wall function for turbulent
thermal diffusivity (usually\c alphat) based on the Jayatilleke model.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -46,7 +46,7 @@ Description
Pr_t | turblent Prandtl number
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -31,7 +31,7 @@ Description
This boundary condition provides an enthalpy condition for wall heat
transfer
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -31,7 +31,7 @@ Description
This boundary condition provides a kinematic turbulent thermal conductivity
for using wall functions, using the Jayatilleke 'P' function.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
View file @ b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -74,7 +74,7 @@ Description
layer", Journal of Wind Engineering and Industrial Aerodynamics
95(2007), pp 355-369.
\heading Patch usage
Usage
\table
Property | Description | Required | Default
......
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -45,7 +45,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
View file @ b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -45,7 +45,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H
View file @ b3f3562d
......@@ -49,7 +49,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -38,7 +38,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -43,7 +43,7 @@ Description
G | turblence generation field
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -34,7 +34,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -34,7 +34,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H
View file @ b3f3562d
......@@ -34,7 +34,7 @@ Description
It is a simple wrapper around the zero-gradient condition.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -32,7 +32,7 @@ Description
for use with low Reynolds number models. It sets \c nut to zero, and
provides an access function to calculate y+.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions for rough walls, based on velocity.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -45,7 +45,7 @@ Description
\endvartable
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -33,7 +33,7 @@ Description
of U+ as a function of near-wall Reynolds number. The table should be
located in the $FOAM_CASE/constant directory.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions, based on velocity.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -32,7 +32,7 @@ Description
when using wall functions, based on turbulence kinetic energy.
- replicates OpenFOAM v1.5 (and earlier) behaviour
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
......
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H
View file @ b3f3562d
......@@ -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
......@@ -46,7 +46,7 @@ Description
z | vertical co-ordinate
\endvartable
\heading Patch usage
Usage