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

Documentation: Moved "Notes" entries into the corresponding "Description" or "Usage"

Browse Source 
This simplifies parsing the headers and ensures the notes are included in the
text they relate to by both Doxygen and foamInfo.
This commit is contained in:
Henry Weller
2022-05-12 09:51:14 +01:00
parent 03211cda95
commit 137a40ef56
97 changed files with 470 additions and 488 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
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
@ -38,7 +38,7 @@ Usage
Specify an alternative geometry scaling factor.
The default is \b 1000 (scale \em [m] to \em [mm]).
Note
Note:
The cellTable information available in the files
\c constant/cellTable and \c constant/polyMesh/cellTableId
will be used if available. Otherwise the cellZones are used when

4
applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
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
@ -42,7 +42,7 @@ Usage
Treat any solid cells present just like fluid cells.
The default is to discard them.
Note
Note:
Baffles are written as interfaces for later use
\*---------------------------------------------------------------------------*/

4
applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ Description
0
\endverbatim
Note
Note:
- for some reason boundary faces point inwards. I just reverse them
always. Might use some geometric check instead.
- marked faces might not actually be boundary faces of mesh.

5
applications/utilities/mesh/generation/extrude2DMesh/extrude2DMesh.C
View File

@ -28,8 +28,9 @@ Description
Takes 2D mesh (all faces 2 points only, no front and back faces) and
creates a 3D mesh by extruding with specified thickness.
Note
Not sure about the walking of the faces to create the front and back faces.
Note:
Not sure about the walking of the faces to create the front and
back faces.
\*---------------------------------------------------------------------------*/

6
applications/utilities/mesh/manipulation/polyDualMesh/polyDualMesh.C
View File

@ -52,9 +52,9 @@ Usage
points on them as features. The -doNotPreserveFaceZones disables this
behaviour.
Note
It is just a driver for meshDualiser. Substitute your own simpleMarkFeatures
to have different behaviour.
Note:
It is just a driver for meshDualiser. Substitute your own
simpleMarkFeatures to have different behaviour.
\*---------------------------------------------------------------------------*/

7
applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
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
@ -49,9 +49,10 @@ Usage
- \par -cellZone zoneName
Specify single cellZone to write (not lagrangian)
Note
Note:
Parallel support for cloud data is not supported
- writes to \a EnSight directory to avoid collisions with foamToEnsightParts
- writes to \a EnSight directory to avoid collisions with
foamToEnsightParts
\*---------------------------------------------------------------------------*/

4
applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
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
@ -52,7 +52,7 @@ Usage
- \par -width \<n\>
Width of Ensight data subdir
Note
Note:
- no parallel data.
- writes to \a Ensight directory to avoid collisions with foamToEnsight.

5
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
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
@ -96,7 +96,7 @@ Usage
- \par -useTimeName
use the time index in the VTK file name instead of the time index
Note
Note:
mesh subset is handled by vtkMesh. Slight inconsistency in
interpolation: on the internal field it interpolates the whole volField
to the whole-mesh pointField and then selects only those values it
@ -105,7 +105,6 @@ Note
fvMeshSubset.interpolate function to directly interpolate the
whole-mesh values onto the subset patch.
Note
\par new file format:
no automatic timestep recognition.
However can have .pvd file format which refers to time simulation

4
applications/utilities/preProcessing/changeDictionary/changeDictionary.C
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
@ -68,7 +68,7 @@ Usage
- \par -disablePatchGroups
Disable the default checking for keys being patchGroups
Note
Note:
changeDictionary has been superseded by foamDictionary
and is now deprecated.

2
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
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-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License

2
applications/utilities/surface/surfaceConvert/surfaceConvert.C
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

4
applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
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
@ -50,7 +50,7 @@ Usage
- \par -tri
Triangulate surface.
Note
Note:
The filename extensions are used to determine the file format type.
\*---------------------------------------------------------------------------*/

4
applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
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
@ -47,7 +47,7 @@ Usage
- \par -keyed
Use keyedSurface for input/output
Note
Note:
The filename extensions are used to determine the file format type.
\*---------------------------------------------------------------------------*/

4
applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
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
@ -51,7 +51,7 @@ Usage
- \par -to \<coordinateSystem\>
Specify a coordinate system when writing files.
Note
Note:
The filename extensions are used to determine the file format type.
\*---------------------------------------------------------------------------*/

4
applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
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
@ -51,7 +51,7 @@ Usage
- \par -to \<coordinateSystem\> \n
Specify a coordinate system when writing files.
Note
Note:
The filename extensions are used to determine the file format type.
\*---------------------------------------------------------------------------*/

4
applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
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
@ -40,7 +40,7 @@ Usage
- \par -xml
Write output in XML format.
Note
Note:
The filename extensions are used to determine the file format type.
The XML-like output can be useful for extraction with other tools,

6
bin/tools/doxyFilter.sed
View File

@ -118,12 +118,6 @@ s/^ //
s/^ //
}
/^Note *$/,/^[^ ]/{
/^Note/c\
\\note
s/^ //
}
/^Warning *$/,/^[^ ]/{
/^Warning/c\

10
src/OSspecific/POSIX/fileMonitor.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,12 +27,12 @@ Class
Description
Checking for changes to files.
Note
Note:
The default is to use stat to get the timestamp.
Compile with FOAM_USE_INOTIFY to use the inotify
(Linux specific, since 2.6.13) framework. The problem is that inotify does
not work on nfs3 mounted directories!!
Compile with FOAM_USE_INOTIFY to use the inotify (Linux specific, since
2.6.13) framework. The problem is that inotify does not work on nfs3
mounted directories!!
SourceFiles
fileMonitor.C

4
src/OSspecific/POSIX/memInfo/memInfo.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Class
Description
Memory usage information for the process running this object.
Note
Note:
Uses the information from /proc/\<pid\>/status
SourceFiles

4
src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.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
@ -31,7 +31,7 @@ Description
The double templating allows for the instantiation of forms with or
without storage management.
Note
Note:
The IDLListType parameter should itself be a template but this confused
gcc 2.95.2 so it has to be instantiated for T when an instantiation of
DictionaryBase is requested

4
src/OpenFOAM/containers/HashTables/HashTable/HashTable.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
@ -27,7 +27,7 @@ Class
Description
An STL-conforming hash table.
Note
Note:
Hashing index collisions are handled via chaining using a singly-linked
list with the colliding entry being added to the head of the linked
list. Thus copying the hash table (or indeed even resizing it) will

4
src/OpenFOAM/containers/HashTables/ListHashTable/ListHashTable.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
@ -27,7 +27,7 @@ Class
Description
STL conforming hash table using contiguous lists rather than linked lists.
Note
Note:
Is slower to insert than the standard HashTable, but should be more
memory efficient and faster to access.

1
src/OpenFOAM/containers/Lists/PackedList/PackedList.H
View File

@ -33,7 +33,6 @@ Description
The number of bits per item is specified by the template parameter nBits.
Note
In a const context, the '[]' operator simply returns the stored value,
with out-of-range elements returned as zero.
In a non-const context, the '[]' operator returns an iteratorBase, which

4
src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.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
@ -55,7 +55,7 @@ Description
c #calc "($a)/$b";
\endverbatim
Note
Note:
Internally this is just a wrapper around codeStream functionality - the
#calc string gets used to construct a dictionary for codeStream.

9
src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.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
@ -76,9 +76,10 @@ Description
- probably some other limitations (uses string::expand which expands
\c \$ and \c ~ sequences)
Note
The code to be compiled is stored under the local \c codeStream directory
with a subdirectory name corresponding to the SHA1 of the contents.
Note:
The code to be compiled is stored under the local \c codeStream
directory with a subdirectory name corresponding to the SHA1 of the
contents.
The corresponding library code is located under the local
\c codeStream/platforms/$WM_OPTIONS/lib directory in a library

2
src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.H
View File

@ -28,7 +28,7 @@ Description
IOdictionary wrapper around OutputFilter to allow them to read from
their associated dictionaries.
Note
Note:
The IOobject or the objectRegistry will normally have to be
derived from a fvMesh for a subsequent cast (within OutputFilter)
to work correctly.

7
src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H
View File

@ -25,12 +25,7 @@ Class
Foam::functionObjects::timeControl
Description
Note
Since the timeIndex is used directly from Foam::Time, it is unaffected
by user-time conversions. For example, Foam::engineTime might cause \a
writeInterval to be degrees crank angle, but the functionObject
execution \a interval would still be in timestep.
General time control for functionObjects
SourceFiles
timeControlFunctionObject.C

4
src/OpenFOAM/global/argList/argList.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
@ -56,7 +56,7 @@ Description
The environment variable \b FOAM_CASENAME is set to the name of the
global case.
Note
Note:
- The document browser used is defined by the \b FOAM_DOC_BROWSER
environment variable or the <tt>Documentation/docBrowser</tt> entry
in the <tt>~OpenFOAM/controlDict</tt> file.

4
src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.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
@ -31,7 +31,7 @@ Description
Addressing arrays must be supplied for the upper and lower triangles.
Note
Note:
It might be better if this class were organised as a hierarchy starting
from an empty matrix, then deriving diagonal, symmetric and asymmetric
matrices.

2
src/OpenFOAM/meshes/MeshObject/MeshObject.H
View File

@ -55,7 +55,7 @@ Description
movePoints
- PatchMeshObject: mesh object to be additionally updated patch changes
Note
Note:
movePoints must be provided for MeshObjects of type MoveableMeshObject
and both movePoints and topoChange functions must exist, provided for
MeshObjects of type UpdateableMeshObject.

10
src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H
View File

@ -58,15 +58,15 @@ Description
- a set of indices which indicate where to get transformed data in the
field
Note
Note:
- compared to 17x nTotalFaces, nTotalPoints do not compensate for
shared points since this would trigger full connectivity analysis
- most calculation is demand driven and uses parallel communication
so make sure to invoke on all processors at the same time
- old sharedEdge calculation: currently an edge is considered shared
if it uses two shared points and is used more than once. This is not
correct on processor patches but it only slightly overestimates the number
of shared edges. Doing full analysis of how many patches use the edge
- old sharedEdge calculation: currently an edge is considered shared if it
uses two shared points and is used more than once. This is not correct
on processor patches but it only slightly overestimates the number of
shared edges. Doing full analysis of how many patches use the edge
would be too complicated
See also

3
src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMap.H
View File

@ -31,7 +31,6 @@ Description
(subXXXMap) and from the received bits to their location in the new
list (constructXXXMap).
Note:
Schedule is a list of processor pairs (one send, one receive. One of
them will be myself) which forms a scheduled (i.e. non-buffered) exchange.
See distribute on how to use it.
@ -117,13 +116,11 @@ Note:
| |
+------+ 0
When constructing from components optionally a 'flip' on
the maps can be specified. This will interpret the map
values as index+flip, similar to e.g. faceProcAddressing. The flip
will only be applied to fieldTypes (scalar, vector, .. triad)
SourceFiles
distributionMap.C
distributionMapTemplates.C

2
src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMapBase.H
View File

@ -31,7 +31,6 @@ Description
(subXXXMap) and from the received bits to their location in the new
list (constructXXXMap).
Note:
Schedule is a list of processor pairs (one send, one receive. One of
them will be myself) which forms a scheduled (i.e. non-buffered) exchange.
See distribute on how to use it.
@ -60,7 +59,6 @@ Note:
values as index+flip, similar to e.g. faceProcAddressing. The flip
will only be applied to fieldTypes (scalar, vector, .. triad)
SourceFiles
distributionMapBase.C
distributionMapBaseTemplates.C

4
src/OpenFOAM/meshes/polyMesh/polyPatches/basic/generic/genericPolyPatch.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
Substitute for unknown patches. Used for postprocessing when only
basic polyPatch info is needed.
Note
Note:
Storage is not optimal. It stores all face centres and cells on all
processors to keep the addressing calculation simple.

4
src/OpenFOAM/primitives/nil/nil.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
@ -27,7 +27,7 @@ Class
Description
A zero-sized class without any storage. Used, for example, in HashSet.
Note
Note:
A zero-sized class actually does still require at least 1 byte storage.
\*---------------------------------------------------------------------------*/

4
src/OpenFOAM/primitives/strings/lists/wordReListMatcher.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
@ -27,7 +27,7 @@ Class
Description
A wrapper for matching a List of wordRe.
Note
Note:
The constructor should remain non-explicit. This allows automatic
conversion from UList\<wordRe\> to wordReListMatcher in search
functions.

4
src/OpenFOAM/primitives/strings/wordRe/wordRe.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
@ -37,7 +37,7 @@ Description
Foam::wordRe (preserve the same type) or from a Foam::word (always
literal).
Note
Note:
If the string contents are changed - eg, by the operator+=() or by
string::replace(), etc - it will be necessary to use compile() or
recompile() to synchronise the regular expression.

6
src/Pstream/mpi/UPstream.C
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
@ -21,10 +21,6 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Note
The const_cast used in this file is a temporary hack for to work around
bugs in OpenMPI for versions < 1.7.4
\*---------------------------------------------------------------------------*/
#include "UPstream.H"

5
src/conversion/meshReader/meshReader.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
@ -27,7 +27,6 @@ Namespace
Description
A namespace for holding various types of mesh readers.
Class
Foam::meshReader
@ -41,7 +40,7 @@ Description
The meshReader supports cellTable information (see new user's guide entry).
Note
Note:
The boundary definitions are given as cell/face.
SourceFiles

4
src/dynamicMesh/motionSmoother/motionSmoother.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -50,7 +50,7 @@ Description
}
\endverbatim
Note
Note:
- Shared points (parallel): a processor can have points which are part of
pp on another processor but have no pp itself (i.e. it has points
and/or edges but no faces of pp). Hence we have to be careful when e.g.

2
src/dynamicMesh/motionSmoother/motionSmootherAlgo.H
View File

@ -50,7 +50,7 @@ Description
}
\endverbatim
Note
Note:
- Shared points (parallel): a processor can have points which are part of
pp on another processor but have no pp itself (i.e. it has points
and/or edges but no faces of pp). Hence we have to be careful when e.g.

4
src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.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
@ -53,7 +53,7 @@ Usage
refGrad | patch normal gradient | yes |
\endtable
Note
Note:
This condition is not usually applied directly; instead, use a derived
mixed condition such as \c inletOutlet

4
src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.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
@ -37,7 +37,7 @@ Usage
}
\endverbatim
Note
Note:
The patches must be topologically similar, i.e. if the owner patch is
transformed to the neighbour patch, the patches should be identical (or
very similar).

4
src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.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
@ -38,7 +38,7 @@ Usage
}
\endverbatim
Note
Note:
The outer boundary of the patch pairs must be similar, i.e. if the owner
patch is transformed to the neighbour patch, the outer perimeter of each
patch should be identical (or very similar).

4
src/finiteVolume/fields/fvPatchFields/constraint/cyclicRepeatAMI/cyclicRepeatAMIFvPatchField.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) 2018-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -38,7 +38,7 @@ Usage
}
\endverbatim
Note
Note:
The outer boundary of the patch pairs must be similar, i.e. if the owner
patch is transformed to the neighbour patch, the outer perimeter of each
patch should be identical (or very similar).

4
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.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
@ -64,7 +64,7 @@ Usage
}
\endverbatim
Note
Note:
If \c lInf is specified, \c fieldInf will be required; \c rho is only
required in the case of a mass-based flux.

4
src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.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
@ -52,7 +52,7 @@ Usage
}
\endverbatim
Note
Note:
The \c axialVelocity, \c radialVelocity and \c rpm entries are Function1
types, able to describe time varying functions. The example above gives
the usage for supplying constant values.

4
src/finiteVolume/fields/fvPatchFields/derived/fanPressureJump/fanPressureJumpFvPatchScalarField.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
@ -73,7 +73,7 @@ Usage
The above example shows the use of a comma separated (CSV) file to specify
the jump condition.
Note
Note:
The underlying \c patchType should be set to \c cyclic
See also

4
src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValue/fixedInternalValueFvPatchField.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
@ -39,7 +39,7 @@ Usage
}
\endverbatim
Note
Note:
This is used as a base for conditions such as the turbulence \c epsilon
wall function, which applies a near-wall constraint for high Reynolds
number flows.

4
src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.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
@ -50,7 +50,7 @@ Usage
The above example shows the use of a fixed jump of '10'.
Note
Note:
The underlying \c patchType should be set to \c cyclic
See also

4
src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.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) 2012-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -50,7 +50,7 @@ Usage
The above example shows the use of a fixed jump of '10'.
Note
Note:
The underlying \c patchType should be set to \c cyclicAMI
See also

2
src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
View File

@ -92,7 +92,7 @@ Usage
Foam::Function1s::turbulentBL have been created specifically for this
purpose and are likely to be appropriate for most cases.
Note
Note:
- \c rhoInlet is required for the case of a mass flow rate, where the
density field is not available at start-up
- The value is positive into the domain (as an inlet)

4
src/finiteVolume/fields/fvPatchFields/derived/flowRateOutletVelocity/flowRateOutletVelocityFvPatchVectorField.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) 2017-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -70,7 +70,7 @@ Usage
The \c flowRate entry is a \c Function1 of time, see Foam::Function1s.
Note
Note:
- \c rhoOutlet is required for the case of a mass flow rate, where the
density field is not available at start-up
- The value is positive out of the domain (as an outlet)

4
src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.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
@ -61,7 +61,7 @@ Description
}
\endverbatim
Note
Note:
If reverse flow is possible or expected use the
pressureInletOutletVelocity condition instead.

7
src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.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
@ -48,8 +48,9 @@ Usage
}
\endverbatim
Note
This condition is designed to operate with a freestreamVelocity condition
Note:
This condition is designed to operate with a freestreamVelocity
condition
See also
Foam::mixedFvPatchField

7
src/finiteVolume/fields/fvPatchFields/derived/freestreamVelocity/freestreamVelocityFvPatchVectorField.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) 2018-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,8 +46,9 @@ Usage
}
\endverbatim
Note
This condition is designed to operate with the freestreamPressure condition
Note:
This condition is designed to operate with the freestreamPressure
condition
See also
Foam::mixedFvPatchField

2
src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
View File

@ -49,7 +49,7 @@ Usage
The mode of operation is determined by the sign of the flux across the
patch faces.
Note
Note:
Sign conventions:
- Positive flux (out of domain): apply zero-gradient condition
- Negative flux (into of domain): apply the "inletValue" fixed-value

12
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.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
@ -49,12 +49,12 @@ Usage
}
\endverbatim
Note
Note:
Since this condition can be applied on a per-field and per-patch basis,
it is possible to duplicate the mapping information. If possible, employ
the \c mapped condition in preference to avoid this situation, and only
employ this condition if it is not possible to change the underlying
geometric (poly) patch type to \c mapped.
it is possible to duplicate the mapping information. If possible,
employ the \c mapped condition in preference to avoid this situation,
and only employ this condition if it is not possible to change the
underlying geometric (poly) patch type to \c mapped.
See also
Foam::mappedPatchBase

4
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.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
@ -47,7 +47,7 @@ Usage
}
\endverbatim
Note
Note:
This boundary condition can only be applied to patches that are of
the \c mappedPolyPatch type.

4
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.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
@ -61,7 +61,7 @@ Usage
boundary faces and both faces sample into the cell, both faces will get the
same value.
Note
Note:
It is not possible to sample internal faces since volume fields are not
defined on faces.

4
src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.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
@ -47,7 +47,7 @@ Usage
The underlying sample mode should be set to \c nearestPatchFace or
\c nearestFace
Note
Note:
This boundary condition can only be applied to patches that are of
the \c mappedPolyPatch type.

4
src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.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
@ -49,7 +49,7 @@ Usage
The mode of operation is determined by the sign of the flux across the
patch faces.
Note
Note:
Sign conventions:
- Positive flux (out of domain): apply the "outletValue" fixed-value
- Negative flux (into of domain): apply zero-gradient condition

4
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.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
@ -50,7 +50,7 @@ Usage
}
\endverbatim
Note
Note:
Sign conventions:
- positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): derive from the flux with specified

5
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.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
@ -49,11 +49,10 @@ Usage
}
\endverbatim
Note
Note:
If reverse flow is possible or expected use the
pressureDirectedInletOutletVelocityFvPatchVectorField condition instead.
See also
Foam::fixedValueFvPatchField
Foam::pressureDirectedInletOutletVelocityFvPatchVectorField

4
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.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
@ -48,7 +48,7 @@ Usage
}
\endverbatim
Note
Note:
Sign conventions:
- positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): derive from the flux with specified

4
src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.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
@ -41,7 +41,7 @@ Usage
}
\endverbatim
Note
Note:
If reverse flow is possible or expected use
the pressureInletOutletVelocityFvPatchVectorField condition instead.

4
src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.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
@ -48,7 +48,7 @@ Usage
}
\endverbatim
Note
Note:
Sign conventions:
- positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): derive from the flux and patch-normal

4
src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.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
@ -52,7 +52,7 @@ Usage
The \c omega entry is a Function1 type, able to describe time varying
functions.
Note
Note:
Sign conventions:
- positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): derive from the flux in the patch-normal

4
src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.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
@ -57,7 +57,7 @@ Usage
}
\endverbatim
Note
Note:
This boundary condition is ill-posed if the free-stream flow is normal
to the boundary.

4
src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.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
@ -45,7 +45,7 @@ Usage
}
\endverbatim
Note
Note:
Sign conventions:
- the value is positive for outward-pointing vectors

4
src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalUniformFixedValue/surfaceNormalUniformFixedValueFvPatchVectorField.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) 2019-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2019-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,7 +45,7 @@ Usage
}
\endverbatim
Note
Note:
Sign conventions:
- the value is positive for outward-pointing vectors

4
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.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
@ -55,7 +55,7 @@ Usage
}
\endverbatim
Note
Note:
- the \c flowRate and \c rpm entries are Function1 types, able to describe
time varying functions. The example above gives the usage for supplying
constant values.

10
src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.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) 2017-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -52,10 +52,10 @@ Usage
}
\endverbatim
Note
The \c axialVelocity, \c radialVelocity and \c tangentialVelocity entries
are Function1 types, able to describe time varying functions. The example
above gives the usage for supplying constant values.
Note:
The \c axialVelocity, \c radialVelocity and \c tangentialVelocity
entries are Function1 types, able to describe time varying functions.
The example above gives the usage for supplying constant values.
See also
Foam::fixedValueFvPatchField

4
src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -42,7 +42,7 @@ Usage
}
\endverbatim
Note
Note:
The uniformGradient entry is a Function1 type, able to describe time
varying functions. The example above gives the usage for supplying a
constant value.

4
src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.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
@ -42,7 +42,7 @@ Usage
}
\endverbatim
Note
Note:
The uniformValue entry is a Function1 type, able to describe time
varying functions. The example above gives the usage for supplying a
constant value.

4
src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ Usage
The mode of operation is determined by the sign of the flux across the
patch faces.
Note
Note:
Sign conventions:
- positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): apply the user-specified fixed value

4
src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.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) 2012-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ Usage
The above example shows the use of a fixed jump of '10'.
Note
Note:
The uniformValue entry is a Function1 type, able to describe time
varying functions. The example above gives the usage for supplying a
constant value.

4
src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.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) 2012-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ Usage
The above example shows the use of a fixed jump of '10'.
Note
Note:
The uniformValue entry is a Function1 type, able to describe time
varying functions. The example above gives the usage for supplying a
constant value.

4
src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.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
@ -51,7 +51,7 @@ Usage
The \c flowRate entry is a \c Function1 of time, see Foam::Function1s.
Note
Note:
- the value is positive into the domain
- may not work correctly for transonic inlets
- strange behaviour with potentialFoam since the momentum equation is

6
src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H
View File

@ -71,9 +71,9 @@ Description
interFoam family of solvers. Boundedness cannot be guaranteed with the
backward scheme.
Note
The Crank-Nicolson coefficient for the implicit part of the RHS is related
to the off-centering coefficient by
Note:
The Crank-Nicolson coefficient for the implicit part of the RHS
is related to the off-centering coefficient by
\verbatim
cnCoeff = 1.0/(1.0 + ocCoeff);
\endverbatim

2
src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H
View File

@ -31,7 +31,7 @@ Description
factor. The factor applies to the first scheme and 1-factor to the
second scheme.
Note
Note:
Although a blending factor of 0 and 1 is permitted, it is more efficient
just to use the underlying scheme directly.

5
src/mesh/blockMesh/blockMesh/blockMesh.H
View File

@ -27,8 +27,9 @@ Class
Description
A multi-block mesh generator
Note
The vertices, cells and patches for filling the blocks are demand-driven.
Note:
The vertices, cells and patches for filling the blocks are
demand-driven.
SourceFiles
blockMesh.C

4
src/mesh/blockMesh/blocks/block/block.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
Creates a single block of cells from point coordinates, numbers of
cells in each direction and an expansion ratio.
Note
Note:
The vertices and cells for filling the block are demand-driven.
SourceFiles

4
src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.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
@ -27,7 +27,7 @@ Class
Description
Provide a means of reading/writing the single-file OpenFOAM edge format.
Note
Note:
This class provides more methods than the regular edge format interface.
SourceFiles

4
src/meshTools/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Class
Description
Read/write the lines from pro-STAR vrt/cel files.
Note
Note:
Uses the extension \a .inp (input) to denote the format.
See also

3
src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H
View File

@ -69,8 +69,7 @@ Description
Note: if offsetMode is \c normal it uses outwards pointing normals. So
supply a negative distance if sampling inside the domain.
Note
Note:
Storage is not optimal. It temporary collects all (patch)face centres
on all processors to keep the addressing calculation simple.

2
src/meshTools/mappedPatches/mappedPolyPatch/mappedPolyPatch.H
View File

@ -28,7 +28,7 @@ Description
Determines a mapping between patch face centres and mesh cell or face
centres and processors they're on.
Note
Note:
Storage is not optimal. It stores all face centres and cells on all
processors to keep the addressing calculation simple.

2
src/meshTools/mappedPatches/mappedPolyPatch/mappedWallPolyPatch.H
View File

@ -28,7 +28,7 @@ Description
Determines a mapping between patch face centres and mesh cell or face
centres and processors they're on.
Note
Note:
Storage is not optimal. It stores all face centres and cells on all
processors to keep the addressing calculation simple.

4
src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.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
@ -41,7 +41,7 @@ Description
Used to easily insert cuts and split faces.
Note
Note:
- points with surface (local)points first, intersection points last
- edges with (split) surface edges first, intersection edges last.

4
src/surfMesh/surfaceFormats/ac3d/AC3DsurfaceFormat.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
@ -29,7 +29,7 @@ Description
http://www.inivis.com/ac3d/man/ac3dfileformat.html
Note
Note:
On input, the faces are already organised as zones.
The output is always sorted by zones.
In the absence of zones, a single zone will be assigned.

4
src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ See also
file format information:
http://www.geomview.org/docs/html/OFF.html#OFF
Note
Note:
When reading, the optional \a colorspec is ignored.
When writing, it is set to the zone number (integer).

7
src/surfMesh/surfaceFormats/ofs/OFSsurfaceFormat.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,8 +27,9 @@ Class
Description
Provide a means of reading/writing the single-file OpenFOAM surface format.
Note
This class provides more methods than the regular surface format interface.
Note:
This class provides more methods than the regular surface format
interface.
SourceFiles
OFSsurfaceFormat.C

4
src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Class
Description
Read/write the surface shells from pro-STAR vrt/cel files.
Note
Note:
Uses the extension \a .inp (input) to denote the format.
See also

4
src/surfMesh/surfaceFormats/stl/STLsurfaceFormat.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
@ -27,7 +27,7 @@ Class
Description
Provide a means of reading/writing STL files (ASCII and binary).
Note
Note:
For efficiency, the zones are sorted before creating the faces.
The class is thus derived from MeshedSurface.

4
src/surfMesh/surfaceFormats/tri/TRIsurfaceFormat.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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,7 +27,7 @@ Class
Description
Provide a means of reading/writing .tri format.
Note
Note:
For efficiency, the zones are sorted before creating the faces.
The class is thus derived from MeshedSurface.