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

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

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -60,8 +60,8 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
In the event of reverse flow, a zero-gradient condition is applied In the event of reverse flow, a zero-gradient condition is applied
See also See also
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -60,13 +60,12 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
In the event of reverse flow, a zero-gradient condition is applied In the event of reverse flow, a zero-gradient condition is applied
See also See also
Foam::inletOutletFvPatchField Foam::inletOutletFvPatchField
SourceFiles SourceFiles
turbulentMixingLengthFrequencyInletFvPatchScalarField.C turbulentMixingLengthFrequencyInletFvPatchScalarField.C

View File

@ -78,10 +78,10 @@ Description
} }
\endverbatim \endverbatim
Note Note:
If the kLowReWallFunction is employed, a velocity variant of the turbulent If the kLowReWallFunction is employed, a velocity variant of the
viscosity wall function should be used, e.g. nutUWallFunction. Turbulence turbulent viscosity wall function should be used, e.g. nutUWallFunction.
k variants (nutk...) for this case will not behave correctly. Turbulence k variants (nutk...) for this case will not behave correctly.
See also See also
Foam::RASModels::v2fBase Foam::RASModels::v2fBase

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -71,8 +71,8 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
The underlying \c patchType should be set to \c cyclic The underlying \c patchType should be set to \c cyclic
SourceFiles SourceFiles
porousBafflePressureFvPatchField.C porousBafflePressureFvPatchField.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2014-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2014-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -101,11 +101,11 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the 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. 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 The roughness height (Er) is given by Er = 20 z0 following the same
reference. reference.
SourceFiles SourceFiles
atmBoundaryLayer.C atmBoundaryLayer.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -90,8 +90,8 @@ Usage
fields | list of fields and averaging options | yes | fields | list of fields and averaging options | yes |
\endtable \endtable
Note Note:
To employ the \c prime2Mean option, the \c mean option must be selected. To employ the \c prime2Mean option, the \c mean option must be selected.
See also See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::fvMeshFunctionObject

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -128,22 +128,22 @@ Usage
areaNormalIntegrate | area weighted integral in face normal direction areaNormalIntegrate | area weighted integral in face normal direction
\endplaintable \endplaintable
Note Note:
- Faces on empty patches get ignored. - Faces on empty patches get ignored.
- The `oriented' operations will flip the sign of the field so that all the - The `oriented' operations will flip the sign of the field so that all
normals point in a consistent direction. This is only of relevance when the normals point in a consistent direction. This is only of relevance
summing mesh-oriented fields, such as the flux, on faceZones. 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 - 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 boundary faces, because only these faces have a value associated with
them. No cell-to-face interpolation is performed. them. No cell-to-face interpolation is performed.
- If the field is a surfaceField then the region cannot be a \c - If the field is a surfaceField then the region cannot be a \c
sampledSurface sampledSurface
- If a sampledSurface has interpolation set to false then the surface - If a sampledSurface has interpolation set to false then the surface
face values will be taken directly from the cell that contains the face values will be taken directly from the cell that contains the
surface face centre surface face centre
- If a \c sampledSurface has interpolation set to true then the field - If a \c sampledSurface has interpolation set to true then the field
will be interpolated to the vertices, then averaged onto the surface will be interpolated to the vertices, then averaged onto the surface
faces faces
See also See also
Foam::fieldValues Foam::fieldValues

View File

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

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2016-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -51,9 +51,10 @@ Usage
region | region to be evaluated | no | default region region | region to be evaluated | no | default region
\endtable \endtable
Note Note:
Writing field 'wallHeatFlux' is done by default, but it can be overridden by Writing field 'wallHeatFlux' is done by default, but it can be
defining an empty \c objects list. For details see writeLocalObjects. overridden by defining an empty \c objects list. For details see
writeLocalObjects.
See also See also
Foam::functionObject Foam::functionObject

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -84,10 +84,10 @@ Description
} }
\endverbatim \endverbatim
Note Note:
Writing field 'wallHeatTransferCoeff' is done by default, but it can be Writing field 'wallHeatTransferCoeff' is done by default, but it can be
overridden by defining an empty \c objects list. For details see overridden by defining an empty \c objects list. For details see
writeLocalObjects. writeLocalObjects.
See also See also
Foam::functionObject Foam::functionObject

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -75,8 +75,8 @@ Usage
Uref | Reference velocity magnitude | yes | no Uref | Reference velocity magnitude | yes | no
\endtable \endtable
Note Note:
Cp and rho are required only for incompressible flow calclulations. Cp and rho are required only for incompressible flow calclulations.
SourceFiles SourceFiles
ReynoldsAnalogy.C ReynoldsAnalogy.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -98,8 +98,8 @@ Usage
Lchar | Characteristic length | no | no Lchar | Characteristic length | no | no
\endtable \endtable
Note Note:
Cp and rho are required only for incompressible flow calclulations. Cp and rho are required only for incompressible flow calclulations.
SourceFiles SourceFiles
kappaEff.C kappaEff.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -61,9 +61,10 @@ Usage
phase | phase name | no | phase | phase name | no |
\endtable \endtable
Note Note:
Writing field 'wallShearStress' is done by default, but it can be overridden Writing field 'wallShearStress' is done by default, but it can be
by defining an empty \c objects list. For details see writeLocalObjects. overridden by defining an empty \c objects list. For details see
writeLocalObjects.
See also See also
Foam::functionObject Foam::functionObject

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -45,9 +45,9 @@ Usage
phase | phase name | no | phase | phase name | no |
\endtable \endtable
Note Note:
Writing field 'yPlus' is done by default, but it can be overridden by Writing field 'yPlus' is done by default, but it can be overridden by
defining an empty \c objects list. For details see writeLocalObjects. defining an empty \c objects list. For details see writeLocalObjects.
See also See also
Foam::functionObject Foam::functionObject

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -74,31 +74,31 @@ Usage
cumulative | bin data accumulated with increasing distance | yes | cumulative | bin data accumulated with increasing distance | yes |
\endtable \endtable
Note Note
- For incompressible cases, set \c rho to \c rhoInf and provide - For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density. a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field - If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field \c alpha.<phase> is used to filter the surface force field
before integration. before integration.
- If the force density is supplied directly, set the \c directForceDensity - If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c flag to 'yes', and supply the force density field using the \c
fDName entry fDName entry
- The centre of rotation (CofR) for moment calculations can either be - 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 specified by an \c CofR entry, or be taken from origin of the local
coordinate system. For example, coordinate system. For example,
\verbatim \verbatim
CofR (0 0 0); CofR (0 0 0);
\endverbatim \endverbatim
or or
\verbatim \verbatim
origin (0 0 0); origin (0 0 0);
coordinateRotation coordinateRotation
{ {
type axesRotation; type axesRotation;
e1 (1 0 0); e1 (1 0 0);
e3 (0 0 1); e3 (0 0 1);
} }
\endverbatim \endverbatim
See also See also
Foam::functionObject Foam::functionObject

View File

@ -68,11 +68,11 @@ Usage
endCalls | list of calls on end | yes | endCalls | list of calls on end | yes |
\endtable \endtable
Note Note:
Since this function object executes system calls, there is a potential Since this function object executes system calls, there is a potential
security risk. In order to use the \c systemCall function object, the security risk. In order to use the \c systemCall function object, the
\c allowSystemOperations must be set to '1'; otherwise, system calls will \c allowSystemOperations must be set to '1'; otherwise, system calls
not be allowed. will not be allowed.
See also See also
Foam::functionObject Foam::functionObject

View File

@ -46,9 +46,9 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
The 'uniform' option allows the use of a time-varying uniform temperature The 'uniform' option allows the use of a time-varying uniform
by means of the Function1 type. temperature by means of the Function1 type.
SourceFiles SourceFiles
fixedTemperatureConstraint.C fixedTemperatureConstraint.C

View File

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

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2015-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -46,8 +46,8 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
Currently only handles kinematic pressure (incompressible solvers). Currently only handles kinematic pressure (incompressible solvers).
SourceFiles SourceFiles
patchMeanVelocityForce.C patchMeanVelocityForce.C

View File

@ -79,13 +79,13 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
- The effectiveness Function2 is described in terms of the primary and - The effectiveness Function2 is described in terms of the primary and
secondary mass flow rates and has the same units as the secondary mass secondary mass flow rates and has the same units as the secondary mass
flow rate and kg/s for phi. flow rate and kg/s for phi.
- faceZone is the faces at the inlet of the cellzone, it needs to be - 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 created with flip map flags. It is used to integrate the net mass flow
rate into the heat exchanger rate into the heat exchanger
SourceFiles SourceFiles
effectivenessHeatExchangerSource.C effectivenessHeatExchangerSource.C

View File

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

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -195,15 +195,14 @@ Description
</ol> </ol>
Note Note:
\c gpart can be found in the current search path by adding the respective \c gpart can be found in the current search path by adding the
\c bin folder from the Scotch installation, namely by running the following respective \c bin folder from the Scotch installation, namely by running
commands: the following commands:
\verbatim
\verbatim source $(foamEtcFile config.sh/scotch)
source $(foamEtcFile config.sh/scotch) export PATH=$PATH:$SCOTCH_ARCH_PATH/bin
export PATH=$PATH:$SCOTCH_ARCH_PATH/bin \endverbatim
\endverbatim
SourceFiles SourceFiles
scotchDecomp.C scotchDecomp.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,9 +28,9 @@ Description
A list of lists. Interpolates based on the first dimension. A list of lists. Interpolates based on the first dimension.
The values must be positive and monotonically increasing in each dimension The values must be positive and monotonically increasing in each dimension
Note Note:
- Accessing an empty list results in an error. - Accessing an empty list results in an error.
- Accessing a list with a single element always returns the same value. - Accessing a list with a single element always returns the same value.
SourceFiles SourceFiles
interpolationLookUpTable.C interpolationLookUpTable.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,9 +30,9 @@ Description
No attempt at resolving degenerate cases. Since the cut faces are No attempt at resolving degenerate cases. Since the cut faces are
usually quite ugly, they will always be triangulated. usually quite ugly, they will always be triangulated.
Note Note:
When the cutting plane coincides with a mesh face, the cell edge on the When the cutting plane coincides with a mesh face, the cell edge on the
positive side of the plane is taken. positive side of the plane is taken.
SourceFiles SourceFiles
cuttingPlane.C cuttingPlane.C

View File

@ -48,9 +48,9 @@ Usage
\kappa = 1000 - 0.05 T + 0.003 T^2 \kappa = 1000 - 0.05 T + 0.003 T^2
\f] \f]
Note Note:
Thermal conductivity polynomial coefficients evaluate to an expression in Thermal conductivity polynomial coefficients evaluate to an expression
[W/m/K]. in [W/m/K].
SourceFiles SourceFiles
polynomialSolidTransportI.H polynomialSolidTransportI.H

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2021-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -56,9 +56,9 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
Specific heat at constant volume polynomial coefficients evaluate to an Specific heat at constant volume polynomial coefficients evaluate to an
expression in [J/kg/K]. expression in [J/kg/K].
SourceFiles SourceFiles
ePolynomialThermoI.H ePolynomialThermoI.H

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -54,9 +54,9 @@ Usage
} }
\endverbatim \endverbatim
Note Note:
Specific heat at constant pressure polynomial coefficients evaluate to an Specific heat at constant pressure polynomial coefficients evaluate to
expression in [J/kg/K]. an expression in [J/kg/K].
SourceFiles SourceFiles
hPolynomialThermoI.H hPolynomialThermoI.H

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,9 +28,9 @@ Description
A HashTable for two labels to another label. A HashTable for two labels to another label.
Used for e.g. for face1, face2 to shared edge. 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 The hash table is based on a FixedList and not edge, since an edge
hashes commutatively! hashes commutatively!
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/