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

@@ -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
+
+// ************************************************************************* //

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
+
+// ************************************************************************* //

src/OpenFOAM/containers/IndirectLists/IndirectList/UIndirectList.H

@@ -6,8 +6,8 @@ Description
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef Foam_UIndirectList_H
+#ifndef FoamCompat_UIndirectList_H
-#define Foam_UIndirectList_H
+#define FoamCompat_UIndirectList_H
 
 #include "IndirectList.H"
 

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::tokenList
-
-Description
-    List of tokens, used for a IOdictionary entry.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef tokenList_H
+#ifndef Foam_tokenList_H
-#define 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<token> tokenList;
-    typedef List<token::tokenType> tokenTypeList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::boolIOField
-
-Description
-    A boolField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef boolIOField_H
+#ifndef Foam_boolIOField_H
-#define 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<bool> boolIOField;
 }
 

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::diagTensorFieldIOField
-
-Description
-    diagTensorFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef diagTensorFieldIOField_H
+#ifndef Foam_diagTensorFieldIOField_H
-#define 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<diagTensorField> diagTensorFieldIOField;
+
+    //! Compact IO for a Field of diagTensorField
     typedef CompactIOField<diagTensorField, diagTensor>
     diagTensorFieldCompactIOField;
 }

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::diagTensorIOField
-
-Description
-    diagTensorField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef diagTensorIOField_H
+#ifndef Foam_diagTensorIOField_H
-#define 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<diagTensor> diagTensorIOField;
 }
 

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelFieldIOField
-
-Description
-    labelFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef labelFieldIOField_H
+#ifndef Foam_labelFieldIOField_H
-#define 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<labelField> labelFieldIOField;
+
+    //! Compact IO for a Field of labelField
     typedef CompactIOField<labelField, label> labelFieldCompactIOField;
 }
 

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 <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelIOField
-
-Description
-    labelField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef labelIOField_H
+#ifndef Foam_labelIOField_H
-#define 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<label> labelIOField;
 }
 

src/OpenFOAM/fields/Fields/quaternionField/quaternionIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::quaternionIOField
-
-Description
-    quaternionField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef quaternionIOField_H
+#ifndef Foam_quaternionIOField_H
-#define quaternionIOField_H
+#define Foam_quaternionIOField_H
 
 #include "quaternionField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of quaternion
     typedef IOField<quaternion> quaternionIOField;
 }
 

src/OpenFOAM/fields/Fields/scalarField/scalarFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarFieldIOField
-
-Description
-    scalarFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef scalarFieldIOField_H
+#ifndef Foam_scalarFieldIOField_H
-#define scalarFieldIOField_H
+#define Foam_scalarFieldIOField_H
 
 #include "scalarField.H"
 #include "CompactIOField.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of scalarField
     typedef IOField<scalarField> scalarFieldIOField;
+
+    //! Compact IO for a Field of scalarField
     typedef CompactIOField<scalarField, scalar> scalarFieldCompactIOField;
 }
 

src/OpenFOAM/fields/Fields/scalarField/scalarIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarIOField
-
-Description
-    scalarField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef scalarIOField_H
+#ifndef Foam_scalarIOField_H
-#define scalarIOField_H
+#define Foam_scalarIOField_H
 
 #include "scalarField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of scalar
     typedef IOField<scalar> scalarIOField;
 }
 

src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::sphericalTensorFieldIOField
-
-Description
-    sphericalTensorFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef sphericalTensorFieldIOField_H
+#ifndef Foam_sphericalTensorFieldIOField_H
-#define sphericalTensorFieldIOField_H
+#define Foam_sphericalTensorFieldIOField_H
 
 #include "sphericalTensorField.H"
 #include "CompactIOField.H"
@@ -41,8 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of sphericalTensorField
     typedef IOField<sphericalTensorField> sphericalTensorFieldIOField;
 
+    //! Compact IO for a Field of sphericalTensorField
     typedef CompactIOField<sphericalTensorField, sphericalTensor>
     sphericalTensorFieldCompactIOField;
 }

src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::sphericalTensorIOField
-
-Description
-    sphericalTensorField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef sphericalTensorIOField_H
+#ifndef Foam_sphericalTensorIOField_H
-#define sphericalTensorIOField_H
+#define Foam_sphericalTensorIOField_H
 
 #include "sphericalTensorField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of sphericalTensor
     typedef IOField<sphericalTensor> sphericalTensorIOField;
 }
 

src/OpenFOAM/fields/Fields/symmTensorField/symmTensorFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::symmTensorFieldIOField
-
-Description
-    symmTensorFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef symmTensorFieldIOField_H
+#ifndef Foam_symmTensorFieldIOField_H
-#define symmTensorFieldIOField_H
+#define Foam_symmTensorFieldIOField_H
 
 #include "symmTensorField.H"
 #include "CompactIOField.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of symmTensorField
     typedef IOField<symmTensorField> symmTensorFieldIOField;
+
+    //! Compact IO for a Field of symmTensorField
     typedef CompactIOField<symmTensorField, symmTensor>
     symmTensorFieldCompactIOField;
 }

src/OpenFOAM/fields/Fields/symmTensorField/symmTensorIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::symmTensorIOField
-
-Description
-    symmTensorField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef symmTensorIOField_H
+#ifndef Foam_symmTensorIOField_H
-#define symmTensorIOField_H
+#define Foam_symmTensorIOField_H
 
 #include "symmTensorField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of symmTensor
     typedef IOField<symmTensor> symmTensorIOField;
 }
 

src/OpenFOAM/fields/Fields/tensorField/tensorFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::tensorFieldIOField
-
-Description
-    tensorFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef tensorFieldIOField_H
+#ifndef Foam_tensorFieldIOField_H
-#define tensorFieldIOField_H
+#define Foam_tensorFieldIOField_H
 
 #include "tensorField.H"
 #include "CompactIOField.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of tensorField
     typedef IOField<tensorField> tensorFieldIOField;
+
+    //! Compact IO for a Field of tensorField
     typedef CompactIOField<tensorField, tensor> tensorFieldCompactIOField;
 }
 

src/OpenFOAM/fields/Fields/tensorField/tensorIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::tensorIOField
-
-Description
-    tensorField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef tensorIOField_H
+#ifndef Foam_tensorIOField_H
-#define tensorIOField_H
+#define Foam_tensorIOField_H
 
 #include "tensorField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of tensor
     typedef IOField<tensor> tensorIOField;
 }
 

src/OpenFOAM/fields/Fields/triadField/triadIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::triadIOField
-
-Description
-    triadField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef triadIOField_H
+#ifndef Foam_triadIOField_H
-#define triadIOField_H
+#define Foam_triadIOField_H
 
 #include "triadField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of triad
     typedef IOField<triad> triadIOField;
 }
 

src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vector2DFieldIOField
-
-Description
-    vector2DFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vector2DFieldIOField_H
+#ifndef Foam_vector2DFieldIOField_H
-#define vector2DFieldIOField_H
+#define Foam_vector2DFieldIOField_H
 
 #include "vector2DField.H"
 #include "CompactIOField.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of vector2DField
     typedef IOField<vector2DField> vector2DFieldIOField;
+
+    //! Compact IO for a Field of vector2DField
     typedef CompactIOField<vector2DField, vector2D> vector2DFieldCompactIOField;
 }
 

src/OpenFOAM/fields/Fields/vector2DField/vector2DIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vector2DIOField
-
-Description
-    vector2DField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vector2DIOField_H
+#ifndef Foam_vector2DIOField_H
-#define vector2DIOField_H
+#define Foam_vector2DIOField_H
 
 #include "vector2DField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of vector2D
     typedef IOField<vector2D> vector2DIOField;
 }
 

src/OpenFOAM/fields/Fields/vectorField/vectorFieldIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorFieldIOField
-
-Description
-    vectorFieldField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vectorFieldIOField_H
+#ifndef Foam_vectorFieldIOField_H
-#define vectorFieldIOField_H
+#define Foam_vectorFieldIOField_H
 
 #include "vectorField.H"
 #include "CompactIOField.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of vectorField
     typedef IOField<vectorField> vectorFieldIOField;
+
+    //! Compact IO for a Field of vectorField
     typedef CompactIOField<vectorField, vector> vectorFieldCompactIOField;
 }
 

src/OpenFOAM/fields/Fields/vectorField/vectorIOField.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorIOField
-
-Description
-    vectorField with IO.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vectorIOField_H
+#ifndef Foam_vectorIOField_H
-#define vectorIOField_H
+#define Foam_vectorIOField_H
 
 #include "vectorField.H"
 #include "IOField.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a Field of vector
     typedef IOField<vector> vectorIOField;
 }
 

src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatchList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::geometricSurfacePatchList
-
-Description
-    A List of geometricSurfacePatch.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef geometricSurfacePatchList_H
+#ifndef Foam_geometricSurfacePatchList_H
-#define geometricSurfacePatchList_H
+#define Foam_geometricSurfacePatchList_H
 
 #include "geometricSurfacePatch.H"
 #include "List.H"
@@ -41,14 +35,9 @@ Description
 
 namespace Foam
 {
-
+    //! List of geometricSurfacePatch
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+    typedef List<geometricSurfacePatch> geometricSurfacePatchList;
-
+}
-typedef List<geometricSurfacePatch> geometricSurfacePatchList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 

src/OpenFOAM/meshes/Identifiers/surface/surfZoneIdentifierList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::surfZoneIdentifierList
-
-Description
-    A List of surfZoneIdentifier.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef surfZoneIdentifierList_H
+#ifndef Foam_surfZoneIdentifierList_H
-#define surfZoneIdentifierList_H
+#define Foam_surfZoneIdentifierList_H
 
 #include "surfZoneIdentifier.H"
 #include "List.H"
@@ -41,14 +35,9 @@ Description
 
 namespace Foam
 {
-
+    //! List of surfZoneIdentifier
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+    typedef List<surfZoneIdentifier> surfZoneIdentifierList;
-
+}
-typedef List<surfZoneIdentifier> surfZoneIdentifierList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 

src/OpenFOAM/meshes/meshShapes/cell/cellIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::cellIOList
-
-Description
-    IOList of cells
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef cellIOList_H
+#ifndef Foam_cellIOList_H
-#define cellIOList_H
+#define Foam_cellIOList_H
 
 #include "cell.H"
 #include "CompactIOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of cell
     typedef IOList<cell> cellIOList;
+
+    //! Compact IO for a List of cell
     typedef CompactIOList<cell, label> cellCompactIOList;
 }
 

src/OpenFOAM/meshes/meshShapes/cell/cellIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::cellIndList
-
-Description
-    An IndirectList of cells.
-
-Typedef
-    Foam::cellUIndList
-
-Description
-    A UIndirectList of cells.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_cellIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of cell
     typedef IndirectList<cell>  cellIndList;
+
+    //! UIndirectList of cell
     typedef UIndirectList<cell> cellUIndList;
 }
 

src/OpenFOAM/meshes/meshShapes/cell/cellList.H

@@ -23,38 +23,12 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::cellList
-
-Description
-    A List of cells.
-
-Typedef
-    Foam::cellUList
-
-Description
-    A UList of cells.
-
-Typedef
-    Foam::cellSubList
-
-Description
-    A SubList of cells.
-
-Typedef
-    Foam::cellListList
-
-Description
-    A List of cellList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef cellList_H
+#ifndef Foam_cellList_H
-#define cellList_H
+#define Foam_cellList_H
 
 #include "cell.H"
-#include "List.H"
-#include "SubList.H"
 #include "cellListFwd.H"
 
 #endif

src/OpenFOAM/meshes/meshShapes/cell/cellListFwd.H

@@ -31,8 +31,8 @@ Description
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef cellListFwd_H
+#ifndef Foam_cellListFwd_H
-#define cellListFwd_H
+#define Foam_cellListFwd_H
 
 #include "List.H"
 #include "SubList.H"
@@ -41,12 +41,13 @@ Description
 
 namespace Foam
 {
+    // Forward Declaration
     class cell;
 
-    typedef UList<cell> cellUList;
+    typedef List<cell> cellList;            //!< List of cell
-    typedef List<cell> cellList;
+    typedef SubList<cell> cellSubList;      //!< SubList of cell
-    typedef SubList<cell> cellSubList;
+    typedef UList<cell> cellUList;          //!< UList of cell
-    typedef List<cellList> cellListList;
+    typedef List<cellList> cellListList;    //!< List of cellList
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeIOList.H

@@ -23,12 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::cellShapeIOList
-
-Description
-    IOList of cellShapes
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_cellShapeIOList_H
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of cellShape
     typedef IOList<cellShape> cellShapeIOList;
 }
 

src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeList.H

@@ -23,12 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::cellShapeList
-
-Description
-    List of cellShapes and PtrList of List of cellShape.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_cellShapeList_H
@@ -36,14 +30,13 @@ Description
 
 #include "cellShape.H"
 #include "List.H"
-#include "PtrList.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
+    //! List of cellShape
     typedef List<cellShape> cellShapeList;
-    typedef PtrList<cellShapeList> cellShapeListList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H

@@ -1,72 +0,0 @@
-/*---------------------------------------------------------------------------*\
-  =========                 |
-  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
-   \\    /   O peration     |
-    \\  /    A nd           | www.openfoam.com
-     \\/     M anipulation  |
--------------------------------------------------------------------------------
-    Copyright (C) 2011-2016 OpenFOAM Foundation
--------------------------------------------------------------------------------
-License
-    This file is part of OpenFOAM.
-
-    OpenFOAM is free software: you can redistribute it and/or modify it
-    under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
-    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-    for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
-
-Class
-    Foam::EdgeMap
-
-Description
-    Map from edge (expressed as its endpoints) to value.
-    For easier forward declaration it is currently implemented as a
-    separate class rather than a template alias.
-
-\*---------------------------------------------------------------------------*/
-
-#ifndef EdgeMap_H
-#define EdgeMap_H
-
-#include "edge.H"
-#include "HashTable.H"
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-namespace Foam
-{
-
-/*---------------------------------------------------------------------------*\
-                           Class EdgeMap Declaration
-\*---------------------------------------------------------------------------*/
-
-template<class T>
-class EdgeMap
-:
-    public HashTable<T, edge, Hash<edge>>
-{
-public:
-
-    //- Inherit constructors from HashTable
-    using HashTable<T, edge, Hash<edge>>::HashTable;
-
-};
-
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //

src/OpenFOAM/meshes/meshShapes/edge/edgeHashes.H

@@ -5,7 +5,8 @@
     \\  /    A nd           | www.openfoam.com
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
-    Copyright (C) 2017 OpenCFD Ltd.
+    Copyright (C) 2011 OpenFOAM Foundation
+    Copyright (C) 2017-2023 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -23,34 +24,58 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
+Class
-    Foam::edgeHashSet
+    Foam::EdgeMap
 
 Description
-    A HashSet for an edge.
+    Map from edge (expressed as its endpoints) to value.
-    The hashing on an edge is commutative.
+    Hashing (and ==) on an edge is symmetric.
+
+Note
+    For easier forward declaration it is implemented as a separate class
+    rather than a template alias.
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef edgeHashes_H
+#ifndef Foam_edgeHashes_H
-#define edgeHashes_H
+#define Foam_edgeHashes_H
 
 #include "edge.H"
-#include "EdgeMap.H"
 #include "HashSet.H"
+#include "HashTable.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
-    // Alternative:
-    // template<class T>
-    // using EdgeMap = HashTable<T, edge, Hash<edge>>;
 
-    //- A HashSet with edge for its key.
+// Typedefs
-    typedef HashSet<edge, Hash<edge>> edgeHashSet;
 
-}
+//! A HashSet with edge for its key. Hashing (and ==) on an edge is symmetric.
+typedef HashSet<edge, Hash<edge>> edgeHashSet;
+
+
+/*---------------------------------------------------------------------------*\
+                           Class EdgeMap Declaration
+\*---------------------------------------------------------------------------*/
+
+template<class T>
+class EdgeMap
+:
+    public HashTable<T, edge, Hash<edge>>
+{
+public:
+
+    // Constructors
+
+        //- Inherit constructors from HashTable
+        using HashTable<T, edge, Hash<edge>>::HashTable;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 

src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::edgeIOList
-
-Description
-    An IOList of edges
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef edgeIOList_H
+#ifndef Foam_edgeIOList_H
-#define edgeIOList_H
+#define Foam_edgeIOList_H
 
 #include "edge.H"
 #include "CompactIOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of edge
     typedef IOList<edge> edgeIOList;
+
+    //! Compact IO for a List of edge
     typedef CompactIOList<edge, label> edgeCompactIOList;
 }
 

src/OpenFOAM/meshes/meshShapes/edge/edgeIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::edgeIndList
-
-Description
-    An IndirectList of edges.
-
-Typedef
-    Foam::edgeUIndList
-
-Description
-    A UIndirectList of edges.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_edgeIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of edge
     typedef IndirectList<edge>  edgeIndList;
+
+    //! UIndirectList of edge
     typedef UIndirectList<edge> edgeUIndList;
 }
 

src/OpenFOAM/meshes/meshShapes/edge/edgeList.H

@@ -23,46 +23,24 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::edgeList
-
-Description
-    A List of edges.
-
-Typedef
-    Foam::edgeUList
-
-Description
-    A UList of edges.
-
-Typedef
-    Foam::edgeSubList
-
-Description
-    A SubList of edges.
-
-Typedef
-    Foam::edgeListList
-
-Description
-    A List of edgeList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef edgeList_H
+#ifndef Foam_edgeList_H
-#define edgeList_H
+#define Foam_edgeList_H
 
 #include "edge.H"
+#include "List.H"
 #include "SubList.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
-    typedef UList<edge> edgeUList;
+    typedef List<edge> edgeList;            //!< List of edge
-    typedef List<edge> edgeList;
+    typedef SubList<edge> edgeSubList;      //!< SubList of edge
-    typedef SubList<edge> edgeSubList;
+    typedef UList<edge> edgeUList;          //!< UList of edge
-    typedef List<edgeList> edgeListList;
+    typedef List<edgeList> edgeListList;    //!< List of edgeList
+
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/meshShapes/face/faceIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::faceIOList
-
-Description
-    IOList of faces
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef faceIOList_H
+#ifndef Foam_faceIOList_H
-#define faceIOList_H
+#define Foam_faceIOList_H
 
 #include "face.H"
 #include "CompactIOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of face
     typedef IOList<face> faceIOList;
+
+    //! Compact IO for a List of face
     typedef CompactIOList<face, label> faceCompactIOList;
 }
 

src/OpenFOAM/meshes/meshShapes/face/faceIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::faceIndList
-
-Description
-    An IndirectList of faces.
-
-Typedef
-    Foam::faceUIndList
-
-Description
-    A UIndirectList of faces.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_faceIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of face.
     typedef IndirectList<face>  faceIndList;
+
+    //! UIndirectList of face.
     typedef UIndirectList<face> faceUIndList;
 }
 

src/OpenFOAM/meshes/meshShapes/face/faceList.H

@@ -23,38 +23,12 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::faceList
-
-Description
-    A List of faces.
-
-Typedef
-    Foam::faceUList
-
-Description
-    A UList of faces.
-
-Typedef
-    Foam::faceSubList
-
-Description
-    A SubList of faces.
-
-Typedef
-    Foam::faceListList
-
-Description
-    A List of faceList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef faceList_H
+#ifndef Foam_faceList_H
-#define faceList_H
+#define Foam_faceList_H
 
 #include "face.H"
-#include "List.H"
-#include "SubList.H"
 #include "faceListFwd.H"
 
 #endif

src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H

@@ -31,8 +31,8 @@ Description
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef faceListFwd_H
+#ifndef Foam_faceListFwd_H
-#define faceListFwd_H
+#define Foam_faceListFwd_H
 
 #include "List.H"
 #include "SubList.H"
@@ -41,12 +41,13 @@ Description
 
 namespace Foam
 {
+    // Forward Declaration
     class face;
 
-    typedef UList<face> faceUList;
+    typedef List<face> faceList;            //!< List of faces
-    typedef List<face> faceList;
+    typedef SubList<face> faceSubList;      //!< SubList of faces
-    typedef SubList<face> faceSubList;
+    typedef UList<face> faceUList;          //!< UList of faces
-    typedef List<faceList> faceListList;
+    typedef List<faceList> faceListList;    //!< List of faceList
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/meshShapes/tetCell/tetCellList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::tetCellList
-
-Description
-    list of tetCells
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef tetCellList_H
+#ifndef Foam_tetCellList_H
-#define tetCellList_H
+#define Foam_tetCellList_H
 
 #include "tetCell.H"
 #include "List.H"
@@ -41,7 +35,7 @@ Description
 
 namespace Foam
 {
-    typedef List<tetCell> tetCellList;
+    typedef List<tetCell> tetCellList;      //!< List of tetCell
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/meshShapes/triFace/triFaceList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::triFaceList
-
-Description
-    list of triFaces
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef triFaceList_H
+#ifndef Foam_triFaceList_H
-#define triFaceList_H
+#define Foam_triFaceList_H
 
 #include "triFace.H"
 #include "List.H"
@@ -41,7 +35,7 @@ Description
 
 namespace Foam
 {
-    typedef List<triFace> triFaceList;
+    typedef List<triFace> triFaceList;      //!< List of triFace
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/meshes/primitiveShapes/objectHit/pointIndexHitIOList.H

@@ -23,12 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::pointIndexHitIOList
-
-Description
-    IOList of pointIndexHits
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_pointIndexHitIOList_H
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of pointIndexHit
     typedef IOList<pointIndexHit> pointIndexHitIOList;
 }
 

src/OpenFOAM/meshes/primitiveShapes/point/pointIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::pointIndList
-
-Description
-    An IndirectList of points.
-
-Typedef
-    Foam::pointUIndList
-
-Description
-    A UIndirectList of points.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_pointIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of point
     typedef IndirectList<point>  pointIndList;
+
+    //! UIndirectList of point
     typedef UIndirectList<point> pointUIndList;
 }
 

src/OpenFOAM/meshes/primitiveShapes/point/pointList.H

@@ -23,34 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::pointList
-
-Description
-    A List of points.
-
-Typedef
-    Foam::pointUList
-
-Description
-    A UList of points.
-
-Typedef
-    Foam::pointSubList
-
-Description
-    A SubList of points.
-
-Typedef
-    Foam::pointListList
-
-Description
-    A List of pointList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef pointList_H
+#ifndef Foam_pointList_H
-#define pointList_H
+#define Foam_pointList_H
 
 #include "point.H"
 #include "List.H"
@@ -60,10 +36,10 @@ Description
 
 namespace Foam
 {
-    typedef UList<point> pointUList;
+    typedef List<point> pointList;          //!< List of point
-    typedef List<point> pointList;
+    typedef SubList<point> pointSubList;    //!< SubList of point
-    typedef SubList<point> pointSubList;
+    typedef UList<point> pointUList;        //!< UList of point
-    typedef List<pointList> pointListList;
+    typedef List<pointList> pointListList;  //!< List of pointList
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Scalar/lists/scalarIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarIOList
-
-Description
-    Scalar container classes
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef scalarIOList_H
+#ifndef Foam_scalarIOList_H
-#define scalarIOList_H
+#define Foam_scalarIOList_H
 
 #include "scalar.H"
 #include "IOList.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of scalar
     typedef IOList<scalar> scalarIOList;
 }
 

src/OpenFOAM/primitives/Scalar/lists/scalarIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarIndList
-
-Description
-    An IndirectList of scalars.
-
-Typedef
-    Foam::scalarUIndList
-
-Description
-    A UIndirectList of scalars.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_scalarIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of scalar
     typedef IndirectList<scalar>  scalarIndList;
+
+    //! UIndirectList of scalar
     typedef UIndirectList<scalar> scalarUIndList;
 }
 

src/OpenFOAM/primitives/Scalar/lists/scalarList.H

@@ -23,34 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarUList
-
-Description
-    A UList of scalars.
-
-Typedef
-    Foam::scalarList
-
-Description
-    A List of scalars.
-
-Typedef
-    Foam::scalarSubList
-
-Description
-    A SubList of scalars.
-
-Typedef
-    Foam::scalarListList
-
-Description
-    A List of scalarList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef scalarList_H
+#ifndef Foam_scalarList_H
-#define scalarList_H
+#define Foam_scalarList_H
 
 #include "scalar.H"
 #include "List.H"
@@ -60,10 +36,10 @@ Description
 
 namespace Foam
 {
-    typedef UList<scalar> scalarUList;
+    typedef List<scalar> scalarList;            //!< List of scalar
-    typedef List<scalar> scalarList;
+    typedef SubList<scalar> scalarSubList;      //!< SubList of scalar
-    typedef SubList<scalar> scalarSubList;
+    typedef UList<scalar> scalarUList;          //!< UList of scalar
-    typedef List<scalarList> scalarListList;
+    typedef List<scalarList> scalarListList;    //!< List of scalarList
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Scalar/lists/scalarListIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::scalarListIOList
-
-Description
-    Scalar container classes
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef scalarListIOList_H
+#ifndef Foam_scalarListIOList_H
-#define scalarListIOList_H
+#define Foam_scalarListIOList_H
 
 #include "scalarList.H"
 #include "CompactIOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of scalarList
     typedef IOList<scalarList> scalarListIOList;
+
+    //! Compact IO for a List of scalarList
     typedef CompactIOList<scalarList, scalar> scalarListCompactIOList;
 }
 

src/OpenFOAM/primitives/Tensor/lists/sphericalTensorList.H

@@ -23,22 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::sphericalTensorUList
-
-Description
-    A UList of sphericalTensors.
-
-Typedef
-    Foam::sphericalTensorList
-
-Description
-    A List of sphericalTensors.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef sphericalTensorList_H
+#ifndef Foam_sphericalTensorList_H
-#define sphericalTensorList_H
+#define Foam_sphericalTensorList_H
 
 #include "sphericalTensor.H"
 #include "List.H"
@@ -47,9 +35,11 @@ Description
 
 namespace Foam
 {
-    typedef UList<sphericalTensor> sphericalTensorUList;
+    //! List of sphericalTensor
-
     typedef List<sphericalTensor> sphericalTensorList;
+
+    //! UList of sphericalTensor
+    typedef UList<sphericalTensor> sphericalTensorUList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Tensor/lists/symmTensorList.H

@@ -23,22 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::symmTensorUList
-
-Description
-    A UList of symmTensors.
-
-Typedef
-    Foam::symmTensorList
-
-Description
-    A List of symmTensors.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef symmTensorList_H
+#ifndef Foam_symmTensorList_H
-#define symmTensorList_H
+#define Foam_symmTensorList_H
 
 #include "symmTensor.H"
 #include "List.H"
@@ -47,9 +35,8 @@ Description
 
 namespace Foam
 {
-    typedef UList<symmTensor> symmTensorUList;
+    typedef List<symmTensor> symmTensorList;    //!< List of symmTensor
-
+    typedef UList<symmTensor> symmTensorUList;  //!< UList of symmTensor
-    typedef List<symmTensor> symmTensorList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Tensor/lists/tensorList.H

@@ -23,22 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::tensorUList
-
-Description
-    A UList of tensors.
-
-Typedef
-    Foam::tensorList
-
-Description
-    A List of tensors.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef tensorList_H
+#ifndef Foam_tensorList_H
-#define tensorList_H
+#define Foam_tensorList_H
 
 #include "tensor.H"
 #include "List.H"
@@ -47,9 +35,8 @@ Description
 
 namespace Foam
 {
-    typedef UList<tensor> tensorUList;
+    typedef List<tensor> tensorList;        //!< List of tensor
-
+    typedef UList<tensor> tensorUList;      //!< UList of tensor
-    typedef List<tensor> tensorList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Vector/lists/vectorIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorIOList
-
-Description
-    Vector container classes
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vectorIOList_H
+#ifndef Foam_vectorIOList_H
-#define vectorIOList_H
+#define Foam_vectorIOList_H
 
 #include "vector.H"
 #include "IOList.H"
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of vector
     typedef IOList<vector> vectorIOList;
 }
 

src/OpenFOAM/primitives/Vector/lists/vectorIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorIndList
-
-Description
-    An IndirectList of vectors.
-
-Typedef
-    Foam::vectorUIndList
-
-Description
-    A UIndirectList of vectors.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_vectorIndList_H
@@ -48,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of vector
     typedef IndirectList<vector>  vectorIndList;
+
+    //! UIndirectList of vector
     typedef UIndirectList<vector> vectorUIndList;
 }
 

src/OpenFOAM/primitives/Vector/lists/vectorList.H

@@ -23,34 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorUList
-
-Description
-    A UList of vectors.
-
-Typedef
-    Foam::vectorList
-
-Description
-    A List of vectors.
-
-Typedef
-    Foam::vectorSubList
-
-Description
-    A SubList of vectors.
-
-Typedef
-    Foam::vectorListList
-
-Description
-    A List of vectorList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vectorList_H
+#ifndef Foam_vectorList_H
-#define vectorList_H
+#define Foam_vectorList_H
 
 #include "vector.H"
 #include "List.H"
@@ -60,10 +36,10 @@ Description
 
 namespace Foam
 {
-    typedef UList<vector> vectorUList;
+    typedef List<vector> vectorList;            //!< List of vector
-    typedef List<vector> vectorList;
+    typedef SubList<vector> vectorSubList;      //!< SubList of vector
-    typedef SubList<vector> vectorSubList;
+    typedef UList<vector> vectorUList;          //!< UList of vector
-    typedef List<vectorList> vectorListList;
+    typedef List<vectorList> vectorListList;    //!< List of vectorList
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/Vector/lists/vectorListIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::vectorListIOList
-
-Description
-    Lists of vectors container class
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef vectorListIOList_H
+#ifndef Foam_vectorListIOList_H
-#define vectorListIOList_H
+#define Foam_vectorListIOList_H
 
 #include "vectorList.H"
 #include "CompactIOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of vectorList
     typedef IOList<vectorList> vectorListIOList;
+
+    //! Compact IO for a List of vectorList
     typedef CompactIOList<vectorList, vector> vectorListCompactIOList;
 }
 

src/OpenFOAM/primitives/bools/lists/boolList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::boolListList
-
-Description
-    A List of boolList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef boolList_H
+#ifndef Foam_boolList_H
-#define boolList_H
+#define Foam_boolList_H
 
 #include "bool.H"
 #include "List.H"
@@ -41,10 +35,11 @@ Description
 
 namespace Foam
 {
-    // boolUlist   = defined in UList.H
     // boolList    = defined in List.H
     // boolSubList = defined in SubList.H
+    // boolUlist   = defined in UList.H
 
+    //! List of boolList
     typedef List<List<bool>> boolListList;
 }
 

src/OpenFOAM/primitives/chars/lists/charList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::charListList
-
-Description
-    A List of charList.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef charList_H
+#ifndef Foam_charList_H
-#define charList_H
+#define Foam_charList_H
 
 #include "char.H"
 #include "List.H"
@@ -42,10 +36,11 @@ Description
 
 namespace Foam
 {
-    // charUList   = defined in UList.H
     // charList    = defined in List.H
     // charSubList = defined in SubList.H
+    // charUList   = defined in UList.H
 
+    //! List of charList
     typedef List<charList> charListList;
 }
 

src/OpenFOAM/primitives/ints/lists/labelIOList.H

@@ -23,12 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelIOList
-
-Description
-    Label container classes
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_labelIOList_H
@@ -41,6 +35,7 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of label
     typedef IOList<label> labelIOList;
 }
 

src/OpenFOAM/primitives/ints/lists/labelIndList.H

@@ -23,18 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelIndList
-
-Description
-    A IndirectList of labels.
-
-Typedef
-    Foam::labelUIndList
-
-Description
-    An UIndirectList of labels.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_labelIndList_H
@@ -48,8 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IndirectList of label
     typedef IndirectList<label>  labelIndList;
-    // labelUIndList is defined in UIndirectList itself
+
+    // labelUIndList = defined in IndirectList.H
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/ints/lists/labelList.H

@@ -24,18 +24,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelListList
-
-Description
-    A List of labelList.
-
-Typedef
-    Foam::labelListListList
-
-Description
-    A List of labelListList.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_labelList_H
@@ -49,11 +37,14 @@ Description
 
 namespace Foam
 {
-    // labelUList   = defined in UList.H
     // labelList    = defined in List.H
     // labelSubList = defined in SubList.H
+    // labelUList   = defined in UList.H
 
+    //! List of labelList
     typedef List<labelList> labelListList;
+
+    //! List of labelListList
     typedef List<labelListList> labelListListList;
 
 

src/OpenFOAM/primitives/ints/lists/labelListIOList.H

@@ -23,12 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelListIOList
-
-Description
-    Label container classes
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_labelListIOList_H
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of labelList
     typedef IOList<labelList> labelListIOList;
+
+    //! Compact IO for a List of labelList
     typedef CompactIOList<labelList, label> labelListCompactIOList;
 }
 

src/OpenFOAM/primitives/strings/lists/fileNameList.H

@@ -23,28 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::fileNameUList
-
-Description
-    A UList of fileNames.
-
-Typedef
-    Foam::fileNameList
-
-Description
-    A List of fileNames.
-
-Typedef
-    Foam::fileNameSubList
-
-Description
-    A SubList of fileNames.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef fileNameList_H
+#ifndef Foam_fileNameList_H
-#define fileNameList_H
+#define Foam_fileNameList_H
 
 #include "fileName.H"
 #include "List.H"
@@ -54,9 +36,9 @@ Description
 
 namespace Foam
 {
-    typedef UList<fileName> fileNameUList;
+    typedef List<fileName> fileNameList;        //!< List of fileName
-    typedef List<fileName> fileNameList;
+    typedef SubList<fileName> fileNameSubList;  //!< SubList of fileName
-    typedef SubList<fileName> fileNameSubList;
+    typedef UList<fileName> fileNameUList;      //!< UList of fileName
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/strings/lists/stringList.H

@@ -23,24 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::stringUList
-
-Description
-    A UList of strings.
-
-Typedef
-    Foam::stringList
-
-Description
-    A List of strings.
-
-Typedef
-    Foam::stringSubList
-
-Description
-    A SubList of strings.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_stringList_H
@@ -54,9 +36,9 @@ Description
 
 namespace Foam
 {
-    typedef UList<string> stringUList;
+    typedef List<string> stringList;        //!< List of string
-    typedef List<string> stringList;
+    typedef SubList<string> stringSubList;  //!< SubList of string
-    typedef SubList<string> stringSubList;
+    typedef UList<string> stringUList;      //!< UList of string
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/strings/lists/wordList.H

@@ -23,24 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::wordUList
-
-Description
-    A UList of words.
-
-Typedef
-    Foam::wordList
-
-Description
-    A List of words.
-
-Typedef
-    Foam::wordSubList
-
-Description
-    A SubList of words.
-
 \*---------------------------------------------------------------------------*/
 
 #ifndef Foam_wordList_H
@@ -54,9 +36,9 @@ Description
 
 namespace Foam
 {
-    typedef UList<word> wordUList;
+    typedef List<word> wordList;            //!< List of word
-    typedef List<word> wordList;
+    typedef SubList<word> wordSubList;      //!< SubList of word
-    typedef SubList<word> wordSubList;
+    typedef UList<word> wordUList;          //!< UList of word
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/strings/lists/wordReList.H

@@ -1,58 +0,0 @@
-/*---------------------------------------------------------------------------*\
-  =========                 |
-  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
-   \\    /   O peration     |
-    \\  /    A nd           | www.openfoam.com
-     \\/     M anipulation  |
--------------------------------------------------------------------------------
-    Copyright (C) 2011 OpenFOAM Foundation
--------------------------------------------------------------------------------
-License
-    This file is part of OpenFOAM.
-
-    OpenFOAM is free software: you can redistribute it and/or modify it
-    under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
-    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-    for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
-
-Typedef
-    Foam::wordReUList
-
-Description
-    A UList of wordRe (word or regular expression)
-
-Typedef
-    Foam::wordReList
-
-Description
-    A List of wordRe (word or regular expression)
-
-\*---------------------------------------------------------------------------*/
-
-#ifndef Foam_wordReList_H
-#define Foam_wordReList_H
-
-#include "wordRe.H"
-#include "List.H"
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-namespace Foam
-{
-    typedef UList<wordRe> wordReUList;
-    typedef List<wordRe> wordReList;
-}
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //

src/OpenFOAM/primitives/strings/string/stringIOList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::stringIOList
-
-Description
-    IO of a list of strings
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef stringIOList_H
+#ifndef Foam_stringIOList_H
-#define stringIOList_H
+#define Foam_stringIOList_H
 
 #include "stringList.H"
 #include "IOList.H"
@@ -41,7 +35,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of string
     typedef IOList<string> stringIOList;
+
+    //! IO for a List of stringList
     typedef IOList<stringList> stringListIOList;
 }
 

src/OpenFOAM/primitives/strings/word/wordIOList.H

@@ -24,16 +24,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::wordIOList
-
-Description
-    IO of a list of words
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef wordIOList_H
+#ifndef Foam_wordIOList_H
-#define wordIOList_H
+#define Foam_wordIOList_H
 
 #include "wordList.H"
 #include "IOList.H"
@@ -42,7 +36,10 @@ Description
 
 namespace Foam
 {
+    //! IO for a List of word
     typedef IOList<word> wordIOList;
+
+    //! IO for a List of wordList
     typedef IOList<wordList> wordListIOList;
 
     //- Print a List of wordList as a table

src/OpenFOAM/primitives/strings/wordRes/wordRes.H

@@ -5,7 +5,7 @@
     \\  /    A nd           | www.openfoam.com
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
-    Copyright (C) 2016-2022 OpenCFD Ltd.
+    Copyright (C) 2016-2023 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -38,13 +38,19 @@ SourceFiles
 #ifndef Foam_wordRes_H
 #define Foam_wordRes_H
 
-#include "wordReList.H"
+#include "wordRe.H"
+#include "List.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
 
+// List types
+typedef List<wordRe> wordReList;    //!< List of wordRe (word or regex)
+typedef UList<wordRe> wordReUList;  //!< UList of wordRe (word or regex)
+
+
 /*---------------------------------------------------------------------------*\
                            Class wordRes Declaration
 \*---------------------------------------------------------------------------*/

src/OpenFOAM/primitives/tuples/labelPair.H

@@ -23,47 +23,23 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::labelPairPair
-
-Description
-    A pair of labelPairs.
-
-Typedef
-    Foam::labelPairList
-
-Description
-    List of labelPairs.
-
-Typedef
-    Foam::labelPairUList
-
-Description
-    UList of labelPairs.
-
-Typedef
-    Foam::labelPairSubList
-
-Description
-    A SubList of labelPairs.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef labelPair_H
+#ifndef Foam_labelPair_H
-#define labelPair_H
+#define Foam_labelPair_H
 
+#include "Pair.H"
 #include "List.H"
 #include "SubList.H"
-#include "Pair.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
-    typedef Pair<labelPair> labelPairPair;
+    typedef Pair<labelPair> labelPairPair;      //!< Pair of labelPair
-    typedef List<labelPair> labelPairList;
+    typedef List<labelPair> labelPairList;      //!< List of labelPair
-    typedef UList<labelPair> labelPairUList;
+    typedef UList<labelPair> labelPairUList;    //!< UList of labelPair
-    typedef SubList<labelPair> labelPairSubList;
+
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/OpenFOAM/primitives/tuples/wordPair.H

@@ -23,47 +23,22 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::wordPairPair
-
-Description
-    A pair of wordPairs.
-
-Typedef
-    Foam::wordPairList
-
-Description
-    List of wordPairs.
-
-Typedef
-    Foam::wordPairUList
-
-Description
-    UList of wordPairs.
-
-Typedef
-    Foam::wordPairSubList
-
-Description
-    A SubList of wordPairs.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef wordPair_H
+#ifndef Foam_wordPair_H
-#define wordPair_H
+#define Foam_wordPair_H
 
+#include "Pair.H"
 #include "List.H"
 #include "SubList.H"
-#include "Pair.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
 {
-    typedef Pair<wordPair> wordPairPair;
+    typedef Pair<wordPair> wordPairPair;        //!< Pair of wordPair
-    typedef List<wordPair> wordPairList;
+    typedef List<wordPair> wordPairList;        //!< List of wordPair
-    typedef UList<wordPair> wordPairUList;
+    typedef UList<wordPair> wordPairUList;      //!< UList of wordPair
-    typedef SubList<wordPair> wordPairSubList;
 }
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/dynamicMesh/polyMeshAdder/faceCoupleInfo.H

@@ -136,6 +136,7 @@ SourceFiles
 #ifndef Foam_faceCoupleInfo_H
 #define Foam_faceCoupleInfo_H
 
+#include "edgeHashes.H"
 #include "pointField.H"
 #include "indirectPrimitivePatch.H"
 #include "primitivePatch.H"
@@ -145,8 +146,6 @@ SourceFiles
 namespace Foam
 {
 
-typedef HashTable<labelList, edge, Hash<edge>> edgeLookup;
-
 // Forward Declarations
 class face;
 class primitiveMesh;
@@ -204,7 +203,7 @@ class faceCoupleInfo
             //- For edges originating from splitting of edges:
             //  given the two endpoints of the unsplit edge give the list
             //  of inbetween vertices
-            edgeLookup cutEdgeToPoints_;
+            EdgeMap<labelList> cutEdgeToPoints_;
 
 
     // Private Member Functions
@@ -499,13 +498,11 @@ public:
                 return slaveToCutPoints_;
             }
 
-            //- From two cut points (original edge) to list of inserted
+            //- From two cut points (original edge) to list of inserted points
-            //  points
+            const EdgeMap<labelList>& cutEdgeToPoints() const noexcept
-            const edgeLookup& cutEdgeToPoints() const
             {
                 return cutEdgeToPoints_;
             }
-
  };
 
 

src/dynamicMesh/polyMeshAdder/polyMeshAdder.C

@@ -400,7 +400,7 @@ Foam::labelList Foam::polyMeshAdder::getFaceOrder
 // edge the points introduced inbetween the endpoints.
 void Foam::polyMeshAdder::insertVertices
 (
-    const edgeLookup& cutEdgeToPoints,
+    const EdgeMap<labelList>& cutEdgeToPoints,
     const Map<label>& meshToMaster,
     const labelList& masterToCutPoints,
     const face& masterF,
@@ -764,7 +764,8 @@ void Foam::polyMeshAdder::mergePrimitives
     {
         // From two cut-points to labels of cut-points inbetween.
         // (in order: from e[0] to e[1]
-        const edgeLookup& cutEdgeToPoints = coupleInfo.cutEdgeToPoints();
+        const EdgeMap<labelList>& cutEdgeToPoints
+            = coupleInfo.cutEdgeToPoints();
 
         // Get map of master face (in mesh labels) that are in cut. These faces
         // do not need to be renumbered.

src/dynamicMesh/polyMeshAdder/polyMeshAdder.H

@@ -38,8 +38,8 @@ SourceFiles
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef polyMeshAdder_H
+#ifndef Foam_polyMeshAdder_H
-#define polyMeshAdder_H
+#define Foam_polyMeshAdder_H
 
 #include "autoPtr.H"
 #include "polyMesh.H"
@@ -120,7 +120,7 @@ class polyMeshAdder
         // edge the points introduced inbetween the endpoints.
         static void insertVertices
         (
-            const edgeLookup& cutEdgeToPoints,
+            const EdgeMap<labelList>& cutEdgeToPoints,
             const Map<label>& meshToMaster,
             const labelList& masterToCutPoints,
             const face& masterFace,

src/meshTools/multiWorld/multiWorldConnectionsObject.H

@@ -41,7 +41,7 @@ SourceFiles
 #define meshObjects_multiWorldConnections_H
 
 #include "MeshObject.H"
-#include "EdgeMap.H"
+#include "edgeHashes.H"
 #include "Time.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/surfMesh/surfZone/surfZoneList.H

@@ -23,15 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::surfZoneList
-
-Description
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef surfZoneList_H
+#ifndef Foam_surfZoneList_H
-#define surfZoneList_H
+#define Foam_surfZoneList_H
 
 #include "surfZone.H"
 #include "List.H"
@@ -41,14 +36,8 @@ Description
 
 namespace Foam
 {
-
+    typedef List<surfZone> surfZoneList;    //!< List of surfZone
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+}
-
-typedef List<surfZone>  surfZoneList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 

src/surfMesh/triSurface/patches/surfacePatchList.H

@@ -23,16 +23,10 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Typedef
-    Foam::surfacePatchList
-
-Description
-    A List of surfacePatch.
-
 \*---------------------------------------------------------------------------*/
 
-#ifndef surfacePatchList_H
+#ifndef Foam_surfacePatchList_H
-#define surfacePatchList_H
+#define Foam_surfacePatchList_H
 
 #include "surfacePatch.H"
 #include "List.H"
@@ -41,14 +35,8 @@ Description
 
 namespace Foam
 {
-
+    typedef List<surfacePatch> surfacePatchList;  //!< List of surfacePatch
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+}
-
-typedef List<surfacePatch> surfacePatchList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //