From 48d9c77085c2389a5decc047bbb8f55d82f9a6bb Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Wed, 11 May 2022 21:27:27 +0100 Subject: [PATCH] Updated documentation for foamInfo: The "Note" entry is now part of "Description" or "Usage" so that it is printed by foamInfo. --- ...thDissipationRateInletFvPatchScalarField.H | 6 +-- ...ngLengthFrequencyInletFvPatchScalarField.H | 7 ++- .../momentumTransportModels/RAS/v2f/v2f.H | 8 +-- .../porousBafflePressureFvPatchField.H | 6 +-- .../atmBoundaryLayer/atmBoundaryLayer.H | 12 ++--- .../field/fieldAverage/fieldAverage.H | 6 +-- .../surfaceFieldValue/surfaceFieldValue.H | 34 ++++++------ .../field/streamlines/streamlines.H | 6 +-- .../field/wallHeatFlux/wallHeatFlux.H | 9 ++-- .../wallHeatTransferCoeff.H | 10 ++-- .../ReynoldsAnalogy/ReynoldsAnalogy.H | 6 +-- .../kappaEff/kappaEff.H | 6 +-- .../field/wallShearStress/wallShearStress.H | 9 ++-- src/functionObjects/field/yPlus/yPlus.H | 8 +-- src/functionObjects/forces/forces/forces.H | 52 +++++++++---------- .../utilities/systemCall/systemCall.H | 10 ++-- .../fixedTemperatureConstraint.H | 6 +-- .../meanVelocityForce/meanVelocityForce.H | 4 +- .../patchMeanVelocityForce.H | 6 +-- .../effectivenessHeatExchangerSource.H | 14 ++--- .../explicitPorositySource.H | 4 +- .../decompose/scotchDecomp/scotchDecomp.H | 19 ++++--- .../interpolationLookUpTable.H | 8 +-- src/sampling/cuttingPlane/cuttingPlane.H | 8 +-- .../polynomial/polynomialSolidTransport.H | 6 +-- .../thermo/ePolynomial/ePolynomialThermo.H | 8 +-- .../thermo/hPolynomial/hPolynomialThermo.H | 8 +-- .../tools/labelPair/labelPairLookup.H | 8 +-- 28 files changed, 147 insertions(+), 147 deletions(-) diff --git a/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index 2b37941f36..846aeb6f37 100644 --- a/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,8 +60,8 @@ Usage } \endverbatim -Note - In the event of reverse flow, a zero-gradient condition is applied + Note: + In the event of reverse flow, a zero-gradient condition is applied See also Foam::inletOutletFvPatchField diff --git a/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index b298fa5ff4..d17e10bff9 100644 --- a/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -60,13 +60,12 @@ Usage } \endverbatim -Note - In the event of reverse flow, a zero-gradient condition is applied + Note: + In the event of reverse flow, a zero-gradient condition is applied See also Foam::inletOutletFvPatchField - SourceFiles turbulentMixingLengthFrequencyInletFvPatchScalarField.C diff --git a/src/MomentumTransportModels/momentumTransportModels/RAS/v2f/v2f.H b/src/MomentumTransportModels/momentumTransportModels/RAS/v2f/v2f.H index fd9392e546..0acd1e17cd 100644 --- a/src/MomentumTransportModels/momentumTransportModels/RAS/v2f/v2f.H +++ b/src/MomentumTransportModels/momentumTransportModels/RAS/v2f/v2f.H @@ -78,10 +78,10 @@ Description } \endverbatim -Note - If the kLowReWallFunction is employed, a velocity variant of the turbulent - viscosity wall function should be used, e.g. nutUWallFunction. Turbulence - k variants (nutk...) for this case will not behave correctly. + Note: + If the kLowReWallFunction is employed, a velocity variant of the + turbulent viscosity wall function should be used, e.g. nutUWallFunction. + Turbulence k variants (nutk...) for this case will not behave correctly. See also Foam::RASModels::v2fBase diff --git a/src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index e3a1a1d3ee..e1764700a3 100644 --- a/src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -71,8 +71,8 @@ Usage } \endverbatim -Note - The underlying \c patchType should be set to \c cyclic + Note: + The underlying \c patchType should be set to \c cyclic SourceFiles porousBafflePressureFvPatchField.C diff --git a/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H index 04a0d26b69..4f1a8f6b67 100644 --- a/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H +++ b/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2014-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2014-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -101,11 +101,11 @@ Usage } \endverbatim -Note - D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the - k-epsilon model should be changed from 1.3 to 1.11 for consistency. - The roughness height (Er) is given by Er = 20 z0 following the same - reference. + Note: + D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the + k-epsilon model should be changed from 1.3 to 1.11 for consistency. + The roughness height (Er) is given by Er = 20 z0 following the same + reference. SourceFiles atmBoundaryLayer.C diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index 2ebac4db82..199afc64ca 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -90,8 +90,8 @@ Usage fields | list of fields and averaging options | yes | \endtable -Note - To employ the \c prime2Mean option, the \c mean option must be selected. + Note: + To employ the \c prime2Mean option, the \c mean option must be selected. See also Foam::functionObjects::fvMeshFunctionObject diff --git a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H index 9d74556dfb..86237262df 100644 --- a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H +++ b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -128,22 +128,22 @@ Usage areaNormalIntegrate | area weighted integral in face normal direction \endplaintable -Note - - Faces on empty patches get ignored. - - The `oriented' operations will flip the sign of the field so that all the - normals point in a consistent direction. This is only of relevance when - summing mesh-oriented fields, such as the flux, on faceZones. - - If the field is a volField then a \c faceZone can only consist of - boundary faces, because only these faces have a value associated with - them. No cell-to-face interpolation is performed. - - If the field is a surfaceField then the region cannot be a \c - sampledSurface - - If a sampledSurface has interpolation set to false then the surface - face values will be taken directly from the cell that contains the - surface face centre - - If a \c sampledSurface has interpolation set to true then the field - will be interpolated to the vertices, then averaged onto the surface - faces + Note: + - Faces on empty patches get ignored. + - The `oriented' operations will flip the sign of the field so that all + the normals point in a consistent direction. This is only of relevance + when summing mesh-oriented fields, such as the flux, on faceZones. + - If the field is a volField then a \c faceZone can only consist of + boundary faces, because only these faces have a value associated with + them. No cell-to-face interpolation is performed. + - If the field is a surfaceField then the region cannot be a \c + sampledSurface + - If a sampledSurface has interpolation set to false then the surface + face values will be taken directly from the cell that contains the + surface face centre + - If a \c sampledSurface has interpolation set to true then the field + will be interpolated to the vertices, then averaged onto the surface + faces See also Foam::fieldValues diff --git a/src/functionObjects/field/streamlines/streamlines.H b/src/functionObjects/field/streamlines/streamlines.H index 20d1721a5b..cf76c587ce 100644 --- a/src/functionObjects/field/streamlines/streamlines.H +++ b/src/functionObjects/field/streamlines/streamlines.H @@ -87,9 +87,9 @@ Usage points | a specified set of locations \endplaintable -Note - When specifying the track resolution, the \c trackLength OR \c nSubCycle - option should be used + Note: + When specifying the track resolution, the \c trackLength OR \c nSubCycle + option should be used See also Foam::functionObject diff --git a/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H b/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H index 92f0598013..e59c135110 100644 --- a/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H +++ b/src/functionObjects/field/wallHeatFlux/wallHeatFlux.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2016-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2016-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,9 +51,10 @@ Usage region | region to be evaluated | no | default region \endtable -Note - Writing field 'wallHeatFlux' is done by default, but it can be overridden by - defining an empty \c objects list. For details see writeLocalObjects. + Note: + Writing field 'wallHeatFlux' is done by default, but it can be + overridden by defining an empty \c objects list. For details see + writeLocalObjects. See also Foam::functionObject diff --git a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H index 67c066acb7..5768151e63 100644 --- a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H +++ b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -84,10 +84,10 @@ Description } \endverbatim -Note - Writing field 'wallHeatTransferCoeff' is done by default, but it can be - overridden by defining an empty \c objects list. For details see - writeLocalObjects. + Note: + Writing field 'wallHeatTransferCoeff' is done by default, but it can be + overridden by defining an empty \c objects list. For details see + writeLocalObjects. See also Foam::functionObject diff --git a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/ReynoldsAnalogy/ReynoldsAnalogy.H b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/ReynoldsAnalogy/ReynoldsAnalogy.H index 13b6d8f5b3..c5d9ca29f7 100644 --- a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/ReynoldsAnalogy/ReynoldsAnalogy.H +++ b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/ReynoldsAnalogy/ReynoldsAnalogy.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -75,8 +75,8 @@ Usage Uref | Reference velocity magnitude | yes | no \endtable -Note - Cp and rho are required only for incompressible flow calclulations. + Note: + Cp and rho are required only for incompressible flow calclulations. SourceFiles ReynoldsAnalogy.C diff --git a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/kappaEff/kappaEff.H b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/kappaEff/kappaEff.H index e92173196e..97000bb6b7 100644 --- a/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/kappaEff/kappaEff.H +++ b/src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/kappaEff/kappaEff.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -98,8 +98,8 @@ Usage Lchar | Characteristic length | no | no \endtable -Note - Cp and rho are required only for incompressible flow calclulations. + Note: + Cp and rho are required only for incompressible flow calclulations. SourceFiles kappaEff.C diff --git a/src/functionObjects/field/wallShearStress/wallShearStress.H b/src/functionObjects/field/wallShearStress/wallShearStress.H index 2ff1b06955..43f1cc90e1 100644 --- a/src/functionObjects/field/wallShearStress/wallShearStress.H +++ b/src/functionObjects/field/wallShearStress/wallShearStress.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2013-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,9 +61,10 @@ Usage phase | phase name | no | \endtable -Note - Writing field 'wallShearStress' is done by default, but it can be overridden - by defining an empty \c objects list. For details see writeLocalObjects. + Note: + Writing field 'wallShearStress' is done by default, but it can be + overridden by defining an empty \c objects list. For details see + writeLocalObjects. See also Foam::functionObject diff --git a/src/functionObjects/field/yPlus/yPlus.H b/src/functionObjects/field/yPlus/yPlus.H index f98a293e00..cee4c1e12b 100644 --- a/src/functionObjects/field/yPlus/yPlus.H +++ b/src/functionObjects/field/yPlus/yPlus.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2013-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -45,9 +45,9 @@ Usage phase | phase name | no | \endtable -Note - Writing field 'yPlus' is done by default, but it can be overridden by - defining an empty \c objects list. For details see writeLocalObjects. + Note: + Writing field 'yPlus' is done by default, but it can be overridden by + defining an empty \c objects list. For details see writeLocalObjects. See also Foam::functionObject diff --git a/src/functionObjects/forces/forces/forces.H b/src/functionObjects/forces/forces/forces.H index 06d41d985a..fbd064c926 100644 --- a/src/functionObjects/forces/forces/forces.H +++ b/src/functionObjects/forces/forces/forces.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -74,31 +74,31 @@ Usage cumulative | bin data accumulated with increasing distance | yes | \endtable -Note - - For incompressible cases, set \c rho to \c rhoInf and provide - a \c rhoInf value corresponding to the free-stream constant density. - - If the \c phase name is specified the corresponding phase-fraction field - \c alpha. is used to filter the surface force field - before integration. - - If the force density is supplied directly, set the \c directForceDensity - flag to 'yes', and supply the force density field using the \c - fDName entry - - The centre of rotation (CofR) for moment calculations can either be - specified by an \c CofR entry, or be taken from origin of the local - coordinate system. For example, - \verbatim - CofR (0 0 0); - \endverbatim - or - \verbatim - origin (0 0 0); - coordinateRotation - { - type axesRotation; - e1 (1 0 0); - e3 (0 0 1); - } - \endverbatim + Note + - For incompressible cases, set \c rho to \c rhoInf and provide + a \c rhoInf value corresponding to the free-stream constant density. + - If the \c phase name is specified the corresponding phase-fraction field + \c alpha. is used to filter the surface force field + before integration. + - If the force density is supplied directly, set the \c directForceDensity + flag to 'yes', and supply the force density field using the \c + fDName entry + - The centre of rotation (CofR) for moment calculations can either be + specified by an \c CofR entry, or be taken from origin of the local + coordinate system. For example, + \verbatim + CofR (0 0 0); + \endverbatim + or + \verbatim + origin (0 0 0); + coordinateRotation + { + type axesRotation; + e1 (1 0 0); + e3 (0 0 1); + } + \endverbatim See also Foam::functionObject diff --git a/src/functionObjects/utilities/systemCall/systemCall.H b/src/functionObjects/utilities/systemCall/systemCall.H index aaac6cfa76..e71aae672e 100644 --- a/src/functionObjects/utilities/systemCall/systemCall.H +++ b/src/functionObjects/utilities/systemCall/systemCall.H @@ -68,11 +68,11 @@ Usage endCalls | list of calls on end | yes | \endtable -Note - Since this function object executes system calls, there is a potential - security risk. In order to use the \c systemCall function object, the - \c allowSystemOperations must be set to '1'; otherwise, system calls will - not be allowed. + Note: + Since this function object executes system calls, there is a potential + security risk. In order to use the \c systemCall function object, the + \c allowSystemOperations must be set to '1'; otherwise, system calls + will not be allowed. See also Foam::functionObject diff --git a/src/fvConstraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H b/src/fvConstraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H index 753b9b8b68..9a64d676d3 100644 --- a/src/fvConstraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H +++ b/src/fvConstraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H @@ -46,9 +46,9 @@ Usage } \endverbatim -Note - The 'uniform' option allows the use of a time-varying uniform temperature - by means of the Function1 type. + Note: + The 'uniform' option allows the use of a time-varying uniform + temperature by means of the Function1 type. SourceFiles fixedTemperatureConstraint.C diff --git a/src/fvConstraints/meanVelocityForce/meanVelocityForce.H b/src/fvConstraints/meanVelocityForce/meanVelocityForce.H index 54e896b3d2..2f7b1c401d 100644 --- a/src/fvConstraints/meanVelocityForce/meanVelocityForce.H +++ b/src/fvConstraints/meanVelocityForce/meanVelocityForce.H @@ -44,8 +44,8 @@ Usage } \endverbatim -Note - Currently only handles kinematic pressure (incompressible solvers). + Note: + Currently only handles kinematic pressure (incompressible solvers). SourceFiles meanVelocityForce.C diff --git a/src/fvConstraints/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H b/src/fvConstraints/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H index 2cdb325582..a10f6dadc7 100644 --- a/src/fvConstraints/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H +++ b/src/fvConstraints/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2015-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -46,8 +46,8 @@ Usage } \endverbatim -Note - Currently only handles kinematic pressure (incompressible solvers). + Note: + Currently only handles kinematic pressure (incompressible solvers). SourceFiles patchMeanVelocityForce.C diff --git a/src/fvModels/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvModels/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H index 6ae68de4ba..3b1f36a042 100644 --- a/src/fvModels/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H +++ b/src/fvModels/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H @@ -79,13 +79,13 @@ Usage } \endverbatim -Note - - The effectiveness Function2 is described in terms of the primary and - secondary mass flow rates and has the same units as the secondary mass - flow rate and kg/s for phi. - - faceZone is the faces at the inlet of the cellzone, it needs to be - created with flip map flags. It is used to integrate the net mass flow - rate into the heat exchanger + Note: + - The effectiveness Function2 is described in terms of the primary and + secondary mass flow rates and has the same units as the secondary mass + flow rate and kg/s for phi. + - faceZone is the faces at the inlet of the cellzone, it needs to be + created with flip map flags. It is used to integrate the net mass flow + rate into the heat exchanger SourceFiles effectivenessHeatExchangerSource.C diff --git a/src/fvModels/derived/explicitPorositySource/explicitPorositySource.H b/src/fvModels/derived/explicitPorositySource/explicitPorositySource.H index 16d3dcf033..8c0c05b61c 100644 --- a/src/fvModels/derived/explicitPorositySource/explicitPorositySource.H +++ b/src/fvModels/derived/explicitPorositySource/explicitPorositySource.H @@ -54,8 +54,8 @@ Usage } \endverbatim -Note - The porous region must be selected as a cellZone. + Note: + The porous region must be selected as a cellZone. SourceFiles explicitPorositySource.C diff --git a/src/parallel/decompose/scotchDecomp/scotchDecomp.H b/src/parallel/decompose/scotchDecomp/scotchDecomp.H index 2151b0ae75..9af34bd533 100644 --- a/src/parallel/decompose/scotchDecomp/scotchDecomp.H +++ b/src/parallel/decompose/scotchDecomp/scotchDecomp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -195,15 +195,14 @@ Description -Note - \c gpart can be found in the current search path by adding the respective - \c bin folder from the Scotch installation, namely by running the following - commands: - - \verbatim - source $(foamEtcFile config.sh/scotch) - export PATH=$PATH:$SCOTCH_ARCH_PATH/bin - \endverbatim + Note: + \c gpart can be found in the current search path by adding the + respective \c bin folder from the Scotch installation, namely by running + the following commands: + \verbatim + source $(foamEtcFile config.sh/scotch) + export PATH=$PATH:$SCOTCH_ARCH_PATH/bin + \endverbatim SourceFiles scotchDecomp.C diff --git a/src/radiationModels/absorptionEmissionModels/interpolationLookUpTable/interpolationLookUpTable.H b/src/radiationModels/absorptionEmissionModels/interpolationLookUpTable/interpolationLookUpTable.H index a1224d4b61..20d6a27a81 100644 --- a/src/radiationModels/absorptionEmissionModels/interpolationLookUpTable/interpolationLookUpTable.H +++ b/src/radiationModels/absorptionEmissionModels/interpolationLookUpTable/interpolationLookUpTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,9 +28,9 @@ Description A list of lists. Interpolates based on the first dimension. The values must be positive and monotonically increasing in each dimension -Note - - Accessing an empty list results in an error. - - Accessing a list with a single element always returns the same value. + Note: + - Accessing an empty list results in an error. + - Accessing a list with a single element always returns the same value. SourceFiles interpolationLookUpTable.C diff --git a/src/sampling/cuttingPlane/cuttingPlane.H b/src/sampling/cuttingPlane/cuttingPlane.H index 8f456c3856..0b4c45cdf7 100644 --- a/src/sampling/cuttingPlane/cuttingPlane.H +++ b/src/sampling/cuttingPlane/cuttingPlane.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,9 +30,9 @@ Description No attempt at resolving degenerate cases. Since the cut faces are usually quite ugly, they will always be triangulated. -Note - When the cutting plane coincides with a mesh face, the cell edge on the - positive side of the plane is taken. + Note: + When the cutting plane coincides with a mesh face, the cell edge on the + positive side of the plane is taken. SourceFiles cuttingPlane.C diff --git a/src/thermophysicalModels/solidThermo/solidSpecie/transport/polynomial/polynomialSolidTransport.H b/src/thermophysicalModels/solidThermo/solidSpecie/transport/polynomial/polynomialSolidTransport.H index d7e1456a41..1e3d2f61d3 100644 --- a/src/thermophysicalModels/solidThermo/solidSpecie/transport/polynomial/polynomialSolidTransport.H +++ b/src/thermophysicalModels/solidThermo/solidSpecie/transport/polynomial/polynomialSolidTransport.H @@ -48,9 +48,9 @@ Usage \kappa = 1000 - 0.05 T + 0.003 T^2 \f] -Note - Thermal conductivity polynomial coefficients evaluate to an expression in - [W/m/K]. + Note: + Thermal conductivity polynomial coefficients evaluate to an expression + in [W/m/K]. SourceFiles polynomialSolidTransportI.H diff --git a/src/thermophysicalModels/specie/thermo/ePolynomial/ePolynomialThermo.H b/src/thermophysicalModels/specie/thermo/ePolynomial/ePolynomialThermo.H index 997c31b3da..0cc6f4867b 100644 --- a/src/thermophysicalModels/specie/thermo/ePolynomial/ePolynomialThermo.H +++ b/src/thermophysicalModels/specie/thermo/ePolynomial/ePolynomialThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2021-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,9 +56,9 @@ Usage } \endverbatim -Note - Specific heat at constant volume polynomial coefficients evaluate to an - expression in [J/kg/K]. + Note: + Specific heat at constant volume polynomial coefficients evaluate to an + expression in [J/kg/K]. SourceFiles ePolynomialThermoI.H diff --git a/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H b/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H index 48c971119f..4021d07be1 100644 --- a/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H +++ b/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -54,9 +54,9 @@ Usage } \endverbatim -Note - Specific heat at constant pressure polynomial coefficients evaluate to an - expression in [J/kg/K]. + Note: + Specific heat at constant pressure polynomial coefficients evaluate to + an expression in [J/kg/K]. SourceFiles hPolynomialThermoI.H diff --git a/src/triSurface/tools/labelPair/labelPairLookup.H b/src/triSurface/tools/labelPair/labelPairLookup.H index 6a520cb291..2f9aacafdd 100644 --- a/src/triSurface/tools/labelPair/labelPairLookup.H +++ b/src/triSurface/tools/labelPair/labelPairLookup.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,9 +28,9 @@ Description A HashTable for two labels to another label. Used for e.g. for face1, face2 to shared edge. -Note - The hash table is based on a FixedList and not edge, since an edge - hashes commutatively! + Note: + The hash table is based on a FixedList and not edge, since an edge + hashes commutatively! \*---------------------------------------------------------------------------*/