diff --git a/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H b/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H index 1bff692cfc9052ab3a689cdde93488e8979a2d42..5779d86b922cd232e3fd20706673b01345853c6d 100644 --- a/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H +++ b/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H @@ -44,7 +44,7 @@ Description \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H index 76bc4e451d44d9c64ade4d3f3597f453ff7cb3a0..f7186fcf053b9410f8f73175c10a65aa25701009 100755 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H @@ -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 diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H index 231ebde4e4d8a3b3f1dd9959bd3318ad84d1e8de..02af8d8349f57436caa20264bc4576b4e0509968 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H @@ -46,7 +46,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: writeVTK | yes | diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C index 323bfbf2b05b38ac948cad7caff486038f464783..5e112f0550a24ba2c2dc666f4da1eedf40cdbbec 100644 --- a/applications/utilities/postProcessing/noise/noise.C +++ b/applications/utilities/postProcessing/noise/noise.C @@ -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; diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index b7b28a862159acce58921f4bb530fecdd1937d3d..83142de17d9be3b473a7444e9ea26ae4b07dc4c5 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -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/.*\*\//\*\// -} #------------------------------------------------------------------------------ diff --git a/etc/codeTemplates/BC/BC.H b/etc/codeTemplates/BC/BC.H index 65a47570369628b0fcc538d0677645be68531d40..1727dc016fba41698c9246f2233fc85063518358 100644 --- a/etc/codeTemplates/BC/BC.H +++ b/etc/codeTemplates/BC/BC.H @@ -43,7 +43,7 @@ Description Q_{t} | TYPE function of time [units] \endtable - \heading Patch usage +Usage \table Property | Description | Req'd? | Default diff --git a/etc/codeTemplates/functionObject/FUNCTIONOBJECT.H b/etc/codeTemplates/functionObject/FUNCTIONOBJECT.H index abaf9336494973b56f12df843f236f1bfc09bf2a..2a2dfd07ccc6b6c449f99a7f8dd33d0c6db2358a 100644 --- a/etc/codeTemplates/functionObject/FUNCTIONOBJECT.H +++ b/etc/codeTemplates/functionObject/FUNCTIONOBJECT.H @@ -42,7 +42,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: FUNCTIONOBJECT | yes | diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index 818b803a60f26dce0bcc2915c8d4c727cf2e5498..f98ee20874e27c91cb940cbfb894116f01741f76 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H index 461d5071e8d856f5237b1755bf25f4ae103ca615..7363c4cd2e3f4332dfe3b8f706ae4f1abfb9fdbb 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 2f9b112d2eb13536b554970199e24a351e217639..ded11e59778b1a3968c01f9a8a44e5ba512d314a 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H index 756a98dbb1dc14e95c761f22a11fa3ec1e87aae4..777f4c6d2ab549bebecf957a862cc59edfb7581c 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H @@ -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 { diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H index 4ee5df4bf221f1ef4fa25522bd7cb1fae29fb68b..ac3464e1b99693095755f263c79d41abbe969172 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H @@ -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 : diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 7e4c2652709bd73cb9399dda69fef3678bd51433..0978cc585194836276dd6088d809051cd6100342 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H index a786c74babc0c2462ccbb3040495fb2ca869f2ec..86d954eec8ceb709371e4768a1f13618cf018b4d 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H @@ -42,7 +42,7 @@ Description where KDelta is heat-transfer coefficient K * deltaCoeffs - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H index 64290d47419930cb5713d56fb25daeec999a54c1..2f3aad04eaf25dc41133929683d008dd3b3cfe0d 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 2626bafc37d9acafd5c46565433cca22e1cef6c1..4771a556e406b1c9f77e293187a2b8d07a83f26e 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index 308128ecce8a13f67e86cf8eedc2132824c73200..037ada349ca65ed5128dfcec9c6a39dd64a2fbec 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H index 1524f6c0b4e0900bf0e29e8ec000fa4da5f6606d..d6a9d443e353b46afc88a957bf1858608cee2341 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index b4a9005ff044f6eed3a3fa928b18e6ea633eee77..02ec46acb2658fab35f3837ffbf24acb219ea05f 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H index f551ecc7e4e183a922930dc3440829ac8991bf71..1ce35ddf4295de8b78c21219a8c3cbf3fe7c3205 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 5fdf8160c2ea2f7bff8c012aeeb3cc52ad764d8b..342b61460a672c8a0f5b4a85d913f277437d51b8 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 9276bc93ece44e4895289753d72d1b1c48e17c03..08d4730e98b52cf3003c54870d24e1daf958f179 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index 6ec6e0ca694cc7c01ff30e2529b8a4c541ae8cc7..b14f4a41051ada1474310df109106fe240288fb9 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -49,7 +49,7 @@ Description \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H index fca9d12fe8178ec31858622918e7699618ab02af..795575006ba3a85738f18662c643d808d0326f6e 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index 944af6f82f83284cdc3d485f00ffcc3923bd4f3a..74aa761fcb670a7dbccea67ba894909adf4b3f1e 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -43,7 +43,7 @@ Description G | turblence generation field \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H index 11aefb5624660b21525fe261d95d0e48584728f0..8fd4c9fe90c51371e2b4925f64f6b2f578dc2332 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H index 9f78b496cb4ecd814e2558f55017ffe9ca359ce2..bb34c3fd9816c42e378aaf5ea752267d1ade97d4 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 7920e431f6ff6d1b91a3c2d2b009b6946636dec1..ad72e76887c93f2f2b0a22a1e79a02e6ef872fbc 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index 1ecd16481d50c3e66592af78a10732d9eb23c3e0..910e85330c1457c57eeddc3b5312582414978a48 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 33166ed72b5cde7df6d67554fe4f6244a9cfba38..3c57a7111033f83fa0949698f2849ee3446c450b 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index 1d36cc259a32fed2bbd20983d40f2f561f16a874..d4f94a10ea793d1533ac8245c045f2bc011ff521 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 2c6aad790f9788252780662455f15147803b62d0..160ca78f4ac005dfdcb87efc0a77de700839509c 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index 5dcd360b39196b1f2df06784e1f45828d711307e..4998b92cc17adc7028b532f9ec550daa00a64885 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index 0d54c60ecb22758f55905544dae8e3f617967aad..10f34431677fd3d7dc52c6b41631129071ded5be 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -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 diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index 01cbd268842fba779cffff9bfea569d37988c893..efad1f6e90c2afdf790a439bdf0e9846d1625845 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -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 \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 52c968c58a5c7ae78f04784b4946afc8bdacc217..6cb998924938e0de152748c109299a09fff1cc74 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -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 @@ -37,7 +37,7 @@ Description - roughness height = sand-grain roughness (0 for smooth walls) - roughness constant = 0.5-1.0 - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 059de92b524da19ebbf426907eb546ea0f3a2f93..8b056e9fd82aea6f9c963b8dc49392dcf55eb469 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -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 Example of the boundary condition specification: \verbatim diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index 3efc6d1cc6b3a89fae307edd7b73d984be305a76..51ec6bb5372eed557b331fef9261d30da3e69824 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -50,7 +50,7 @@ Description Nov. 2001 \endverbatim - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H index d8c7782f4df4c1816c0902fc178622caa103be98..11cac43c750ff9ead2330dd37aa26a93250ba333 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H @@ -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 @@ -36,7 +36,7 @@ Description switch-over y+ value derived from kappa and E. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index 75bef5835d496a0dbe5f1133f240595bb666b385..e77bf9c74ad2cae55f29e8b6cb36b0481475b8e0 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -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 @@ -46,7 +46,7 @@ Description \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 33b0314cef286ee0202e6a1cb99f17a44e5cf558..86e3b38303d7874970f74ee189aab33950fb481c 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -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 @@ -58,7 +58,7 @@ Description \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H index 060898c65e844693c5e340163c35ca3fa4632b88..ed101b672f4caa22a8118383935233eedee3cac0 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H @@ -47,7 +47,7 @@ Description The normal component of \f$ U_p \f$ is removed to ensure 0 wall-flux even if the wall patch faces are irregular. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index 54dc55633ee83eb76db64a7bd5bc28191ff8bc09..ad7b3682238e3d5d3eb38338d824d845328d8868 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -32,7 +32,7 @@ Description that the value is assigned via field assignment, and not via a call to e.g. \c updateCoeffs or \c evaluate. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H index 2a8674128dff9a5e6fa778854275d1b2757168dc..5ba454dd27d79c95b690e2336eab8698801d42f1 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H @@ -33,7 +33,7 @@ Description assigned. \c snGrad returns the patch gradient evaluated from the current internal and patch field values rather than returning zero. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index e829dfc72cc2ad8cc78b69c4449e57206a149e92..30572201883670133984e17f4df22e0e634f23df 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -43,7 +43,7 @@ Description \Delta | inverse distance from patch face centre to cell centre \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index fdf3ea51ea9b2dcf6f9f48ab6519f0814608399a..c210f17e084c7232fd669650327d4777e1ed484a 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition supplies a fixed value constraint, and is the base class for a number of other boundary conditions. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 1421baefb42d1474ba088cffc2c9df6ff86351fe..b8d9ebc5abace26575c4bd2b6755061b8f76b776 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -48,7 +48,7 @@ Description \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 2b0f7a31f7ed42c36a388d36714bf4893fd9f5c7..049e1f86fc1e8284718a8a0d50aaace31a1e1ddb 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 68f883f320c93c64a37aaeeba6a3409a9cdc4f66..06975886b85ae55b1b4abb76bace0e1d1b9024dc 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition enforces a cyclic condition between a pair of boundaries. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H index a4f99ad1bd115bfbd0587b6cae74af36ad9dfb51..18c802ee25ffca782300716e8ec7b3ea1c9d444b 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H @@ -32,7 +32,7 @@ Description boundaries, whereby communication between the patches is performed using an arbitrarily coupled mesh interface (ACMI) interpolation. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index 76a2a02031ff924f8b33cb335d8c8fb21396b537..ba7fd1e3101056023285e90158e7da06209609b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -32,7 +32,7 @@ Description boundaries, whereby communication between the patches is performed using an arbitrary mesh interface (AMI) interpolation. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 4d3cb95e353e83552c69c65bbcfd7e2ed6143611..a1a4b8ae76b150e42f0b9e89cb22aea586136fc0 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is a light wrapper around the cyclicFvPatchField condition, providing no new functionality. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index 06d0273bfa8cb282f7edd029a9e17c9ae9ead060..017acb422c1d1fabc61df7248e50edea62e26d3c 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -33,7 +33,7 @@ Description patches whose normal is aligned to geometric directions that do not constitue solution directions. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index 3928028ced798cf82d155f95c87222f73264748f..ddb4c5deeac7af856701b9ade5bcb1fbaccdd9d5 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enables processor communication across patches. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index 9bf1d7b707e5b0dd2674f09ec20b55cb61e8fce3..4ea304fa3e3b624e4d56c75d075afc6c576ccaeb 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition enables processor communication across cyclic patches. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index 8834805377ca917d1cbb0914cc5cd48f46dac779..8e988347d96cdd381145e988a21dcaf18d365c31 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enforces a symmetry constraint - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H index 7f00417dd3098a260195ff3bcd100e99a19fce63..1dfb805c6e628c45c7f2bec77a07c51a6968d606 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition enforces a symmetryPlane constraint - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index f88636e414784dad0a0b004469f9e03b5e6c091d..d304b53df50e7c1d4fec0b8c2fdaa6cead304da9 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometries. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index 1c3dfa4dd440849b5cfdc4258dde7dedafd74aad..505032cd1cba0b326d57e36f7eed984770c57515 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,7 +54,7 @@ Description The open fraction is then applied to scale the patch areas. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 289e735586372848ffc409292faedb0d0d52e439..25396f644b1a51e5538fd8ac4eca11143236691f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -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 @@ -57,7 +57,7 @@ Description The open fraction is then applied to scale the patch areas. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 123fc8e13cda963fe75a97e08132f03086cb0668..10dfd789883dd31fdfaae7d09b31708877bf1713 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -48,7 +48,7 @@ Description the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index c3c95eca4c781997c7eb0ba79b9b6dc16d0470b2..fc87f082e997e68d22b1f578bf8d15df7fa3dafc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from fixedValueFvPatchField) which is then used to evaluate. - \heading Patch usage +Usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 19f5a589a51279881d31de1a93c3c3efd9d5b6d1..779a85906d4ad96eb4d7339770d238c17f35aa0f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -31,7 +31,7 @@ Description Constructs on-the-fly a new boundary condition (derived from mixedFvPatchField) which is then used to evaluate. - \heading Patch usage +Usage Example: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index f390c15b95dd55100c76e27074d2a759176e65a2..3b0f153e88eb5fc19f36229d1cad89a6de412f3c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description cylindrical co-ordinates given a central axis, central point, rpm, axial and radial velocity. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H index dbb594f784ce5af321a5ca08cc0265961253182a..271b659b0e3800dfc627f8abb794c661d9c2e8b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H @@ -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 diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index b1080e264f75f287bca778e4bdc301ae92d180f2..0e22cc086aca775a7efc0e742b83c6a9818b47dd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -34,7 +34,7 @@ Description The jump is specified as a \c Function1 type, to enable the use of, e.g. contant, polynomial, table values. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index 022fb48ccb74e2ef3480e486414991afd69c04b8..79dc72841d23a66b7cb144aa8d1285a6388e6bf6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,7 +31,7 @@ Description This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 53a8d50fa716e90be307f14b3983021588a732a3..d717ccdf66fb2171062f56e6d493e70b850ea549 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -32,7 +32,7 @@ Description directly into a matrix, i.e. to set a constraint condition. Default behaviour is to act as a zero gradient condition. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 002d60045ae239cc767d1259ea6e817bb25431cb..ec739d6bcfa2b454f87f49a48a31073607359a99 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -34,7 +34,7 @@ Description The jump is specified as a fixed value field, applied as an offset to the 'owner' patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H index 83f7d4c07047ce2662804c9a1b7038154f389dfa..3b34f3ae979413005198e1e82bb51558cd097681 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H @@ -34,7 +34,7 @@ Description The jump is specified as a fixed value field, applied as an offset to the 'owner' patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index 55c1312c8d4df766a5addebec9179950e0af80f6..04eb221243f8f8305f93d2b1c2b71191b5d03bb3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -32,7 +32,7 @@ Description values and adjusts the distribution to match the specified, optionally time-varying, mean value. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H index 41a8f41bc72db84069b50e1fd23599fda859c26c..6ce56ecfe10abd5c73b0bf55aa7906f612159cec 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H @@ -41,7 +41,7 @@ Description - fixTangentialInflow is false apply zero-gradient condition to tangential components. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 2119f70268114732a92ebe71f254f4edb8591557..6c0fe30efe8f0a5740894665fc7a913e23cbee29 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition sets the patch-normal component to a fixed value. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 47aab74d5c24dce9462d829119bdf4a9acc6efbb..b818b7f4a4141da719b790eef8e8d3e047b7ddd6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,7 +48,7 @@ Description The variables \c rholSat, \c pSat and \c psil are retrieved from the \c thermodynamicProperties dictionary. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H index d0bb6d640f14eee3992a8920d2d575dc48a48cfc..18ff2a8b6f655d28172710dd26f450bd5f5afa4c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a fixed value profile condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 4f4fbca9783d7a57984e9755396bf389b9c7156a..4d6ce71ef6d6a54de33d65af20036e472ed0d668 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -42,7 +42,7 @@ Description For a volumetric-based flux: - the flow rate is in m3/s - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 4c260a6adc57b59b1e1666bbc05d5dfec69555a0..518d694d2628a5493c3f36120c735c4a48cbc6cf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -33,7 +33,7 @@ Description operation switches between fixed (free stream) value and zero gradient based on the sign of the flux. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 49687b0ec9198f9f2f2b84b5a9b21ce7ec917ae8..653e985c396ad4e24a7c0a90f103a16772b5ccef 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -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 It is a zero-gradient condition that constrains the flux across the patch based on the free-stream velocity. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index d70a836616859abd471284880ffcf158ce51e843..a7b869c437f31df2ef738d82afb8ff66a5e69ff8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 05d8b6a4d3e800e4ba588260bdd50c57ef79bdd5..0c286dce91b570612aa9453bd38a657fee680ca3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -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 temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 2bbece6baa1b454a6cba1610e2a16673e9e9fb98..d1ef48490122b033ad4c706e7a36ee62bed1380b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -32,7 +32,7 @@ Description condition. It does not use information on the patch; instead it holds thr data locally. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index f0af7f306c4e9253dd114a7ec3a611c39e76e348..88bb0bd6d29a73adcbb87ba501d130e4146773a5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 2740010164451f2c77b59a345741c78f429a3df4..c2c205ba2aad6299faaac43dd1ef82e973231d14 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition maps the boundary values of a neighbour patch field to the boundary and internal cell values of *this. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 38857d4e984e446b8b62bbc5ef124fe5b0efb950..aec2fa02cc6c46a6384b01994c15ddbbad8e80f5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -34,7 +34,7 @@ Description The sample mode is set by the underlying mapping engine, provided by the mappedPatchBase class. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index cb06375c1045e8f838d20741d7a47459b668b881..a45d98218a07909a39d184fbcd45646ae3f98485 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -37,7 +37,7 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index 409154eaffd5d0b68a1858c27cc63f7dbcd9a04d..0be0ae4b81762cec2386896fb3fd3e70256477d4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,7 +31,7 @@ Description This boundary condition maps the velocity and flux from a neighbour patch to this patch - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 2885a7d586d12cab6b085cdcb685ca99f007a3a7..8d74b0004b4f31cce83d8f8327e3baa887528149 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description moving walls. In addition, it should also be applied to 'moving' walls for moving reference frame (MRF) calculations. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H index a2925e992f183584bfc6c80a7dfc6ee3572528f0..71e243a16fc2c27983167a99bd1d19c0bce8c621 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H @@ -30,7 +30,7 @@ Group Description This boundary condition fixes the velocity to zero at walls. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 62625a7aac6f72b138b7b29b73b473c2dff3cf94..ab8929e04ed402f964d38b8f352cfa09a412b16a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a generic inflow condition, with specified outflow for the case of reverse flow. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 7433f9c1ee3411e1fbfdc011693c3c1e6873ec2a..91cac5eb6a869c7cd972f3408d9a035b9d7ab60d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -32,7 +32,7 @@ Description by name "outletPatchName" and applies this as the uniform value of the field over this patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H index 5e5dec0213edac5b81013eb9209c76047a87ff24..ce5d31662cb6e540be28abd485b1674a8d7013fd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -35,7 +35,7 @@ Description Typical usage is as the outlet condition for a towing-tank ship simulation to maintain the outlet water level at the level as the inlet. - \heading Patch usage +Usage \table Property | Description | Required | Default value Umean | mean velocity normal to the boundary [m/s] | yes | diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index 4824ea6613d28ba298ecb276383939118dc8ac37..8840d624177b0b3aac65b2a8722ce41818b7b323 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a partial slip condition. The amount of slip is controlled by a user-supplied field. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 6cf1407c73bf4143959dd678144d341436b6bda4..ea19e81d7b554482b307113f0a94274f08a829b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -48,7 +48,7 @@ Description - 1: apply \$fp_{hyd}\$f - 0: apply a zero-gradient condition - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H index c2d5b4f4a7e6f4a27bb90f263a44c22cc2a17c68..200c130f17825bad1505c8b3cfb38e1cc2f3d775 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H @@ -63,7 +63,7 @@ Description Chapter 4, Section 4.3.1.2, 77-80. \endverbatim - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index 83fde6d2c665900a7e05408b2c8aa8c43b68e22b..9ee05bc3db99f7d2e64f02423b27ba9bcf37c903 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 697f3bce166e19eb417a0d3f30ddcd442919f621..574239441c652d04926611e10f2341c3350ff7ae 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" direction. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 52f19ab0792438d28de4c1cd99221a533930dd26..e67075ee1ae86c20ef9a93c4e83d077b84da7b5d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -35,7 +35,7 @@ Description A slip condition is applied tangential to the patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 6d44757d7093990558bfcddd78cfddafc8ca74db..997e610053caa126a4a7e20984d73c077932ea8c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -35,7 +35,7 @@ Description The tangential patch velocity can be optionally specified. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index 4a2a1fbda479ab7b6e2710d9da02b6b75a8827a8..ade86de9945340c4a3080a02ef0a3f39aee72e34 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description averaging the flux over the patch, and then applying it in the direction normal to the patch faces. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 94d3caf943266b07dd9aa5a159cd271f0ebd9e50..5d21154ce37bfd5998a84f7ebd358b42019c758d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -32,7 +32,7 @@ Description pressure is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index d5eefefb80628b61113fb95b3e2de6057fa88c29..a3c2aaf37ad7e545bcd73e7071fe606d565936af 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H index 06cbd5dcf2b983cdb097d9bdd1829070f58e3c2f..e16d1a49f01d7b12e5de0f9978b83218c9779359 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -45,7 +45,7 @@ Description g | acceleration due to gravity [m/s^2] \endtable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H index a37e645f102df79a1506a8ccdf5ce87020777c5a..3a6dee574c31f79936003661dd612aaaaf2ef6cc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H @@ -45,7 +45,7 @@ Description g | Acceleration due to gravity [m/s^2] \endtable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H index 1201332231ff900783a0767b63d35efe251ea0a9..2e38f9bca3b0a5d830063d0551292d70a277ba73 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H @@ -47,7 +47,7 @@ Description g | Acceleration due to gravity [m/s^2] \endtable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 94ee5b8c3fe90889b06ff1988c759fbcc3051387..8d3e5ae796454b3323d4d8c6dcdd284e61ee126d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -33,7 +33,7 @@ Description for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with a direction normal to the patch faces. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index eeb618ed0faa7de24ccf4fe6f1bb1b62867ce8c2..535e106ff10b222a1047defe3121fc68415fdca1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a total pressure condition for patches in a rotating frame. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 3d08d32b8958d3472a6707554accd55310b65d6b..bc0a360aa89959161cfa93e1d9c47dd2c52d4a56 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a rotational velocity condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index c22f79a096abeb158f2679cce37829f4765b4847..011ee44879f4795d5cf64918a6c3cbeddcacb5e3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a slip constraint. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index 238eef2034125d3613eb5e351eb778d0f910ad25..b10856aa4f72ac65ca746b043674c841b603df27 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -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 @@ -36,7 +36,7 @@ Description - subsonic outflow is applied via a zero-gradient condition from inside the domain. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 30a7464e2c0e02194b896b24cf6d3454ba1d0533..9593fae850d905b3e2107fb6dc3a600410e8b667 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a surface-normal vector boundary condition by its magnitude. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 6579b7a86bdb2e00b491c23bf45cb2f7d55272b9..7f8041543cd600ce5a6c3b04b1b2945ab0ea8637 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -37,7 +37,7 @@ Description dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 9182037a7e62309e82aff9ac0e48f99767b2c9f5..dc25e326e76cfcfa79061d82893ef426534d67b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -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 @@ -37,7 +37,7 @@ Description pressure and compressibility which is assumed constant, i.e. isothermal expansion/compression. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 20783c7f76afc01d7e0ca3b362b7d2879bb193ad..c61fd82730b37a42874562fea4cee17db90ce735 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -43,7 +43,7 @@ Description Values are interpolated linearly between times. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index eb7d95d99bc77b3de67cfa79386cf107516fc92d..49af6162c7fc03f1c637aa0db85ccbd98cb66c95 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -90,7 +90,7 @@ Description \endtable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index 6a032dfee9547bf4bddd9e2b46aed246c1bcc27d..b32f0ac2eecfed1231b27fba9c1a51f7ca3045fa 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Group Description This boundary condition provides a total temperature condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index 5bc1d5e057ba08eddb6807e348a1848954db7bc8..f2239da490299e6bd755fabe303487f464d3ce78 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a velocity condition for translational motion on walls. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index a38d1dfec5a15aae164f2e2408f4ce5562909487..62fabb1db4714c2f999245d23923989ddb4a26e8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -46,7 +46,7 @@ Description s | fluctuation scale \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index b6aec0caad52288932518d8c414ee83f0f5f822e..a10ce7b12301843a4aa5eb9771d2a0eeebf0d53e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -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 @@ -46,7 +46,7 @@ Description In the event of reverse flow, a zero-gradient condition is applied. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index ff3c925863c05f6b27af436a3d2f88de518e41e3..23e4363fd2e08b92d29b7d800d20ce8135597f5b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -44,7 +44,7 @@ Description g | acceleration due to gravity [m/s2] \endtable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H index 8dfd45e86bbb3ccd0a753d9d45340b5d0302a116..93885835a0874d42675ea684a7d0e669f02156d8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a uniform fixed gradient condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 3b87530609741fe4e3d5eee6a8000bbed223fc3a..cec8401ea29222076f23e4593ce901ae7771f3a1 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -30,7 +30,7 @@ Group Description This boundary condition provides a uniform fixed value condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H index c0d82ef75ddaae11d341f139674ad93e8f0f0f0c..c1749b633c25eaeed5916bab04e5ed612c237921 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H @@ -30,7 +30,7 @@ Group Description Variant of inletOutlet boundary condition with uniform inletValue. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H index 11f8a2f0b44089960545e9931c3487e8c86d6606..f126828c2db22dd9a12f98530abb63da75ea2a38 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H @@ -32,7 +32,7 @@ Description condition as a base. The jump is specified as a time-varying uniform value across the patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H index 645375887b4864edcf06875974d10a22e09d3c03..90c2301117aac5982add313236fe53e9c88a8e4f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H @@ -32,7 +32,7 @@ Description condition as a base. The jump is specified as a time-varying uniform value across the patch. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index f67be25a9383b230ab547fbbf4ae7dd8b76641ca..22920e554e94737b086143e3b4e03d18f5e8d7ec 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -31,7 +31,7 @@ Description This boundary condition provides a time-varying form of the uniform total pressure boundary condition Foam::totalPressureFvPatchField. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index f257f66197a32573574b81fbac56c63c73533e1f..000302bf7e2e7702eb0d012768777d6763cf0715 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -41,7 +41,7 @@ Description if alpha < lowerBound: - apply a fixed value condition, with a uniform level of the lower bound - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index eed99370296c2a4f15ea09a7fd633d1f3d413c47..956107dab36218833fda2ad87206f59f160446eb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -34,7 +34,7 @@ Description The flow rate is made proportional to the phase fraction alpha at each face of the patch and alpha is ensured to be bound between 0 and 1. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index e3303dd59c79d0dde90d997107c0ab144d4b0079..24a4ac9bf4b212999d94b9d8b6207b3f4b7c106d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -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 @@ -44,7 +44,7 @@ Description The wave amplitude is updated as part of the calculation, derived from the local volumetric flux. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index b3e5498b758a7bfa742e0f2cad741981564a3b44..608ee59cc34f50c0a43d5c3f3c71ea9af54970ea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -47,7 +47,7 @@ Description \gamma | ratio of specific heats \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H index 3393e6c48702f9c4025ccd3e691a3537df575839..93aee393d87bd073a1cb725d687d5f4c17ab4a3b 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H @@ -39,8 +39,7 @@ Description The first of these is not instantiated by default as the standard leastSquaresGrad is equivalent and more efficient. - \heading Usage - +Usage Example of the gradient specification: \verbatim gradSchemes diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index 2a21faa8e953b2201597623549cbeaf534cc415a..b3203855402f812030656540bff36a5742a43fec 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -93,7 +93,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: fieldAverage | yes | diff --git a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 697bf1404e5aa44ae9bcfa6bd173ccb189f61b53..a37975d6c67f5af308727be4e7de8ba7f915ee3d 100644 --- a/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -54,7 +54,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: fieldCoordinateSystemTransform | yes | diff --git a/src/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/functionObjects/field/fieldMinMax/fieldMinMax.H index 857e546b7f8b0d624b6163e43fd56d7c6ad43d8c..c7d81015536480a3e099f5464e9df83331a5cea3 100644 --- a/src/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -53,7 +53,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: fieldMinMax | yes | diff --git a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H index f40461a7222fff8dfa96f7fb258c046b1568f4a7..75ccabb1aa7286db4d4a97f5fd1486bab1f1c39d 100644 --- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H +++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H @@ -50,7 +50,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: fieldValueDelta | yes | diff --git a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H index fbe1182262aa302a9c314bbaf24dbc2b1684b5d1..25321e06a56ba6a3dfbe856d3902724b539dc2fe 100644 --- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H +++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H @@ -59,7 +59,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: surfaceRegion | yes | diff --git a/src/functionObjects/field/fieldValues/volRegion/volRegion.H b/src/functionObjects/field/fieldValues/volRegion/volRegion.H index 3e0650c4140b79d81c3245782ac9f1b7f91c2e79..e81a74cb3f94a202db4f8e253223db0c0f2c3a27 100644 --- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H +++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H @@ -55,7 +55,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | Type name: volRegion | yes | diff --git a/src/functionObjects/field/histogram/histogram.H b/src/functionObjects/field/histogram/histogram.H index 4647ef0f2c02c6da9d49a2beafcf374d83e0854b..40ea8e7b0a363711a0c7d51dbbcd8d3d362017dd 100644 --- a/src/functionObjects/field/histogram/histogram.H +++ b/src/functionObjects/field/histogram/histogram.H @@ -46,7 +46,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: histogram | yes | diff --git a/src/functionObjects/field/nearWallFields/nearWallFields.H b/src/functionObjects/field/nearWallFields/nearWallFields.H index 3e331f260bf62a0eddc5c7cacb55bfac067aa721..28b2ac74056d2274c61a3b88f03caffbe3a3693f 100644 --- a/src/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/functionObjects/field/nearWallFields/nearWallFields.H @@ -51,7 +51,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: nearWallFields | yes | diff --git a/src/functionObjects/field/pressure/pressure.H b/src/functionObjects/field/pressure/pressure.H index 96173ad5d5488803ec3ab6a53518d573a1eb4809..59008dc48c4c74086af4485c297755c78025c45d 100644 --- a/src/functionObjects/field/pressure/pressure.H +++ b/src/functionObjects/field/pressure/pressure.H @@ -88,7 +88,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: pressure | yes | diff --git a/src/functionObjects/field/processorField/processorField.H b/src/functionObjects/field/processorField/processorField.H index 61a5e374449ace02f0e194111cfa4724b82c9379..c38f0762fb78dedfc1c2aeaf2ffc1340315c168b 100644 --- a/src/functionObjects/field/processorField/processorField.H +++ b/src/functionObjects/field/processorField/processorField.H @@ -41,7 +41,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: processorField | yes | diff --git a/src/functionObjects/field/readFields/readFields.H b/src/functionObjects/field/readFields/readFields.H index d99b94ef1ac276cb62ecdb7331e453f0513374da..1722ed40cf0994a1fa0de786ad00a3eb044abbf6 100644 --- a/src/functionObjects/field/readFields/readFields.H +++ b/src/functionObjects/field/readFields/readFields.H @@ -46,7 +46,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: readFields | yes | diff --git a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 7bbf48206869572c5fb0a3556adf94749a8c7c85..ace7d1b5585018c2f7c92a671991dcb9721d025d 100644 --- a/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -79,7 +79,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: regionSizeDistribution |yes| diff --git a/src/functionObjects/field/streamLine/streamLine.H b/src/functionObjects/field/streamLine/streamLine.H index e47fcf984f7a9654e66876048edf32acd3547fd1..c75edffc292f9d317ed4a5776ddc1b643f9326f1 100644 --- a/src/functionObjects/field/streamLine/streamLine.H +++ b/src/functionObjects/field/streamLine/streamLine.H @@ -62,7 +62,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | Type name: streamLine | yes | diff --git a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H index 2e4564bd6a947b64556731ae8aef4294a43dfb67..2721b2ada1749cdefc250bb27949f58951eef6fc 100644 --- a/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H +++ b/src/functionObjects/field/surfaceInterpolate/surfaceInterpolate.H @@ -49,7 +49,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: nearWallFields | yes | diff --git a/src/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/functionObjects/field/turbulenceFields/turbulenceFields.H index 68aa9f1c625c4d75c2aeb84d1eb51cb4382c19ae..ffd988739f73f5327bdb1c84fae1488b6080426f 100644 --- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -53,7 +53,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: processorField | yes | diff --git a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 2061af85c9376bd5024eae30a203dfc59f7af78c..00e87bce2b47414b41c3956d51d192e12f25126e 100644 --- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -62,7 +62,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | Type name: wallBoundedStreamLine| yes | diff --git a/src/functionObjects/field/wallShearStress/wallShearStress.H b/src/functionObjects/field/wallShearStress/wallShearStress.H index 97e5bbec4bea46424ff9b1b26de92c720564e4e3..108eed1a671efeda6d8e81c4b37eccc5e76d9d44 100644 --- a/src/functionObjects/field/wallShearStress/wallShearStress.H +++ b/src/functionObjects/field/wallShearStress/wallShearStress.H @@ -57,7 +57,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: wallShearStress | yes | diff --git a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H index 1163c6badac2bdc849dbfc7753f7721285712208..6e4d19917d6d29cf61570f732dd4b08383032be6 100644 --- a/src/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -57,7 +57,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: forces | yes | diff --git a/src/functionObjects/forces/forces/forces.H b/src/functionObjects/forces/forces/forces.H index 0f6dbe09f7096c8df439470dfbee4bd7bbaa23e4..2a5c70d97ca9235c7330c19095f38ab2dbe6ab08 100644 --- a/src/functionObjects/forces/forces/forces.H +++ b/src/functionObjects/forces/forces/forces.H @@ -54,7 +54,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | Type name: forces | yes | diff --git a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H index ecd485e25f673feadb6adab29d09eb47ba646241..13632f9bd029151765ff39412c3eb98cf709feca 100644 --- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H +++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H @@ -49,7 +49,7 @@ Description \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value diff --git a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H index b043e8eae0bc7da3ff2ac52a70f173503df26e44..a27abebdf4281e3ff21a0d7b46058de882714ce0 100644 --- a/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H +++ b/src/functionObjects/lagrangian/icoUncoupledKinematicCloud/icoUncoupledKinematicCloud.H @@ -52,7 +52,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | Type name: icoUncoupledKinematicCloud | yes | diff --git a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H index 18059ad4933adb0a9046158fb50282eeddce07bc..d42297533a73461d1052e3174ee0b9d8401609a5 100644 --- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H +++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H @@ -41,7 +41,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: removeRegisteredObject | yes | diff --git a/src/functionObjects/utilities/systemCall/systemCall.H b/src/functionObjects/utilities/systemCall/systemCall.H index f0030058e18edaafa6bee1adc56109e1805133da..0349cd1e9cac7eaadd2e141eff081faae3ff0b2a 100644 --- a/src/functionObjects/utilities/systemCall/systemCall.H +++ b/src/functionObjects/utilities/systemCall/systemCall.H @@ -59,7 +59,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: systemCall | yes | diff --git a/src/functionObjects/utilities/writeObjects/writeObjects.H b/src/functionObjects/utilities/writeObjects/writeObjects.H index baae5bb5700d31ac3f3847b4702ef4dcf36c4a7f..98f7719ae13942640c4e088521917dba8b4a18f9 100644 --- a/src/functionObjects/utilities/writeObjects/writeObjects.H +++ b/src/functionObjects/utilities/writeObjects/writeObjects.H @@ -52,7 +52,7 @@ Description } \endverbatim - \heading Function object usage +Usage \table Property | Description | Required | Default value type | type name: writeObjects | yes | diff --git a/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H b/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H index 0e65b54ea7c027b310a58e1faee2d85a286e5b07..6de5f6a5ff6cb01d9e8128dbfc7bca03d6ffd81e 100644 --- a/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H +++ b/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H @@ -29,7 +29,7 @@ Description Motion specified as pointVectorFields. - \heading Patch usage +Usage Example: \verbatim diff --git a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H index ced22b540e9c3013d79d0dba667d5484f3b9126f..66e1d2ae04f1d9aae1739e9e7ef39926b7fab9df 100644 --- a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H +++ b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H @@ -44,7 +44,7 @@ Description U_1 | velocity at the disk \endvartable - \heading Source usage +Usage Example usage: \verbatim diff --git a/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H b/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H index 2dd706fde7bff8a690298d934a426b3812e5ee21..e120834482a8d544e90527ad972d6784b8ff76e3 100644 --- a/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H +++ b/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H @@ -28,7 +28,7 @@ Description Calculates and applies the buoyancy energy source rho*(U&g) to the energy equation. - \heading Source usage +Usage Example usage: \verbatim buoyancyEnergyCoeffs diff --git a/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H b/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H index 9bb75bb833ab4642cabcb7e7faa88c6d579e2ea3..691938f2d7b668a060cbe0657f08533ce3a3ade1 100644 --- a/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H +++ b/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H @@ -28,7 +28,7 @@ Description Calculates and applies the buoyancy force rho*g to the momentum equation corresponding to the specified velocity field. - \heading Source usage +Usage Example usage: \verbatim buoyancyForceCoeffs diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H index 6d514ba08ea6af053a228e5a07f8ead3018d1eb2..1c90a97384fe7d17b24fce9987c500e8f322a3dc 100644 --- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H +++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H @@ -59,7 +59,7 @@ Description T_{ref} | min or max(T) in cell zone depending on the sign of Q_t [K] \endvartable - \heading Source usage +Usage Example usage: \verbatim diff --git a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H index 8d92b699846b75cde287dc1a9ec558b7ea274821..bb391ab6fe643448a13e2ac481dc1993110adc36 100644 --- a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H +++ b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H @@ -27,7 +27,7 @@ Class Description Explicit porosity source - \heading Source usage +Usage Example usage, here employing the Darcy-Forchheimer model: \verbatim diff --git a/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H b/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H index 4ae0aad9af078c5a40574534d0973acbd975f413..c05b8d43e6786ab1a34d9894c3293d234c22f130 100644 --- a/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H +++ b/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H @@ -30,7 +30,7 @@ Description Note: Currently only handles kinematic pressure (incompressible solvers). - \heading Source usage +Usage Example usage: \verbatim meanVelocityForceCoeffs diff --git a/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H b/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H index 359ebe6cf31247618ebdd60afea63cc3b7418a13..8cac6a950d85ce80a38dbd89d888ddb9235b7c63 100644 --- a/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H +++ b/src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H @@ -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 @@ Description Note: Currently only handles kinematic pressure (incompressible solvers). - \heading Source usage +Usage Example usage: \verbatim patchMeanVelocityForceCoeffs diff --git a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H index 80c5d4bfc97cd08fb3d6297817682734f8aeab07..107a24b1c9083e8f9b96589cea3f00a2eeea784c 100644 --- a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H +++ b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H @@ -50,7 +50,7 @@ Description thrust(r) = T (C_0 + C_1 r^2 + C_2 r^4) \f] - \heading Source usage +Usage Example usage: \verbatim diff --git a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H index ea5d7ff806b84b06faf674a52e733482ab9d84bc..f3652da1dc8fb459f12ba78083e69a227d2ea33c 100644 --- a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H +++ b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H @@ -30,7 +30,7 @@ Description Cell based momemtum source which approximates the mean effects of rotor forces on a cylindrical region within the domain. - \heading Source usage +Usage Example usage: \verbatim diff --git a/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H b/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H index 5578cddee2d67838c495fd7d9449f60d76f76474..fe969d54ce4105f9fc8e474065728996bc0109a9 100644 --- a/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H +++ b/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H @@ -45,7 +45,7 @@ Description The model generates a field \c \<name\>:alpha1 which can be visualised to to show the melt distribution as a fraction [0-1] - \heading Source usage +Usage Example usage: \verbatim solidificationMeltingSource1 diff --git a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H index 6127d0bff6e5f5c9bdf14b50821758c2fa2e2301..b1ad441c41874ea98841b2b32f78f0bb62837e81 100644 --- a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H +++ b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H @@ -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 @@ -27,7 +27,7 @@ Class Description Solid-body 6-DoF acceleration source - \heading Source usage +Usage Example usage: \verbatim diff --git a/src/fvOptions/sources/general/codedSource/CodedSource.H b/src/fvOptions/sources/general/codedSource/CodedSource.H index e5dd819464e4cf324cc56b99be73a3dc2e741ccb..f09acc6ecb8b10f14769c0ce18b63e427a05f9e2 100644 --- a/src/fvOptions/sources/general/codedSource/CodedSource.H +++ b/src/fvOptions/sources/general/codedSource/CodedSource.H @@ -50,7 +50,7 @@ Description field is the field in fieldNames eqn is the fvMatrix - \heading Source usage +Usage Example usage in controlDict: \verbatim diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index a2e931907d09c46f266db27419890fd29bab415b..bb25db99c9b30aa86f7f0921f878040a3acc5afc 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -47,7 +47,7 @@ Description \delta | film height [m] \endvartable - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index de61d62b946aee8d87a98cc374e97acb5974089f..526cea3ef603074a6773954745ab96e8380497bd 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -33,7 +33,7 @@ Description condition varies from the standard wall function by taking into account any mass released from the film model. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H index 9eb4c5e191c44fc2a2f7e88a8d6dcc931850f3eb..7e43fc89bf14a5a6da7ad36edebea9176ae883a6 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H @@ -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 using wall functions, based on turbulence kinetic energy, for use with surface film models. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H index d5f15aa003d949ba501171a33b2f7cb2ebba1b2e..0efbceb2604bfc4808f4a76f1c1bfa264dddf9e1 100644 --- a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H +++ b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H @@ -43,7 +43,7 @@ Description The thermodynamic properties of the baffle material are specified via dictionary entries on the master patch. - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim myPatch_master diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index b37cb57e498afa425d8212993501cd209b623de9..51e51d2858f3c33fcaa4ec3dcd1dade76605815e 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Group Description This boundary condition provides a fixed condition for internal energy - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index a510d3ac82db8f6ad2b902e9e113282227665946..c0957fb1d5ba5dacfbbf941cf71f8f9de408be24 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -45,7 +45,7 @@ Description \Delta | distance between patch face and internal cell centres [m] \endvartable - \heading Patch usage +Usage Example of the boundary condition specification: \verbatim diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index a43a295fcda605eec8bec4fa2d319100cf544d24..a743d9e6e42ebd40572329ca721f6c2053b900a5 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -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 @@ -34,7 +34,7 @@ Description The radiation temperature is retrieved from the mesh database, using a user specified temperature field name. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index c224f035ba3bdda9552ed6c72ca501acc864064b..540e15093353f6c54d97ed69486217cd618d0ae9 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -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 @@ -34,7 +34,7 @@ Description The radiation temperature field across the patch is supplied by the user using the \c Trad entry. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index d554d59708e3fb1a59c74513a06d011a47af75e8..f568677424478dde9a05431dabee4f10a9674649 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -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 (fvDOM), in which the radiation temperature is retrieved from the temperature field boundary condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 820fde3ee528d11267d75b9534a3ac3d98d9acc1..1325c5e412dd882970fabf01071744b022517ae0 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -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 grey-diffuse condition for radiative heat flux, \c Qr, for use with the view factor model - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index 612cce0445c6f1d49899a785ee39b9a611d6e4e5..25b6a487189f7f021a32adc67f3aa67a8b416d7b 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -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 wide-band, diffusive radiation condition, where the patch temperature is specified. - \heading Patch usage +Usage \table Property | Description | Required | Default value diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H index f1bb383cff4fc48ec73f8d7bff48e25ad8653924..e97c80e5b458c8d4170ac32e77a055a043723021 100644 --- a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H @@ -27,7 +27,7 @@ Class Description Temperature-dependent constant alphaContactAngle scalar boundary condition. - \heading Patch usage +Usage \table Property | Description | Required | Default value