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

6
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,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

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

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

6
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,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

12
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,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

6
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,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

34
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,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

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

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

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

10
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,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

6
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,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

6
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,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

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

8
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,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

52
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
@ -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.<phase> 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.<phase> 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

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

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

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

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

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

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

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

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

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

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

19
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,15 +195,14 @@ 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:
\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

8
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,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

8
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,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

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

8
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,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

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

8
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,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!
\*---------------------------------------------------------------------------*/