zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation for foamInfo: The "Note" entry is now part of "Description" or "Usage"

Browse Source 
so that it is printed by foamInfo.
This commit is contained in:
Henry Weller
2022-05-11 21:27:27 +01:00
parent 7a8f59e2b9
commit 48d9c77085
28 changed files with 147 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H
View File

@ -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,7 +60,7 @@ Usage
}
\endverbatim
Note
Note:
In the event of reverse flow, a zero-gradient condition is applied
See also

5
src/MomentumTransportModels/momentumTransportModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
View File

@ -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
Note:
In the event of reverse flow, a zero-gradient condition is applied
See also
Foam::inletOutletFvPatchField
SourceFiles
turbulentMixingLengthFrequencyInletFvPatchScalarField.C

8
src/MomentumTransportModels/momentumTransportModels/RAS/v2f/v2f.H
View File

@ -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

4
src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H
View File

@ -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,7 +71,7 @@ Usage
}
\endverbatim
Note
Note:
The underlying \c patchType should be set to \c cyclic
SourceFiles

4
src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
View File

@ -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,7 +101,7 @@ Usage
}
\endverbatim
Note
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

4
src/functionObjects/field/fieldAverage/fieldAverage.H
View File

@ -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,7 +90,7 @@ Usage
fields | list of fields and averaging options | yes |
\endtable
Note
Note:
To employ the \c prime2Mean option, the \c mean option must be selected.
See also

10
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
View File

@ -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,11 +128,11 @@ Usage
areaNormalIntegrate | area weighted integral in face normal direction
\endplaintable
Note
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.
- 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.

2
src/functionObjects/field/streamlines/streamlines.H
View File

@ -87,7 +87,7 @@ Usage
points | a specified set of locations
\endplaintable
Note
Note:
When specifying the track resolution, the \c trackLength OR \c nSubCycle
option should be used

9
src/functionObjects/field/wallHeatFlux/wallHeatFlux.H
View File

@ -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

4
src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeff.H
View File

@ -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,7 +84,7 @@ Description
}
\endverbatim
Note
Note:
Writing field 'wallHeatTransferCoeff' is done by default, but it can be
overridden by defining an empty \c objects list. For details see
writeLocalObjects.

4
src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/ReynoldsAnalogy/ReynoldsAnalogy.H
View File

@ -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,7 +75,7 @@ Usage
Uref | Reference velocity magnitude | yes | no
\endtable
Note
Note:
Cp and rho are required only for incompressible flow calclulations.
SourceFiles

4
src/functionObjects/field/wallHeatTransferCoeff/wallHeatTransferCoeffModels/kappaEff/kappaEff.H
View File

@ -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,7 +98,7 @@ Usage
Lchar | Characteristic length | no | no
\endtable
Note
Note:
Cp and rho are required only for incompressible flow calclulations.
SourceFiles

9
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -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

4
src/functionObjects/field/yPlus/yPlus.H
View File

@ -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,7 +45,7 @@ Usage
phase | phase name | no |
\endtable
Note
Note:
Writing field 'yPlus' is done by default, but it can be overridden by
defining an empty \c objects list. For details see writeLocalObjects.

2
src/functionObjects/forces/forces/forces.H
View File

@ -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

6
src/functionObjects/utilities/systemCall/systemCall.H
View File

@ -68,11 +68,11 @@ Usage
endCalls | list of calls on end | yes |
\endtable
Note
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.
\c allowSystemOperations must be set to '1'; otherwise, system calls
will not be allowed.
See also
Foam::functionObject

6
src/fvConstraints/fixedTemperatureConstraint/fixedTemperatureConstraint.H
View File

@ -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

2
src/fvConstraints/meanVelocityForce/meanVelocityForce.H
View File

@ -44,7 +44,7 @@ Usage
}
\endverbatim
Note
Note:
Currently only handles kinematic pressure (incompressible solvers).
SourceFiles

4
src/fvConstraints/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H
View File

@ -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,7 +46,7 @@ Usage
}
\endverbatim
Note
Note:
Currently only handles kinematic pressure (incompressible solvers).
SourceFiles

2
src/fvModels/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
View File

@ -79,7 +79,7 @@ Usage
}
\endverbatim
Note
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.

2
src/fvModels/derived/explicitPorositySource/explicitPorositySource.H
View File

@ -54,7 +54,7 @@ Usage
}
\endverbatim
Note
Note:
The porous region must be selected as a cellZone.
SourceFiles

11
src/parallel/decompose/scotchDecomp/scotchDecomp.H
View File

@ -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,11 +195,10 @@ Description
</ol>
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:
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

4
src/radiationModels/absorptionEmissionModels/interpolationLookUpTable/interpolationLookUpTable.H
View File

@ -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,7 +28,7 @@ Description
A list of lists. Interpolates based on the first dimension.
The values must be positive and monotonically increasing in each dimension
Note
Note:
- Accessing an empty list results in an error.
- Accessing a list with a single element always returns the same value.

4
src/sampling/cuttingPlane/cuttingPlane.H
View File

@ -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,7 +30,7 @@ Description
No attempt at resolving degenerate cases. Since the cut faces are
usually quite ugly, they will always be triangulated.
Note
Note:
When the cutting plane coincides with a mesh face, the cell edge on the
positive side of the plane is taken.

6
src/thermophysicalModels/solidThermo/solidSpecie/transport/polynomial/polynomialSolidTransport.H
View File

@ -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

4
src/thermophysicalModels/specie/thermo/ePolynomial/ePolynomialThermo.H
View File

@ -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,7 +56,7 @@ Usage
}
\endverbatim
Note
Note:
Specific heat at constant volume polynomial coefficients evaluate to an
expression in [J/kg/K].

8
src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H
View File

@ -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

4
src/triSurface/tools/labelPair/labelPairLookup.H
View File

@ -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,7 +28,7 @@ Description
A HashTable for two labels to another label.
Used for e.g. for face1, face2 to shared edge.
Note
Note:
The hash table is based on a FixedList and not edge, since an edge
hashes commutatively!