From d51aa5a74d3ed66c8b54cd49170722ee8a166a8e Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Thu, 23 Feb 2023 18:58:25 +0100 Subject: [PATCH] STYLE: merge EdgeMap definition into edgeHashes.H STYLE: combine some list typedefs, add documentation comments GIT: relocate some compat includes --- src/OpenFOAM/compat/EdgeMap.H | 10 +++ .../{primitives => }/compat/HashFwd.H | 0 src/OpenFOAM/{primitives => }/compat/Swap.H | 0 .../{primitives => }/compat/doubleTensor.H | 0 .../{primitives => }/compat/doubleVector.H | 0 .../{primitives => }/compat/floatTensor.H | 0 .../{primitives => }/compat/floatVector.H | 0 src/OpenFOAM/{primitives => }/compat/nil.H | 0 src/OpenFOAM/compat/wordReList.H | 10 +++ .../compat/wordReListMatcher.H | 0 .../IndirectList/UIndirectList.H | 4 +- src/OpenFOAM/db/IOstreams/token/tokenList.H | 12 +--- .../fields/Fields/boolField/boolIOField.H | 11 +-- .../diagTensorField/diagTensorFieldIOField.H | 13 ++-- .../diagTensorField/diagTensorIOField.H | 11 +-- .../Fields/labelField/labelFieldIOField.H | 13 ++-- .../fields/Fields/labelField/labelIOField.H | 11 +-- .../quaternionField/quaternionIOField.H | 11 +-- .../Fields/scalarField/scalarFieldIOField.H | 13 ++-- .../fields/Fields/scalarField/scalarIOField.H | 11 +-- .../sphericalTensorFieldIOField.H | 12 ++-- .../sphericalTensorIOField.H | 11 +-- .../symmTensorField/symmTensorFieldIOField.H | 13 ++-- .../symmTensorField/symmTensorIOField.H | 11 +-- .../Fields/tensorField/tensorFieldIOField.H | 13 ++-- .../fields/Fields/tensorField/tensorIOField.H | 11 +-- .../fields/Fields/triadField/triadIOField.H | 11 +-- .../vector2DField/vector2DFieldIOField.H | 13 ++-- .../Fields/vector2DField/vector2DIOField.H | 11 +-- .../Fields/vectorField/vectorFieldIOField.H | 13 ++-- .../fields/Fields/vectorField/vectorIOField.H | 11 +-- .../surface/geometricSurfacePatchList.H | 21 ++---- .../surface/surfZoneIdentifierList.H | 21 ++---- .../meshes/meshShapes/cell/cellIOList.H | 13 ++-- .../meshes/meshShapes/cell/cellIndList.H | 15 +--- .../meshes/meshShapes/cell/cellList.H | 30 +------- .../meshes/meshShapes/cell/cellListFwd.H | 13 ++-- .../meshShapes/cellShape/cellShapeIOList.H | 7 +- .../meshShapes/cellShape/cellShapeList.H | 9 +-- src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H | 72 ------------------- .../meshes/meshShapes/edge/edgeHashes.H | 53 ++++++++++---- .../meshes/meshShapes/edge/edgeIOList.H | 13 ++-- .../meshes/meshShapes/edge/edgeIndList.H | 15 +--- .../meshes/meshShapes/edge/edgeList.H | 38 +++------- .../meshes/meshShapes/face/faceIOList.H | 13 ++-- .../meshes/meshShapes/face/faceIndList.H | 15 +--- .../meshes/meshShapes/face/faceList.H | 30 +------- .../meshes/meshShapes/face/faceListFwd.H | 13 ++-- .../meshes/meshShapes/tetCell/tetCellList.H | 12 +--- .../meshes/meshShapes/triFace/triFaceList.H | 12 +--- .../objectHit/pointIndexHitIOList.H | 7 +- .../primitiveShapes/point/pointIndList.H | 15 +--- .../meshes/primitiveShapes/point/pointList.H | 36 ++-------- .../primitives/Scalar/lists/scalarIOList.H | 11 +-- .../primitives/Scalar/lists/scalarIndList.H | 15 +--- .../primitives/Scalar/lists/scalarList.H | 36 ++-------- .../Scalar/lists/scalarListIOList.H | 13 ++-- .../Tensor/lists/sphericalTensorList.H | 22 ++---- .../primitives/Tensor/lists/symmTensorList.H | 21 ++---- .../primitives/Tensor/lists/tensorList.H | 21 ++---- .../primitives/Vector/lists/vectorIOList.H | 11 +-- .../primitives/Vector/lists/vectorIndList.H | 15 +--- .../primitives/Vector/lists/vectorList.H | 36 ++-------- .../Vector/lists/vectorListIOList.H | 13 ++-- .../primitives/bools/lists/boolList.H | 13 ++-- .../primitives/chars/lists/charList.H | 13 ++-- .../primitives/ints/lists/labelIOList.H | 7 +- .../primitives/ints/lists/labelIndList.H | 16 +---- .../primitives/ints/lists/labelList.H | 17 ++--- .../primitives/ints/lists/labelListIOList.H | 9 +-- .../primitives/strings/lists/fileNameList.H | 28 ++------ .../primitives/strings/lists/stringList.H | 24 +------ .../primitives/strings/lists/wordList.H | 24 +------ .../primitives/strings/lists/wordReList.H | 58 --------------- .../primitives/strings/string/stringIOList.H | 13 ++-- .../primitives/strings/word/wordIOList.H | 13 ++-- .../primitives/strings/wordRes/wordRes.H | 10 ++- src/OpenFOAM/primitives/tuples/labelPair.H | 38 ++-------- src/OpenFOAM/primitives/tuples/wordPair.H | 37 ++-------- .../polyMeshAdder/faceCoupleInfo.H | 11 ++- src/dynamicMesh/polyMeshAdder/polyMeshAdder.C | 5 +- src/dynamicMesh/polyMeshAdder/polyMeshAdder.H | 6 +- .../multiWorld/multiWorldConnectionsObject.H | 2 +- src/surfMesh/surfZone/surfZoneList.H | 19 ++--- .../triSurface/patches/surfacePatchList.H | 20 ++---- 85 files changed, 342 insertions(+), 988 deletions(-) create mode 100644 src/OpenFOAM/compat/EdgeMap.H rename src/OpenFOAM/{primitives => }/compat/HashFwd.H (100%) rename src/OpenFOAM/{primitives => }/compat/Swap.H (100%) rename src/OpenFOAM/{primitives => }/compat/doubleTensor.H (100%) rename src/OpenFOAM/{primitives => }/compat/doubleVector.H (100%) rename src/OpenFOAM/{primitives => }/compat/floatTensor.H (100%) rename src/OpenFOAM/{primitives => }/compat/floatVector.H (100%) rename src/OpenFOAM/{primitives => }/compat/nil.H (100%) create mode 100644 src/OpenFOAM/compat/wordReList.H rename src/OpenFOAM/{primitives => }/compat/wordReListMatcher.H (100%) delete mode 100644 src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H delete mode 100644 src/OpenFOAM/primitives/strings/lists/wordReList.H diff --git a/src/OpenFOAM/compat/EdgeMap.H b/src/OpenFOAM/compat/EdgeMap.H new file mode 100644 index 0000000000..ef85e20fda --- /dev/null +++ b/src/OpenFOAM/compat/EdgeMap.H @@ -0,0 +1,10 @@ +// Compatibility include. Contents merged with edgeHashes.H (FEB-2023) + +#ifndef FoamCompat_EdgeMap_H +#define FoamCompat_EdgeMap_H + +#include "edgeHashes.H" + +#endif + +// ************************************************************************* // diff --git a/src/OpenFOAM/primitives/compat/HashFwd.H b/src/OpenFOAM/compat/HashFwd.H similarity index 100% rename from src/OpenFOAM/primitives/compat/HashFwd.H rename to src/OpenFOAM/compat/HashFwd.H diff --git a/src/OpenFOAM/primitives/compat/Swap.H b/src/OpenFOAM/compat/Swap.H similarity index 100% rename from src/OpenFOAM/primitives/compat/Swap.H rename to src/OpenFOAM/compat/Swap.H diff --git a/src/OpenFOAM/primitives/compat/doubleTensor.H b/src/OpenFOAM/compat/doubleTensor.H similarity index 100% rename from src/OpenFOAM/primitives/compat/doubleTensor.H rename to src/OpenFOAM/compat/doubleTensor.H diff --git a/src/OpenFOAM/primitives/compat/doubleVector.H b/src/OpenFOAM/compat/doubleVector.H similarity index 100% rename from src/OpenFOAM/primitives/compat/doubleVector.H rename to src/OpenFOAM/compat/doubleVector.H diff --git a/src/OpenFOAM/primitives/compat/floatTensor.H b/src/OpenFOAM/compat/floatTensor.H similarity index 100% rename from src/OpenFOAM/primitives/compat/floatTensor.H rename to src/OpenFOAM/compat/floatTensor.H diff --git a/src/OpenFOAM/primitives/compat/floatVector.H b/src/OpenFOAM/compat/floatVector.H similarity index 100% rename from src/OpenFOAM/primitives/compat/floatVector.H rename to src/OpenFOAM/compat/floatVector.H diff --git a/src/OpenFOAM/primitives/compat/nil.H b/src/OpenFOAM/compat/nil.H similarity index 100% rename from src/OpenFOAM/primitives/compat/nil.H rename to src/OpenFOAM/compat/nil.H diff --git a/src/OpenFOAM/compat/wordReList.H b/src/OpenFOAM/compat/wordReList.H new file mode 100644 index 0000000000..df8f6c8690 --- /dev/null +++ b/src/OpenFOAM/compat/wordReList.H @@ -0,0 +1,10 @@ +// Compatibility include. For v2012 and earlier. + +#ifndef FoamCompat_wordReList_H +#define FoamCompat_wordReList_H + +#include "wordRes.H" + +#endif + +// ************************************************************************* // diff --git a/src/OpenFOAM/primitives/compat/wordReListMatcher.H b/src/OpenFOAM/compat/wordReListMatcher.H similarity index 100% rename from src/OpenFOAM/primitives/compat/wordReListMatcher.H rename to src/OpenFOAM/compat/wordReListMatcher.H diff --git a/src/OpenFOAM/containers/IndirectLists/IndirectList/UIndirectList.H b/src/OpenFOAM/containers/IndirectLists/IndirectList/UIndirectList.H index 33e286f573..3352a47e9a 100644 --- a/src/OpenFOAM/containers/IndirectLists/IndirectList/UIndirectList.H +++ b/src/OpenFOAM/containers/IndirectLists/IndirectList/UIndirectList.H @@ -6,8 +6,8 @@ Description \*---------------------------------------------------------------------------*/ -#ifndef Foam_UIndirectList_H -#define Foam_UIndirectList_H +#ifndef FoamCompat_UIndirectList_H +#define FoamCompat_UIndirectList_H #include "IndirectList.H" diff --git a/src/OpenFOAM/db/IOstreams/token/tokenList.H b/src/OpenFOAM/db/IOstreams/token/tokenList.H index 2566c91bfa..75d6083ba0 100644 --- a/src/OpenFOAM/db/IOstreams/token/tokenList.H +++ b/src/OpenFOAM/db/IOstreams/token/tokenList.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::tokenList - -Description - List of tokens, used for a IOdictionary entry. - \*---------------------------------------------------------------------------*/ -#ifndef tokenList_H -#define tokenList_H +#ifndef Foam_tokenList_H +#define Foam_tokenList_H #include "token.H" #include "List.H" @@ -41,8 +35,8 @@ Description namespace Foam { + //! List of token, used for dictionary primitive entry (for example) typedef List tokenList; - typedef List tokenTypeList; } // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/OpenFOAM/fields/Fields/boolField/boolIOField.H b/src/OpenFOAM/fields/Fields/boolField/boolIOField.H index a2d139560a..10eeb6719a 100644 --- a/src/OpenFOAM/fields/Fields/boolField/boolIOField.H +++ b/src/OpenFOAM/fields/Fields/boolField/boolIOField.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::boolIOField - -Description - A boolField with IO. - \*---------------------------------------------------------------------------*/ -#ifndef boolIOField_H -#define boolIOField_H +#ifndef Foam_boolIOField_H +#define Foam_boolIOField_H #include "boolField.H" #include "IOField.H" @@ -41,6 +35,7 @@ Description namespace Foam { + //! IO for a Field of bool typedef IOField boolIOField; } diff --git a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorFieldIOField.H b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorFieldIOField.H index 896bac8ab7..f157893377 100644 --- a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorFieldIOField.H +++ b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorFieldIOField.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::diagTensorFieldIOField - -Description - diagTensorFieldField with IO. - \*---------------------------------------------------------------------------*/ -#ifndef diagTensorFieldIOField_H -#define diagTensorFieldIOField_H +#ifndef Foam_diagTensorFieldIOField_H +#define Foam_diagTensorFieldIOField_H #include "diagTensorField.H" #include "CompactIOField.H" @@ -41,7 +35,10 @@ Description namespace Foam { + //! IO for a Field of diagTensorField typedef IOField diagTensorFieldIOField; + + //! Compact IO for a Field of diagTensorField typedef CompactIOField diagTensorFieldCompactIOField; } diff --git a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorIOField.H b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorIOField.H index 54efa8bcfd..b5dc691ce2 100644 --- a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorIOField.H +++ b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorIOField.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::diagTensorIOField - -Description - diagTensorField with IO. - \*---------------------------------------------------------------------------*/ -#ifndef diagTensorIOField_H -#define diagTensorIOField_H +#ifndef Foam_diagTensorIOField_H +#define Foam_diagTensorIOField_H #include "diagTensorField.H" #include "IOField.H" @@ -41,6 +35,7 @@ Description namespace Foam { + //! IO for a Field of diagTensor typedef IOField diagTensorIOField; } diff --git a/src/OpenFOAM/fields/Fields/labelField/labelFieldIOField.H b/src/OpenFOAM/fields/Fields/labelField/labelFieldIOField.H index f556cd4fbf..a5263751a0 100644 --- a/src/OpenFOAM/fields/Fields/labelField/labelFieldIOField.H +++ b/src/OpenFOAM/fields/Fields/labelField/labelFieldIOField.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::labelFieldIOField - -Description - labelFieldField with IO. - \*---------------------------------------------------------------------------*/ -#ifndef labelFieldIOField_H -#define labelFieldIOField_H +#ifndef Foam_labelFieldIOField_H +#define Foam_labelFieldIOField_H #include "labelField.H" #include "IOField.H" @@ -42,7 +36,10 @@ Description namespace Foam { + //! IO for a Field of labelField typedef IOField labelFieldIOField; + + //! Compact IO for a Field of labelField typedef CompactIOField labelFieldCompactIOField; } diff --git a/src/OpenFOAM/fields/Fields/labelField/labelIOField.H b/src/OpenFOAM/fields/Fields/labelField/labelIOField.H index 42dd2a1797..4f824373b4 100644 --- a/src/OpenFOAM/fields/Fields/labelField/labelIOField.H +++ b/src/OpenFOAM/fields/Fields/labelField/labelIOField.H @@ -23,16 +23,10 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Typedef - Foam::labelIOField - -Description - labelField with IO. - \*---------------------------------------------------------------------------*/ -#ifndef labelIOField_H -#define labelIOField_H +#ifndef Foam_labelIOField_H +#define Foam_labelIOField_H #include "primitiveFields.H" #include "IOField.H" @@ -41,6 +35,7 @@ Description namespace Foam { + //! IO for a Field of label typedef IOField