diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C index a4bb4e6b30..e89b3e2931 100644 --- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C +++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C @@ -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,11 +38,11 @@ Usage Specify an alternative geometry scaling factor. The default is \b 1000 (scale \em [m] to \em [mm]). -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 - creating the cellTable information. + 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 + creating the cellTable information. See also Foam::cellTable, Foam::meshWriter and Foam::meshWriters::STARCD diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C index 5c712c3117..e04f3bf4e2 100644 --- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C +++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C @@ -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,8 +42,8 @@ Usage Treat any solid cells present just like fluid cells. The default is to discard them. -Note - Baffles are written as interfaces for later use + Note: + Baffles are written as interfaces for later use \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C index 1e57763b44..b5b4db1e62 100644 --- a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C +++ b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C @@ -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,12 +54,12 @@ Description 0 \endverbatim -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. - This is hopefully handled now by first constructing without boundaries - and then reconstructing with boundary faces. + 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. + This is hopefully handled now by first constructing without boundaries + and then reconstructing with boundary faces. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C index 055b9871e1..5c306d51d7 100644 --- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C +++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C @@ -104,11 +104,11 @@ becomes CCC=polypatch -Notes: - - when extruding cyclics with only one cell in between it does not - detect this as a cyclic since the face is the same face. It will - only work if the coupled edge extrudes a different face so if there - are more than 1 cell in between. + Notes: + - when extruding cyclics with only one cell in between it does not + detect this as a cyclic since the face is the same face. It will + only work if the coupled edge extrudes a different face so if there + are more than 1 cell in between. \endverbatim diff --git a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMesh.C b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMesh.C index 4e21580c87..7b280143b1 100644 --- a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMesh.C +++ b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMesh.C @@ -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. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMesh.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMesh.C index d2559840b6..fb0f0e2ed2 100644 --- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMesh.C +++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMesh.C @@ -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. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C index 14326151ba..be7288d32d 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C @@ -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 - Parallel support for cloud data is not supported - - writes to \a EnSight directory to avoid collisions with foamToEnsightParts + Note: + Parallel support for cloud data is not supported + - writes to \a EnSight directory to avoid collisions with + foamToEnsightParts \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C index 603bf450dd..5e4affcd88 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C @@ -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,9 +52,9 @@ Usage - \par -width \ Width of Ensight data subdir -Note - - no parallel data. - - writes to \a Ensight directory to avoid collisions with foamToEnsight. + Note: + - no parallel data. + - writes to \a Ensight directory to avoid collisions with foamToEnsight. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C index 7e547c2761..2439d8a8c3 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C @@ -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,41 +96,40 @@ Usage - \par -useTimeName use the time index in the VTK file name instead of the time index -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 - needs for the subMesh (using the fvMeshSubset cellMap(), pointMap() - functions). For the patches however it uses the - fvMeshSubset.interpolate function to directly interpolate the - whole-mesh values onto the subset patch. + 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 + needs for the subMesh (using the fvMeshSubset cellMap(), pointMap() + functions). For the patches however it uses the + 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 - if XML *.vtu files are available: + \par new file format: + no automatic timestep recognition. + However can have .pvd file format which refers to time simulation + if XML *.vtu files are available: - \verbatim - - - - - - - - - - - - - - - - \endverbatim + \verbatim + + + + + + + + + + + + + + + + \endverbatim \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C index 60b12cda49..a02f3d8aab 100644 --- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C +++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C @@ -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,9 +68,9 @@ Usage - \par -disablePatchGroups Disable the default checking for keys being patchGroups -Note - changeDictionary has been superseded by foamDictionary - and is now deprecated. + Note: + changeDictionary has been superseded by foamDictionary + and is now deprecated. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C index 915529c970..1421fad639 100644 --- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C +++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C @@ -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 @@ -37,9 +37,9 @@ Description the patch geometry (points and faces) for the coupled patches are output to the communications directory. -Note: - The addressing is patch-local, i.e. point indices for each patch point - used for face addressing starts at index 0. + Note: + The addressing is patch-local, i.e. point indices for each patch point + used for face addressing starts at index 0. See also externalCoupledMixedFvPatchField diff --git a/applications/utilities/surface/surfaceConvert/surfaceConvert.C b/applications/utilities/surface/surfaceConvert/surfaceConvert.C index 18fd7f111f..47070f0ff4 100644 --- a/applications/utilities/surface/surfaceConvert/surfaceConvert.C +++ b/applications/utilities/surface/surfaceConvert/surfaceConvert.C @@ -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,8 +40,8 @@ Usage - \par -group Orders faces by region -Note - The filename extensions are used to determine the file format type. + Note + The filename extensions are used to determine the file format type. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C index 47f543b521..186178ac3e 100644 --- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C +++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C @@ -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,8 +50,8 @@ Usage - \par -tri Triangulate surface. -Note - The filename extensions are used to determine the file format type. + Note: + The filename extensions are used to determine the file format type. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C index 0d6ebb917c..4bb7f9f35c 100644 --- a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C +++ b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C @@ -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,8 +47,8 @@ Usage - \par -keyed Use keyedSurface for input/output -Note - The filename extensions are used to determine the file format type. + Note: + The filename extensions are used to determine the file format type. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C index 07107add68..b59af0db65 100644 --- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C +++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C @@ -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,8 +51,8 @@ Usage - \par -to \ Specify a coordinate system when writing files. -Note - The filename extensions are used to determine the file format type. + Note: + The filename extensions are used to determine the file format type. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C index 63bebc740f..afc391d09c 100644 --- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C +++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C @@ -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,8 +51,8 @@ Usage - \par -to \ \n Specify a coordinate system when writing files. -Note - The filename extensions are used to determine the file format type. + Note: + The filename extensions are used to determine the file format type. \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C index 232ba1667e..9418a016dd 100644 --- a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C +++ b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C @@ -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,19 +40,19 @@ Usage - \par -xml Write output in XML format. -Note - The filename extensions are used to determine the file format type. + Note: + The filename extensions are used to determine the file format type. - The XML-like output can be useful for extraction with other tools, - but either output format can be easily extracted with a simple sed - command: - \verbatim - surfaceMeshInfo surfaceFile -areas | \ - sed -ne '/areas/,/:/{ /:/!p }' + The XML-like output can be useful for extraction with other tools, + but either output format can be easily extracted with a simple sed + command: + \verbatim + surfaceMeshInfo surfaceFile -areas | \ + sed -ne '/areas/,/:/{ /:/!p }' - surfaceMeshInfo surfaceFile -areas -xml | \ - sed -ne '//status + Note: + Uses the information from /proc/\/status SourceFiles memInfo.C diff --git a/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H b/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H index c67f258455..252c6d0b1a 100644 --- a/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H +++ b/src/OpenFOAM/containers/Dictionaries/DictionaryBase/DictionaryBase.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,10 +31,10 @@ Description The double templating allows for the instantiation of forms with or without storage management. -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 + 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 See also Dictionary and UDictionary diff --git a/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H b/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H index 05fd5f89da..589b285cd9 100644 --- a/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H +++ b/src/OpenFOAM/containers/HashTables/HashTable/HashTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,12 +27,12 @@ Class Description An STL-conforming hash table. -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 - often result in a different hash order. Use a sorted table-of-contents - when the hash order is important. + 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 + often result in a different hash order. Use a sorted table-of-contents + when the hash order is important. SourceFiles HashTableI.H diff --git a/src/OpenFOAM/containers/HashTables/ListHashTable/ListHashTable.H b/src/OpenFOAM/containers/HashTables/ListHashTable/ListHashTable.H index 2e9047487a..8871ed9a3a 100644 --- a/src/OpenFOAM/containers/HashTables/ListHashTable/ListHashTable.H +++ b/src/OpenFOAM/containers/HashTables/ListHashTable/ListHashTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,9 +27,9 @@ Class Description STL conforming hash table using contiguous lists rather than linked lists. -Note - Is slower to insert than the standard HashTable, but should be more - memory efficient and faster to access. + Note: + Is slower to insert than the standard HashTable, but should be more + memory efficient and faster to access. SourceFiles ListHashTableI.H diff --git a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H index 94a067bae4..f46dc6832a 100644 --- a/src/OpenFOAM/containers/Lists/PackedList/PackedList.H +++ b/src/OpenFOAM/containers/Lists/PackedList/PackedList.H @@ -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 diff --git a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H index 0f73fcb75d..714b3f141d 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,9 +55,9 @@ Description c #calc "($a)/$b"; \endverbatim -Note - Internally this is just a wrapper around codeStream functionality - the - #calc string gets used to construct a dictionary for codeStream. + Note: + Internally this is just a wrapper around codeStream functionality - the + #calc string gets used to construct a dictionary for codeStream. SourceFiles calcEntry.C diff --git a/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H b/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H index 4e1d580471..bbcf0da857 100644 --- a/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H +++ b/src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -76,13 +76,14 @@ 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 - \c libcodeStream_SHA1.so + The corresponding library code is located under the local + \c codeStream/platforms/$WM_OPTIONS/lib directory in a library + \c libcodeStream_SHA1.so SourceFiles codeStream.C diff --git a/src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.H b/src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.H index 247db7bdb5..bfe8001188 100644 --- a/src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.H +++ b/src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.H @@ -28,10 +28,10 @@ Description IOdictionary wrapper around OutputFilter to allow them to read from their associated dictionaries. -Note - The IOobject or the objectRegistry will normally have to be - derived from a fvMesh for a subsequent cast (within OutputFilter) - to work correctly. + Note: + The IOobject or the objectRegistry will normally have to be + derived from a fvMesh for a subsequent cast (within OutputFilter) + to work correctly. SourceFiles IOOutputFilter.C diff --git a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H index 9522760cc7..3f55b29aed 100644 --- a/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H +++ b/src/OpenFOAM/db/functionObjects/timeControl/timeControlFunctionObject.H @@ -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 diff --git a/src/OpenFOAM/global/argList/argList.H b/src/OpenFOAM/global/argList/argList.H index 3fef6002ae..04082bc36d 100644 --- a/src/OpenFOAM/global/argList/argList.H +++ b/src/OpenFOAM/global/argList/argList.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -56,16 +56,16 @@ Description The environment variable \b FOAM_CASENAME is set to the name of the global case. -Note - - The document browser used is defined by the \b FOAM_DOC_BROWSER - environment variable or the Documentation/docBrowser entry - in the ~OpenFOAM/controlDict file. - The \%f token is used as a placeholder for the file name. - - The valid (mandatory) arguments can be adjusted - by directly manipulating the argList::validArgs static member. - - The valid options can be adjusted - via the addOption/removeOption static methods instead of directly - manipulating the argList::validOptions static member. + Note: + - The document browser used is defined by the \b FOAM_DOC_BROWSER + environment variable or the Documentation/docBrowser entry + in the ~OpenFOAM/controlDict file. + The \%f token is used as a placeholder for the file name. + - The valid (mandatory) arguments can be adjusted + by directly manipulating the argList::validArgs static member. + - The valid options can be adjusted + via the addOption/removeOption static methods instead of directly + manipulating the argList::validOptions static member. SourceFiles argList.C diff --git a/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H b/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H index 69df19c03f..7e7734d4a1 100644 --- a/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H +++ b/src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,10 +31,10 @@ Description Addressing arrays must be supplied for the upper and lower triangles. -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. + 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. SourceFiles LduMatrixATmul.C diff --git a/src/OpenFOAM/meshes/MeshObject/MeshObject.H b/src/OpenFOAM/meshes/MeshObject/MeshObject.H index fc41065b36..0b8d38c0ba 100644 --- a/src/OpenFOAM/meshes/MeshObject/MeshObject.H +++ b/src/OpenFOAM/meshes/MeshObject/MeshObject.H @@ -55,10 +55,10 @@ Description movePoints - PatchMeshObject: mesh object to be additionally updated patch changes -Note - movePoints must be provided for MeshObjects of type MoveableMeshObject - and both movePoints and topoChange functions must exist, provided for - MeshObjects of type UpdateableMeshObject. + Note: + movePoints must be provided for MeshObjects of type MoveableMeshObject + and both movePoints and topoChange functions must exist, provided for + MeshObjects of type UpdateableMeshObject. SourceFiles MeshObject.C diff --git a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H index c979a5ab6e..5edbbbd7c5 100644 --- a/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H +++ b/src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H @@ -58,16 +58,16 @@ Description - a set of indices which indicate where to get transformed data in the field -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 - would be too complicated + 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 + would be too complicated See also distributionMap diff --git a/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMap.H b/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMap.H index 0d30d2b5f9..02036b8960 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMap.H +++ b/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMap.H @@ -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 diff --git a/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMapBase.H b/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMapBase.H index eb87084593..8241284a27 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMapBase.H +++ b/src/OpenFOAM/meshes/polyMesh/polyDistributionMap/distributionMapBase.H @@ -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 diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/generic/genericPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/generic/genericPolyPatch.H index 81cc993f47..18a4164e8f 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/generic/genericPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/generic/genericPolyPatch.H @@ -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,9 +28,9 @@ Description Substitute for unknown patches. Used for postprocessing when only basic polyPatch info is needed. -Note - Storage is not optimal. It stores all face centres and cells on all - processors to keep the addressing calculation simple. + Note: + Storage is not optimal. It stores all face centres and cells on all + processors to keep the addressing calculation simple. SourceFiles genericPolyPatch.C diff --git a/src/OpenFOAM/primitives/nil/nil.H b/src/OpenFOAM/primitives/nil/nil.H index 3284b1c743..0bfb39ccc4 100644 --- a/src/OpenFOAM/primitives/nil/nil.H +++ b/src/OpenFOAM/primitives/nil/nil.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,8 +27,8 @@ Class Description A zero-sized class without any storage. Used, for example, in HashSet. -Note - A zero-sized class actually does still require at least 1 byte storage. + Note: + A zero-sized class actually does still require at least 1 byte storage. \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/primitives/strings/lists/wordReListMatcher.H b/src/OpenFOAM/primitives/strings/lists/wordReListMatcher.H index 97269c57ad..7ef25b5cdf 100644 --- a/src/OpenFOAM/primitives/strings/lists/wordReListMatcher.H +++ b/src/OpenFOAM/primitives/strings/lists/wordReListMatcher.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,10 +27,10 @@ Class Description A wrapper for matching a List of wordRe. -Note - The constructor should remain non-explicit. This allows automatic - conversion from UList\ to wordReListMatcher in search - functions. + Note: + The constructor should remain non-explicit. This allows automatic + conversion from UList\ to wordReListMatcher in search + functions. SourceFiles wordReListMatcherI.H diff --git a/src/OpenFOAM/primitives/strings/wordRe/wordRe.H b/src/OpenFOAM/primitives/strings/wordRe/wordRe.H index 5501c3e8b1..fef35a8d37 100644 --- a/src/OpenFOAM/primitives/strings/wordRe/wordRe.H +++ b/src/OpenFOAM/primitives/strings/wordRe/wordRe.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -37,10 +37,10 @@ Description Foam::wordRe (preserve the same type) or from a Foam::word (always literal). -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. + 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. SourceFiles wordRe.C diff --git a/src/Pstream/mpi/UPstream.C b/src/Pstream/mpi/UPstream.C index ecc20b14b3..03433b3985 100644 --- a/src/Pstream/mpi/UPstream.C +++ b/src/Pstream/mpi/UPstream.C @@ -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 . -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" diff --git a/src/conversion/meshReader/meshReader.H b/src/conversion/meshReader/meshReader.H index 5da6998853..46ccc88d8c 100644 --- a/src/conversion/meshReader/meshReader.H +++ b/src/conversion/meshReader/meshReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,6 @@ Namespace Description A namespace for holding various types of mesh readers. - Class Foam::meshReader @@ -41,8 +40,8 @@ Description The meshReader supports cellTable information (see new user's guide entry). -Note - The boundary definitions are given as cell/face. + Note: + The boundary definitions are given as cell/face. SourceFiles calcPointCells.C diff --git a/src/dynamicMesh/motionSmoother/motionSmoother.H b/src/dynamicMesh/motionSmoother/motionSmoother.H index 9eb21ea309..5b65605a7d 100644 --- a/src/dynamicMesh/motionSmoother/motionSmoother.H +++ b/src/dynamicMesh/motionSmoother/motionSmoother.H @@ -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,22 +50,22 @@ Description } \endverbatim -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. - synchronising displacements that the value from the processor which has - faces of pp get priority. This is currently handled in setDisplacement - by resetting the internal displacement to zero before doing anything - else. The combine operator used will give preference to non-zero - values. + 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. + synchronising displacements that the value from the processor which has + faces of pp get priority. This is currently handled in setDisplacement + by resetting the internal displacement to zero before doing anything + else. The combine operator used will give preference to non-zero + values. - - Various routines take baffles. These are sets of boundary faces that - are treated as a single internal face. This is a hack used to apply - movement to internal faces. + - Various routines take baffles. These are sets of boundary faces that + are treated as a single internal face. This is a hack used to apply + movement to internal faces. - - Mesh constraints are looked up from the supplied dictionary. (uses - recursive lookup) + - Mesh constraints are looked up from the supplied dictionary. (uses + recursive lookup) SourceFiles motionSmoother.C diff --git a/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H b/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H index 5b8ad056a9..d77e7453d3 100644 --- a/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H +++ b/src/dynamicMesh/motionSmoother/motionSmootherAlgo.H @@ -50,22 +50,22 @@ Description } \endverbatim -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. - synchronising displacements that the value from the processor which has - faces of pp get priority. This is currently handled in setDisplacement - by resetting the internal displacement to zero before doing anything - else. The combine operator used will give preference to non-zero - values. + 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. + synchronising displacements that the value from the processor which has + faces of pp get priority. This is currently handled in setDisplacement + by resetting the internal displacement to zero before doing anything + else. The combine operator used will give preference to non-zero + values. - - Various routines take baffles. These are sets of boundary faces that - are treated as a single internal face. This is a hack used to apply - movement to internal faces. + - Various routines take baffles. These are sets of boundary faces that + are treated as a single internal face. This is a hack used to apply + movement to internal faces. - - Mesh constraints are looked up from the supplied dictionary. (uses - recursive lookup) + - Mesh constraints are looked up from the supplied dictionary. (uses + recursive lookup) SourceFiles motionSmootherAlgo.C diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index fd2ca1fc1d..c895ad0077 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -53,9 +53,9 @@ Usage refGrad | patch normal gradient | yes | \endtable -Note - This condition is not usually applied directly; instead, use a derived - mixed condition such as \c inletOutlet + Note: + This condition is not usually applied directly; instead, use a derived + mixed condition such as \c inletOutlet See also Foam::inletOutletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 5217c612ce..5bfc89a39b 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -37,10 +37,10 @@ Usage } \endverbatim -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). + 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). SourceFiles cyclicFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index 1923e7ffc0..a1de2e845e 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -38,10 +38,10 @@ Usage } \endverbatim -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). + 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). See also Foam::AMIInterpolation diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicRepeatAMI/cyclicRepeatAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicRepeatAMI/cyclicRepeatAMIFvPatchField.H index b57aeff1a2..8608114165 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicRepeatAMI/cyclicRepeatAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicRepeatAMI/cyclicRepeatAMIFvPatchField.H @@ -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,10 +38,10 @@ Usage } \endverbatim -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). + 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). See also Foam::AMIInterpolation diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index b2a19860bb..953293adad 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -64,9 +64,9 @@ Usage } \endverbatim -Note - If \c lInf is specified, \c fieldInf will be required; \c rho is only - required in the case of a mass-based flux. + Note: + If \c lInf is specified, \c fieldInf will be required; \c rho is only + required in the case of a mass-based flux. SourceFiles advectiveFvPatchField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 942c0f7b75..cbdaefe7bd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -52,10 +52,10 @@ Usage } \endverbatim -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. + 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. See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressureJump/fanPressureJumpFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressureJump/fanPressureJumpFvPatchScalarField.H index cd58f0129d..8981245a64 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressureJump/fanPressureJumpFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressureJump/fanPressureJumpFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -73,8 +73,8 @@ Usage The above example shows the use of a comma separated (CSV) file to specify the jump condition. -Note - The underlying \c patchType should be set to \c cyclic + Note: + The underlying \c patchType should be set to \c cyclic See also Foam::Function1s diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValue/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValue/fixedInternalValueFvPatchField.H index 1d03ad23e2..af592d8975 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValue/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValue/fixedInternalValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -39,10 +39,10 @@ Usage } \endverbatim -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. + 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. See also Foam::epsilonWallFunctionFvPatchScalarField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index b78ac3999a..578b45d7be 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -50,8 +50,8 @@ Usage The above example shows the use of a fixed jump of '10'. -Note - The underlying \c patchType should be set to \c cyclic + Note: + The underlying \c patchType should be set to \c cyclic See also Foam::jumpCyclicFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H index ac3e29213e..34ceb01eb7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H @@ -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,8 +50,8 @@ Usage The above example shows the use of a fixed jump of '10'. -Note - The underlying \c patchType should be set to \c cyclicAMI + Note: + The underlying \c patchType should be set to \c cyclicAMI See also Foam::jumpCyclicAMIFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 531f258c04..2f6abe5d3c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -92,12 +92,12 @@ Usage Foam::Function1s::turbulentBL have been created specifically for this purpose and are likely to be appropriate for most cases. -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) - - May not work correctly for transonic inlets - - Strange behaviour with potentialFoam since the U equation is not solved + 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) + - May not work correctly for transonic inlets + - Strange behaviour with potentialFoam since the U equation is not solved See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateOutletVelocity/flowRateOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateOutletVelocity/flowRateOutletVelocityFvPatchVectorField.H index 305b90edf9..3852446c85 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateOutletVelocity/flowRateOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateOutletVelocity/flowRateOutletVelocityFvPatchVectorField.H @@ -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,12 +70,12 @@ Usage The \c flowRate entry is a \c Function1 of time, see Foam::Function1s. -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) - - May not work correctly for transonic outlets - - Strange behaviour with potentialFoam since the U equation is not solved + 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) + - May not work correctly for transonic outlets + - Strange behaviour with potentialFoam since the U equation is not solved See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 86db8a1608..8e29ff89de 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,9 +61,9 @@ Description } \endverbatim -Note - If reverse flow is possible or expected use the - pressureInletOutletVelocity condition instead. + Note: + If reverse flow is possible or expected use the + pressureInletOutletVelocity condition instead. See also Foam::zeroGradientFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 94d2431fee..bf2de8c104 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -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 diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamVelocity/freestreamVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamVelocity/freestreamVelocityFvPatchVectorField.H index 30d564e56e..1123a91d12 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamVelocity/freestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamVelocity/freestreamVelocityFvPatchVectorField.H @@ -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 diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 264eed016a..51dca78c19 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -49,10 +49,10 @@ Usage The mode of operation is determined by the sign of the flux across the patch faces. -Note - Sign conventions: - - Positive flux (out of domain): apply zero-gradient condition - - Negative flux (into of domain): apply the "inletValue" fixed-value + Note: + Sign conventions: + - Positive flux (out of domain): apply zero-gradient condition + - Negative flux (into of domain): apply the "inletValue" fixed-value See also Foam::mixedFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 3b46211943..2d2a7bdca9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,12 +49,12 @@ Usage } \endverbatim -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. + 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. See also Foam::mappedPatchBase diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 2363deb3cd..f11bfe8732 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -47,9 +47,9 @@ Usage } \endverbatim -Note - This boundary condition can only be applied to patches that are of - the \c mappedPolyPatch type. + Note: + This boundary condition can only be applied to patches that are of + the \c mappedPolyPatch type. See also Foam::mappedPatchBase diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 119d6b0ab5..b32ab83211 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -61,9 +61,9 @@ Usage boundary faces and both faces sample into the cell, both faces will get the same value. -Note - It is not possible to sample internal faces since volume fields are not - defined on faces. + Note: + It is not possible to sample internal faces since volume fields are not + defined on faces. See also Foam::mappedPatchBase diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index fc9e4333b8..d376429867 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -47,9 +47,9 @@ Usage The underlying sample mode should be set to \c nearestPatchFace or \c nearestFace -Note - This boundary condition can only be applied to patches that are of - the \c mappedPolyPatch type. + Note: + This boundary condition can only be applied to patches that are of + the \c mappedPolyPatch type. See also Foam::mappedPatchBase diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index aaf207b390..a15456d29a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,10 +49,10 @@ Usage The mode of operation is determined by the sign of the flux across the patch faces. -Note - Sign conventions: - - Positive flux (out of domain): apply the "outletValue" fixed-value - - Negative flux (into of domain): apply zero-gradient condition + Note: + Sign conventions: + - Positive flux (out of domain): apply the "outletValue" fixed-value + - Negative flux (into of domain): apply zero-gradient condition See also Foam::mixedFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index 956743fd15..f7d0b2ae96 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -50,11 +50,11 @@ Usage } \endverbatim -Note - Sign conventions: - - positive flux (out of domain): apply zero-gradient condition - - negative flux (into of domain): derive from the flux with specified - direction + Note: + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux with specified + direction See also Foam::mixedFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 27b992b406..7ea92adaca 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,10 +49,9 @@ Usage } \endverbatim -Note - If reverse flow is possible or expected use the - pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. - + Note: + If reverse flow is possible or expected use the + pressureDirectedInletOutletVelocityFvPatchVectorField condition instead. See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 17befac102..2b51a5f596 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,11 +48,11 @@ Usage } \endverbatim -Note - Sign conventions: - - positive flux (out of domain): apply zero-gradient condition - - negative flux (into of domain): derive from the flux with specified - direction + Note: + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux with specified + direction See also Foam::mixedFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 19964fa157..40a0665cbe 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -41,9 +41,9 @@ Usage } \endverbatim -Note - If reverse flow is possible or expected use - the pressureInletOutletVelocityFvPatchVectorField condition instead. + Note: + If reverse flow is possible or expected use + the pressureInletOutletVelocityFvPatchVectorField condition instead. See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index b5e912b865..ecd74295ff 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -48,11 +48,11 @@ Usage } \endverbatim -Note - Sign conventions: - - positive flux (out of domain): apply zero-gradient condition - - negative flux (into of domain): derive from the flux and patch-normal - direction + Note: + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): derive from the flux and patch-normal + direction See also Foam::mixedFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 755465b178..deb0fda59a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -52,11 +52,11 @@ Usage The \c omega entry is a Function1 type, able to describe time varying functions. -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 - direction + 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 + direction See also Foam::pressureInletOutletVelocityFvPatchVectorField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index c00eee39d7..e9c2dc732c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -57,9 +57,9 @@ Usage } \endverbatim -Note - This boundary condition is ill-posed if the free-stream flow is normal - to the boundary. + Note: + This boundary condition is ill-posed if the free-stream flow is normal + to the boundary. SourceFiles supersonicFreestreamFvPatchVectorField.C diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index ec00b93b5f..ae0eb45756 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -45,9 +45,9 @@ Usage } \endverbatim -Note - Sign conventions: - - the value is positive for outward-pointing vectors + Note: + Sign conventions: + - the value is positive for outward-pointing vectors See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalUniformFixedValue/surfaceNormalUniformFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalUniformFixedValue/surfaceNormalUniformFixedValueFvPatchVectorField.H index f384340b55..94ac13ee40 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalUniformFixedValue/surfaceNormalUniformFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalUniformFixedValue/surfaceNormalUniformFixedValueFvPatchVectorField.H @@ -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,9 +45,9 @@ Usage } \endverbatim -Note - Sign conventions: - - the value is positive for outward-pointing vectors + Note: + Sign conventions: + - the value is positive for outward-pointing vectors See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index dc09165f8f..2de70e5b42 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -55,11 +55,11 @@ Usage } \endverbatim -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. - - the value is positive into the domain + 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. + - the value is positive into the domain See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.H index de94529d4d..c919aa8939 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlInletVelocity/swirlInletVelocityFvPatchVectorField.H @@ -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 diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H index cd6f0434d4..98dbeed893 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H @@ -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,10 +42,10 @@ Usage } \endverbatim -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. + 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. See also Foam::Function1s diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index cfaf1dfe72..31663bfa07 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -42,10 +42,10 @@ Usage } \endverbatim -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. + 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. See also Foam::Function1s diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H index 7c3a0e01b5..bbd33f0887 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H @@ -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,10 +48,10 @@ Usage The mode of operation is determined by the sign of the flux across the patch faces. -Note - Sign conventions: - - positive flux (out of domain): apply zero-gradient condition - - negative flux (into of domain): apply the user-specified fixed value + Note: + Sign conventions: + - positive flux (out of domain): apply zero-gradient condition + - negative flux (into of domain): apply the user-specified fixed value See also Foam::inletOutletFvPatchField diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H index e9b6ac74be..a235745a12 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H @@ -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,10 +48,10 @@ Usage The above example shows the use of a fixed jump of '10'. -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. + 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. The underlying \c patchType should be set to \c cyclic diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H index c48218553e..919de27e8f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H @@ -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,10 +48,10 @@ Usage The above example shows the use of a fixed jump of '10'. -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. + 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. The underlying \c patchType should be set to \c cyclic diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index f17c433463..e5105c75ea 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,11 +51,11 @@ Usage The \c flowRate entry is a \c Function1 of time, see Foam::Function1s. -Note - - the value is positive into the domain - - may not work correctly for transonic inlets - - strange behaviour with potentialFoam since the momentum equation is - not solved + Note: + - the value is positive into the domain + - may not work correctly for transonic inlets + - strange behaviour with potentialFoam since the momentum equation is + not solved See also Foam::fixedValueFvPatchField diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H index f6534e0272..6e1e9df28f 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H @@ -71,12 +71,12 @@ 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 - \verbatim - cnCoeff = 1.0/(1.0 + ocCoeff); - \endverbatim + 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 See also Foam::Euler diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H index 7b9da66b0a..a06cb3d5f6 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H @@ -31,9 +31,9 @@ Description factor. The factor applies to the first scheme and 1-factor to the second scheme. -Note - Although a blending factor of 0 and 1 is permitted, it is more efficient - just to use the underlying scheme directly. + Note: + Although a blending factor of 0 and 1 is permitted, it is more efficient + just to use the underlying scheme directly. SourceFiles fixedBlended.C diff --git a/src/mesh/blockMesh/blockMesh/blockMesh.H b/src/mesh/blockMesh/blockMesh/blockMesh.H index b7a101744b..c277fd3d46 100644 --- a/src/mesh/blockMesh/blockMesh/blockMesh.H +++ b/src/mesh/blockMesh/blockMesh/blockMesh.H @@ -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 diff --git a/src/mesh/blockMesh/blocks/block/block.H b/src/mesh/blockMesh/blocks/block/block.H index 6e07be8d23..52dff38a48 100644 --- a/src/mesh/blockMesh/blocks/block/block.H +++ b/src/mesh/blockMesh/blocks/block/block.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,8 +28,8 @@ Description Creates a single block of cells from point coordinates, numbers of cells in each direction and an expansion ratio. -Note - The vertices and cells for filling the block are demand-driven. + Note: + The vertices and cells for filling the block are demand-driven. SourceFiles block.C diff --git a/src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.H b/src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.H index ba60517ab1..ba076fae6a 100644 --- a/src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.H +++ b/src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,8 +27,8 @@ Class Description Provide a means of reading/writing the single-file OpenFOAM edge format. -Note - This class provides more methods than the regular edge format interface. + Note: + This class provides more methods than the regular edge format interface. SourceFiles edgeMeshFormat.C diff --git a/src/meshTools/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H b/src/meshTools/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H index cbd72f7a9f..13a37d4ff4 100644 --- a/src/meshTools/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H +++ b/src/meshTools/edgeMesh/edgeMeshFormats/starcd/STARCDedgeFormat.H @@ -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,8 @@ Class Description Read/write the lines from pro-STAR vrt/cel files. -Note - Uses the extension \a .inp (input) to denote the format. + Note: + Uses the extension \a .inp (input) to denote the format. See also Foam::meshReaders::STARCD diff --git a/src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H b/src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H index d9291d6a5d..1c2c483594 100644 --- a/src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H +++ b/src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H @@ -69,10 +69,9 @@ Description Note: if offsetMode is \c normal it uses outwards pointing normals. So supply a negative distance if sampling inside the domain. - -Note - Storage is not optimal. It temporary collects all (patch)face centres - on all processors to keep the addressing calculation simple. + Note: + Storage is not optimal. It temporary collects all (patch)face centres + on all processors to keep the addressing calculation simple. SourceFiles mappedPatchBase.C diff --git a/src/meshTools/mappedPatches/mappedPolyPatch/mappedPolyPatch.H b/src/meshTools/mappedPatches/mappedPolyPatch/mappedPolyPatch.H index b1e58474ce..3b85ad145d 100644 --- a/src/meshTools/mappedPatches/mappedPolyPatch/mappedPolyPatch.H +++ b/src/meshTools/mappedPatches/mappedPolyPatch/mappedPolyPatch.H @@ -28,9 +28,9 @@ Description Determines a mapping between patch face centres and mesh cell or face centres and processors they're on. -Note - Storage is not optimal. It stores all face centres and cells on all - processors to keep the addressing calculation simple. + Note: + Storage is not optimal. It stores all face centres and cells on all + processors to keep the addressing calculation simple. SourceFiles mappedPolyPatch.C diff --git a/src/meshTools/mappedPatches/mappedPolyPatch/mappedWallPolyPatch.H b/src/meshTools/mappedPatches/mappedPolyPatch/mappedWallPolyPatch.H index b545346a28..f873258812 100644 --- a/src/meshTools/mappedPatches/mappedPolyPatch/mappedWallPolyPatch.H +++ b/src/meshTools/mappedPatches/mappedPolyPatch/mappedWallPolyPatch.H @@ -28,9 +28,9 @@ Description Determines a mapping between patch face centres and mesh cell or face centres and processors they're on. -Note - Storage is not optimal. It stores all face centres and cells on all - processors to keep the addressing calculation simple. + Note: + Storage is not optimal. It stores all face centres and cells on all + processors to keep the addressing calculation simple. SourceFiles mappedWallPolyPatch.C diff --git a/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H b/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H index e27fae87a6..04ada8e6b8 100644 --- a/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H +++ b/src/meshTools/triSurface/booleanOps/intersectedSurface/edgeSurface.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -41,9 +41,9 @@ Description Used to easily insert cuts and split faces. -Note - - points with surface (local)points first, intersection points last - - edges with (split) surface edges first, intersection edges last. + Note: + - points with surface (local)points first, intersection points last + - edges with (split) surface edges first, intersection edges last. SourceFiles edgeSurface.C diff --git a/src/surfMesh/surfaceFormats/ac3d/AC3DsurfaceFormat.H b/src/surfMesh/surfaceFormats/ac3d/AC3DsurfaceFormat.H index 84829e031a..1f1b00f0d5 100644 --- a/src/surfMesh/surfaceFormats/ac3d/AC3DsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/ac3d/AC3DsurfaceFormat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,10 +29,10 @@ Description http://www.inivis.com/ac3d/man/ac3dfileformat.html -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. + 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. SourceFiles AC3DsurfaceFormat.C diff --git a/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H b/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H index 91d91c78a7..145064e6d7 100644 --- a/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/off/OFFsurfaceFormat.H @@ -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,9 +33,9 @@ See also file format information: http://www.geomview.org/docs/html/OFF.html#OFF -Note - When reading, the optional \a colorspec is ignored. - When writing, it is set to the zone number (integer). + Note: + When reading, the optional \a colorspec is ignored. + When writing, it is set to the zone number (integer). SourceFiles OFFsurfaceFormat.C diff --git a/src/surfMesh/surfaceFormats/ofs/OFSsurfaceFormat.H b/src/surfMesh/surfaceFormats/ofs/OFSsurfaceFormat.H index 50d0a56a0a..24b5397998 100644 --- a/src/surfMesh/surfaceFormats/ofs/OFSsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/ofs/OFSsurfaceFormat.H @@ -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 diff --git a/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H b/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H index d30179597b..08ffce282e 100644 --- a/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/starcd/STARCDsurfaceFormat.H @@ -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,8 @@ Class Description Read/write the surface shells from pro-STAR vrt/cel files. -Note - Uses the extension \a .inp (input) to denote the format. + Note: + Uses the extension \a .inp (input) to denote the format. See also Foam::meshReaders::STARCD diff --git a/src/surfMesh/surfaceFormats/stl/STLsurfaceFormat.H b/src/surfMesh/surfaceFormats/stl/STLsurfaceFormat.H index 5da42221dc..21fcbf0189 100644 --- a/src/surfMesh/surfaceFormats/stl/STLsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/stl/STLsurfaceFormat.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,9 +27,9 @@ Class Description Provide a means of reading/writing STL files (ASCII and binary). -Note - For efficiency, the zones are sorted before creating the faces. - The class is thus derived from MeshedSurface. + Note: + For efficiency, the zones are sorted before creating the faces. + The class is thus derived from MeshedSurface. SourceFiles STLsurfaceFormat.C diff --git a/src/surfMesh/surfaceFormats/tri/TRIsurfaceFormat.H b/src/surfMesh/surfaceFormats/tri/TRIsurfaceFormat.H index 56a237c47f..ac8741c60e 100644 --- a/src/surfMesh/surfaceFormats/tri/TRIsurfaceFormat.H +++ b/src/surfMesh/surfaceFormats/tri/TRIsurfaceFormat.H @@ -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,9 +27,9 @@ Class Description Provide a means of reading/writing .tri format. -Note - For efficiency, the zones are sorted before creating the faces. - The class is thus derived from MeshedSurface. + Note: + For efficiency, the zones are sorted before creating the faces. + The class is thus derived from MeshedSurface. SourceFiles TRIsurfaceFormat.C