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 labelIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/quaternionField/quaternionIOField.H b/src/OpenFOAM/fields/Fields/quaternionField/quaternionIOField.H
index 27c3587d2e..4271c61c11 100644
--- a/src/OpenFOAM/fields/Fields/quaternionField/quaternionIOField.H
+++ b/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 .
-Typedef
- Foam::quaternionIOField
-
-Description
- quaternionField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef quaternionIOField_H
-#define quaternionIOField_H
+#ifndef Foam_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 quaternionIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/scalarField/scalarFieldIOField.H b/src/OpenFOAM/fields/Fields/scalarField/scalarFieldIOField.H
index 756ff43110..e20f984c81 100644
--- a/src/OpenFOAM/fields/Fields/scalarField/scalarFieldIOField.H
+++ b/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 .
-Typedef
- Foam::scalarFieldIOField
-
-Description
- scalarFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef scalarFieldIOField_H
-#define scalarFieldIOField_H
+#ifndef Foam_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 scalarFieldIOField;
+
+ //! Compact IO for a Field of scalarField
typedef CompactIOField scalarFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/scalarField/scalarIOField.H b/src/OpenFOAM/fields/Fields/scalarField/scalarIOField.H
index 9e594c6e8e..a3a90362f5 100644
--- a/src/OpenFOAM/fields/Fields/scalarField/scalarIOField.H
+++ b/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 .
-Typedef
- Foam::scalarIOField
-
-Description
- scalarField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef scalarIOField_H
-#define scalarIOField_H
+#ifndef Foam_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 scalarIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorFieldIOField.H b/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorFieldIOField.H
index b7a9bd4699..c39e70d194 100644
--- a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorFieldIOField.H
+++ b/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 .
-Typedef
- Foam::sphericalTensorFieldIOField
-
-Description
- sphericalTensorFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef sphericalTensorFieldIOField_H
-#define sphericalTensorFieldIOField_H
+#ifndef Foam_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 sphericalTensorFieldIOField;
+ //! Compact IO for a Field of sphericalTensorField
typedef CompactIOField
sphericalTensorFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorIOField.H b/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorIOField.H
index 31e780a7e5..81e6d1289f 100644
--- a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorIOField.H
+++ b/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 .
-Typedef
- Foam::sphericalTensorIOField
-
-Description
- sphericalTensorField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef sphericalTensorIOField_H
-#define sphericalTensorIOField_H
+#ifndef Foam_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 sphericalTensorIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorFieldIOField.H b/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorFieldIOField.H
index 2d078aa2a5..9b7d896cb3 100644
--- a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorFieldIOField.H
+++ b/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 .
-Typedef
- Foam::symmTensorFieldIOField
-
-Description
- symmTensorFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef symmTensorFieldIOField_H
-#define symmTensorFieldIOField_H
+#ifndef Foam_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 symmTensorFieldIOField;
+
+ //! Compact IO for a Field of symmTensorField
typedef CompactIOField
symmTensorFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorIOField.H b/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorIOField.H
index e61a43dc2c..ef9548424a 100644
--- a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorIOField.H
+++ b/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 .
-Typedef
- Foam::symmTensorIOField
-
-Description
- symmTensorField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef symmTensorIOField_H
-#define symmTensorIOField_H
+#ifndef Foam_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 symmTensorIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/tensorField/tensorFieldIOField.H b/src/OpenFOAM/fields/Fields/tensorField/tensorFieldIOField.H
index 53c423174a..ce8fed13d7 100644
--- a/src/OpenFOAM/fields/Fields/tensorField/tensorFieldIOField.H
+++ b/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 .
-Typedef
- Foam::tensorFieldIOField
-
-Description
- tensorFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef tensorFieldIOField_H
-#define tensorFieldIOField_H
+#ifndef Foam_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 tensorFieldIOField;
+
+ //! Compact IO for a Field of tensorField
typedef CompactIOField tensorFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/tensorField/tensorIOField.H b/src/OpenFOAM/fields/Fields/tensorField/tensorIOField.H
index ece28fc0fd..32b8ae0392 100644
--- a/src/OpenFOAM/fields/Fields/tensorField/tensorIOField.H
+++ b/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 .
-Typedef
- Foam::tensorIOField
-
-Description
- tensorField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef tensorIOField_H
-#define tensorIOField_H
+#ifndef Foam_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 tensorIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/triadField/triadIOField.H b/src/OpenFOAM/fields/Fields/triadField/triadIOField.H
index c36981cec3..94c87bdc7c 100644
--- a/src/OpenFOAM/fields/Fields/triadField/triadIOField.H
+++ b/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 .
-Typedef
- Foam::triadIOField
-
-Description
- triadField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef triadIOField_H
-#define triadIOField_H
+#ifndef Foam_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 triadIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldIOField.H b/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldIOField.H
index 76eaf2bf4d..b0d0054783 100644
--- a/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldIOField.H
+++ b/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 .
-Typedef
- Foam::vector2DFieldIOField
-
-Description
- vector2DFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef vector2DFieldIOField_H
-#define vector2DFieldIOField_H
+#ifndef Foam_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 vector2DFieldIOField;
+
+ //! Compact IO for a Field of vector2DField
typedef CompactIOField vector2DFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/vector2DField/vector2DIOField.H b/src/OpenFOAM/fields/Fields/vector2DField/vector2DIOField.H
index f05632679d..e1d7dd93f8 100644
--- a/src/OpenFOAM/fields/Fields/vector2DField/vector2DIOField.H
+++ b/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 .
-Typedef
- Foam::vector2DIOField
-
-Description
- vector2DField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef vector2DIOField_H
-#define vector2DIOField_H
+#ifndef Foam_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 vector2DIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/vectorField/vectorFieldIOField.H b/src/OpenFOAM/fields/Fields/vectorField/vectorFieldIOField.H
index d0393f2e21..a370af612e 100644
--- a/src/OpenFOAM/fields/Fields/vectorField/vectorFieldIOField.H
+++ b/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 .
-Typedef
- Foam::vectorFieldIOField
-
-Description
- vectorFieldField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef vectorFieldIOField_H
-#define vectorFieldIOField_H
+#ifndef Foam_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 vectorFieldIOField;
+
+ //! Compact IO for a Field of vectorField
typedef CompactIOField vectorFieldCompactIOField;
}
diff --git a/src/OpenFOAM/fields/Fields/vectorField/vectorIOField.H b/src/OpenFOAM/fields/Fields/vectorField/vectorIOField.H
index ee27ed011d..b70f4c4ccd 100644
--- a/src/OpenFOAM/fields/Fields/vectorField/vectorIOField.H
+++ b/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 .
-Typedef
- Foam::vectorIOField
-
-Description
- vectorField with IO.
-
\*---------------------------------------------------------------------------*/
-#ifndef vectorIOField_H
-#define vectorIOField_H
+#ifndef Foam_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 vectorIOField;
}
diff --git a/src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatchList.H b/src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatchList.H
index c49c03a2ef..49958c5abb 100644
--- a/src/OpenFOAM/meshes/Identifiers/surface/geometricSurfacePatchList.H
+++ b/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 .
-Typedef
- Foam::geometricSurfacePatchList
-
-Description
- A List of geometricSurfacePatch.
-
\*---------------------------------------------------------------------------*/
-#ifndef geometricSurfacePatchList_H
-#define geometricSurfacePatchList_H
+#ifndef Foam_geometricSurfacePatchList_H
+#define Foam_geometricSurfacePatchList_H
#include "geometricSurfacePatch.H"
#include "List.H"
@@ -41,14 +35,9 @@ Description
namespace Foam
{
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-typedef List geometricSurfacePatchList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
+ //! List of geometricSurfacePatch
+ typedef List geometricSurfacePatchList;
+}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/Identifiers/surface/surfZoneIdentifierList.H b/src/OpenFOAM/meshes/Identifiers/surface/surfZoneIdentifierList.H
index a7da0c83a6..4945164206 100644
--- a/src/OpenFOAM/meshes/Identifiers/surface/surfZoneIdentifierList.H
+++ b/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 .
-Typedef
- Foam::surfZoneIdentifierList
-
-Description
- A List of surfZoneIdentifier.
-
\*---------------------------------------------------------------------------*/
-#ifndef surfZoneIdentifierList_H
-#define surfZoneIdentifierList_H
+#ifndef Foam_surfZoneIdentifierList_H
+#define Foam_surfZoneIdentifierList_H
#include "surfZoneIdentifier.H"
#include "List.H"
@@ -41,14 +35,9 @@ Description
namespace Foam
{
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-typedef List surfZoneIdentifierList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
+ //! List of surfZoneIdentifier
+ typedef List surfZoneIdentifierList;
+}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/cell/cellIOList.H b/src/OpenFOAM/meshes/meshShapes/cell/cellIOList.H
index 0de9601fde..0b38fd224d 100644
--- a/src/OpenFOAM/meshes/meshShapes/cell/cellIOList.H
+++ b/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 .
-Typedef
- Foam::cellIOList
-
-Description
- IOList of cells
-
\*---------------------------------------------------------------------------*/
-#ifndef cellIOList_H
-#define cellIOList_H
+#ifndef Foam_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 cellIOList;
+
+ //! Compact IO for a List of cell
typedef CompactIOList cellCompactIOList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/cell/cellIndList.H b/src/OpenFOAM/meshes/meshShapes/cell/cellIndList.H
index 29b86927b2..8cd1b7de60 100644
--- a/src/OpenFOAM/meshes/meshShapes/cell/cellIndList.H
+++ b/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 .
-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 cellIndList;
+
+ //! UIndirectList of cell
typedef UIndirectList cellUIndList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/cell/cellList.H b/src/OpenFOAM/meshes/meshShapes/cell/cellList.H
index fcb498505c..d4918ae9af 100644
--- a/src/OpenFOAM/meshes/meshShapes/cell/cellList.H
+++ b/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 .
-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
-#define cellList_H
+#ifndef Foam_cellList_H
+#define Foam_cellList_H
#include "cell.H"
-#include "List.H"
-#include "SubList.H"
#include "cellListFwd.H"
#endif
diff --git a/src/OpenFOAM/meshes/meshShapes/cell/cellListFwd.H b/src/OpenFOAM/meshes/meshShapes/cell/cellListFwd.H
index 29f0ce8ec2..6422c07ec4 100644
--- a/src/OpenFOAM/meshes/meshShapes/cell/cellListFwd.H
+++ b/src/OpenFOAM/meshes/meshShapes/cell/cellListFwd.H
@@ -31,8 +31,8 @@ Description
\*---------------------------------------------------------------------------*/
-#ifndef cellListFwd_H
-#define cellListFwd_H
+#ifndef Foam_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 cellUList;
- typedef List cellList;
- typedef SubList cellSubList;
- typedef List cellListList;
+ typedef List cellList; //!< List of cell
+ typedef SubList cellSubList; //!< SubList of cell
+ typedef UList cellUList; //!< UList of cell
+ typedef List cellListList; //!< List of cellList
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeIOList.H b/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeIOList.H
index 2509c3197d..e0238de265 100644
--- a/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeIOList.H
+++ b/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 .
-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 cellShapeIOList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeList.H b/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeList.H
index 87df3f697a..60776d9eeb 100644
--- a/src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeList.H
+++ b/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 .
-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 cellShapeList;
- typedef PtrList cellShapeListList;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H b/src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H
deleted file mode 100644
index 2667bdb1b9..0000000000
--- a/src/OpenFOAM/meshes/meshShapes/edge/EdgeMap.H
+++ /dev/null
@@ -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 .
-
-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 EdgeMap
-:
- public HashTable>
-{
-public:
-
- //- Inherit constructors from HashTable
- using HashTable>::HashTable;
-
-};
-
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edgeHashes.H b/src/OpenFOAM/meshes/meshShapes/edge/edgeHashes.H
index 903614c72b..b82e85ef4a 100644
--- a/src/OpenFOAM/meshes/meshShapes/edge/edgeHashes.H
+++ b/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 .
-Typedef
- Foam::edgeHashSet
+Class
+ Foam::EdgeMap
Description
- A HashSet for an edge.
- The hashing on an edge is commutative.
+ Map from edge (expressed as its endpoints) to value.
+ 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
-#define edgeHashes_H
+#ifndef Foam_edgeHashes_H
+#define Foam_edgeHashes_H
#include "edge.H"
-#include "EdgeMap.H"
#include "HashSet.H"
+#include "HashTable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
- // Alternative:
- // template
- // using EdgeMap = HashTable>;
- //- A HashSet with edge for its key.
- typedef HashSet> edgeHashSet;
+// Typedefs
-}
+//! A HashSet with edge for its key. Hashing (and ==) on an edge is symmetric.
+typedef HashSet> edgeHashSet;
+
+
+/*---------------------------------------------------------------------------*\
+ Class EdgeMap Declaration
+\*---------------------------------------------------------------------------*/
+
+template
+class EdgeMap
+:
+ public HashTable>
+{
+public:
+
+ // Constructors
+
+ //- Inherit constructors from HashTable
+ using HashTable>::HashTable;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H b/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H
index 8f76c3dd7b..7c5cfe725f 100644
--- a/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H
+++ b/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 .
-Typedef
- Foam::edgeIOList
-
-Description
- An IOList of edges
-
\*---------------------------------------------------------------------------*/
-#ifndef edgeIOList_H
-#define edgeIOList_H
+#ifndef Foam_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 edgeIOList;
+
+ //! Compact IO for a List of edge
typedef CompactIOList edgeCompactIOList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edgeIndList.H b/src/OpenFOAM/meshes/meshShapes/edge/edgeIndList.H
index 0ad10c3252..40b8f30eeb 100644
--- a/src/OpenFOAM/meshes/meshShapes/edge/edgeIndList.H
+++ b/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 .
-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 edgeIndList;
+
+ //! UIndirectList of edge
typedef UIndirectList edgeUIndList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edgeList.H b/src/OpenFOAM/meshes/meshShapes/edge/edgeList.H
index c1e004ea49..745aa86d58 100644
--- a/src/OpenFOAM/meshes/meshShapes/edge/edgeList.H
+++ b/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 .
-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
-#define edgeList_H
+#ifndef Foam_edgeList_H
+#define Foam_edgeList_H
#include "edge.H"
+#include "List.H"
#include "SubList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
- typedef UList edgeUList;
- typedef List edgeList;
- typedef SubList edgeSubList;
- typedef List edgeListList;
+ typedef List edgeList; //!< List of edge
+ typedef SubList edgeSubList; //!< SubList of edge
+ typedef UList edgeUList; //!< UList of edge
+ typedef List edgeListList; //!< List of edgeList
+
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/face/faceIOList.H b/src/OpenFOAM/meshes/meshShapes/face/faceIOList.H
index 51d08b73b4..e36e17323e 100644
--- a/src/OpenFOAM/meshes/meshShapes/face/faceIOList.H
+++ b/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 .
-Typedef
- Foam::faceIOList
-
-Description
- IOList of faces
-
\*---------------------------------------------------------------------------*/
-#ifndef faceIOList_H
-#define faceIOList_H
+#ifndef Foam_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 faceIOList;
+
+ //! Compact IO for a List of face
typedef CompactIOList faceCompactIOList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/face/faceIndList.H b/src/OpenFOAM/meshes/meshShapes/face/faceIndList.H
index f885a58631..186da2ce50 100644
--- a/src/OpenFOAM/meshes/meshShapes/face/faceIndList.H
+++ b/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 .
-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 faceIndList;
+
+ //! UIndirectList of face.
typedef UIndirectList faceUIndList;
}
diff --git a/src/OpenFOAM/meshes/meshShapes/face/faceList.H b/src/OpenFOAM/meshes/meshShapes/face/faceList.H
index ba4517613e..83ca27b032 100644
--- a/src/OpenFOAM/meshes/meshShapes/face/faceList.H
+++ b/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 .
-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
-#define faceList_H
+#ifndef Foam_faceList_H
+#define Foam_faceList_H
#include "face.H"
-#include "List.H"
-#include "SubList.H"
#include "faceListFwd.H"
#endif
diff --git a/src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H b/src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H
index c1ac06591b..9e77143cad 100644
--- a/src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H
+++ b/src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H
@@ -31,8 +31,8 @@ Description
\*---------------------------------------------------------------------------*/
-#ifndef faceListFwd_H
-#define faceListFwd_H
+#ifndef Foam_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 faceUList;
- typedef List faceList;
- typedef SubList faceSubList;
- typedef List faceListList;
+ typedef List faceList; //!< List of faces
+ typedef SubList faceSubList; //!< SubList of faces
+ typedef UList faceUList; //!< UList of faces
+ typedef List faceListList; //!< List of faceList
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/tetCell/tetCellList.H b/src/OpenFOAM/meshes/meshShapes/tetCell/tetCellList.H
index 03f9d1d5af..4781adbe4d 100644
--- a/src/OpenFOAM/meshes/meshShapes/tetCell/tetCellList.H
+++ b/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 .
-Typedef
- Foam::tetCellList
-
-Description
- list of tetCells
-
\*---------------------------------------------------------------------------*/
-#ifndef tetCellList_H
-#define tetCellList_H
+#ifndef Foam_tetCellList_H
+#define Foam_tetCellList_H
#include "tetCell.H"
#include "List.H"
@@ -41,7 +35,7 @@ Description
namespace Foam
{
- typedef List tetCellList;
+ typedef List tetCellList; //!< List of tetCell
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/meshShapes/triFace/triFaceList.H b/src/OpenFOAM/meshes/meshShapes/triFace/triFaceList.H
index a5bc0967fc..f002a3ab9f 100644
--- a/src/OpenFOAM/meshes/meshShapes/triFace/triFaceList.H
+++ b/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 .
-Typedef
- Foam::triFaceList
-
-Description
- list of triFaces
-
\*---------------------------------------------------------------------------*/
-#ifndef triFaceList_H
-#define triFaceList_H
+#ifndef Foam_triFaceList_H
+#define Foam_triFaceList_H
#include "triFace.H"
#include "List.H"
@@ -41,7 +35,7 @@ Description
namespace Foam
{
- typedef List triFaceList;
+ typedef List triFaceList; //!< List of triFace
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointIndexHitIOList.H b/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointIndexHitIOList.H
index 2891c5a15b..5024596f27 100644
--- a/src/OpenFOAM/meshes/primitiveShapes/objectHit/pointIndexHitIOList.H
+++ b/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 .
-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 pointIndexHitIOList;
}
diff --git a/src/OpenFOAM/meshes/primitiveShapes/point/pointIndList.H b/src/OpenFOAM/meshes/primitiveShapes/point/pointIndList.H
index aa564e7f82..9ba50f6c23 100644
--- a/src/OpenFOAM/meshes/primitiveShapes/point/pointIndList.H
+++ b/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 .
-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 pointIndList;
+
+ //! UIndirectList of point
typedef UIndirectList pointUIndList;
}
diff --git a/src/OpenFOAM/meshes/primitiveShapes/point/pointList.H b/src/OpenFOAM/meshes/primitiveShapes/point/pointList.H
index 840e655d0a..603f159fc9 100644
--- a/src/OpenFOAM/meshes/primitiveShapes/point/pointList.H
+++ b/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 .
-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
-#define pointList_H
+#ifndef Foam_pointList_H
+#define Foam_pointList_H
#include "point.H"
#include "List.H"
@@ -60,10 +36,10 @@ Description
namespace Foam
{
- typedef UList pointUList;
- typedef List pointList;
- typedef SubList pointSubList;
- typedef List pointListList;
+ typedef List pointList; //!< List of point
+ typedef SubList pointSubList; //!< SubList of point
+ typedef UList pointUList; //!< UList of point
+ typedef List pointListList; //!< List of pointList
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Scalar/lists/scalarIOList.H b/src/OpenFOAM/primitives/Scalar/lists/scalarIOList.H
index 7abd270c7c..3de82d9565 100644
--- a/src/OpenFOAM/primitives/Scalar/lists/scalarIOList.H
+++ b/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 .
-Typedef
- Foam::scalarIOList
-
-Description
- Scalar container classes
-
\*---------------------------------------------------------------------------*/
-#ifndef scalarIOList_H
-#define scalarIOList_H
+#ifndef Foam_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 scalarIOList;
}
diff --git a/src/OpenFOAM/primitives/Scalar/lists/scalarIndList.H b/src/OpenFOAM/primitives/Scalar/lists/scalarIndList.H
index 5fa0b3c80c..19e6f9c9e2 100644
--- a/src/OpenFOAM/primitives/Scalar/lists/scalarIndList.H
+++ b/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 .
-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 scalarIndList;
+
+ //! UIndirectList of scalar
typedef UIndirectList scalarUIndList;
}
diff --git a/src/OpenFOAM/primitives/Scalar/lists/scalarList.H b/src/OpenFOAM/primitives/Scalar/lists/scalarList.H
index 53d23bc37b..1666ee422d 100644
--- a/src/OpenFOAM/primitives/Scalar/lists/scalarList.H
+++ b/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 .
-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
-#define scalarList_H
+#ifndef Foam_scalarList_H
+#define Foam_scalarList_H
#include "scalar.H"
#include "List.H"
@@ -60,10 +36,10 @@ Description
namespace Foam
{
- typedef UList scalarUList;
- typedef List scalarList;
- typedef SubList scalarSubList;
- typedef List scalarListList;
+ typedef List scalarList; //!< List of scalar
+ typedef SubList scalarSubList; //!< SubList of scalar
+ typedef UList scalarUList; //!< UList of scalar
+ typedef List scalarListList; //!< List of scalarList
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Scalar/lists/scalarListIOList.H b/src/OpenFOAM/primitives/Scalar/lists/scalarListIOList.H
index 439c5d7956..30a5fdd309 100644
--- a/src/OpenFOAM/primitives/Scalar/lists/scalarListIOList.H
+++ b/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 .
-Typedef
- Foam::scalarListIOList
-
-Description
- Scalar container classes
-
\*---------------------------------------------------------------------------*/
-#ifndef scalarListIOList_H
-#define scalarListIOList_H
+#ifndef Foam_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 scalarListIOList;
+
+ //! Compact IO for a List of scalarList
typedef CompactIOList scalarListCompactIOList;
}
diff --git a/src/OpenFOAM/primitives/Tensor/lists/sphericalTensorList.H b/src/OpenFOAM/primitives/Tensor/lists/sphericalTensorList.H
index b9e10e986b..a8d25997f6 100644
--- a/src/OpenFOAM/primitives/Tensor/lists/sphericalTensorList.H
+++ b/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 .
-Typedef
- Foam::sphericalTensorUList
-
-Description
- A UList of sphericalTensors.
-
-Typedef
- Foam::sphericalTensorList
-
-Description
- A List of sphericalTensors.
-
\*---------------------------------------------------------------------------*/
-#ifndef sphericalTensorList_H
-#define sphericalTensorList_H
+#ifndef Foam_sphericalTensorList_H
+#define Foam_sphericalTensorList_H
#include "sphericalTensor.H"
#include "List.H"
@@ -47,9 +35,11 @@ Description
namespace Foam
{
- typedef UList sphericalTensorUList;
-
+ //! List of sphericalTensor
typedef List sphericalTensorList;
+
+ //! UList of sphericalTensor
+ typedef UList sphericalTensorUList;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Tensor/lists/symmTensorList.H b/src/OpenFOAM/primitives/Tensor/lists/symmTensorList.H
index 3b31b380a8..68242d6775 100644
--- a/src/OpenFOAM/primitives/Tensor/lists/symmTensorList.H
+++ b/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 .
-Typedef
- Foam::symmTensorUList
-
-Description
- A UList of symmTensors.
-
-Typedef
- Foam::symmTensorList
-
-Description
- A List of symmTensors.
-
\*---------------------------------------------------------------------------*/
-#ifndef symmTensorList_H
-#define symmTensorList_H
+#ifndef Foam_symmTensorList_H
+#define Foam_symmTensorList_H
#include "symmTensor.H"
#include "List.H"
@@ -47,9 +35,8 @@ Description
namespace Foam
{
- typedef UList symmTensorUList;
-
- typedef List symmTensorList;
+ typedef List symmTensorList; //!< List of symmTensor
+ typedef UList symmTensorUList; //!< UList of symmTensor
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Tensor/lists/tensorList.H b/src/OpenFOAM/primitives/Tensor/lists/tensorList.H
index 826562b64e..4c56a1ca14 100644
--- a/src/OpenFOAM/primitives/Tensor/lists/tensorList.H
+++ b/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 .
-Typedef
- Foam::tensorUList
-
-Description
- A UList of tensors.
-
-Typedef
- Foam::tensorList
-
-Description
- A List of tensors.
-
\*---------------------------------------------------------------------------*/
-#ifndef tensorList_H
-#define tensorList_H
+#ifndef Foam_tensorList_H
+#define Foam_tensorList_H
#include "tensor.H"
#include "List.H"
@@ -47,9 +35,8 @@ Description
namespace Foam
{
- typedef UList tensorUList;
-
- typedef List tensorList;
+ typedef List tensorList; //!< List of tensor
+ typedef UList tensorUList; //!< UList of tensor
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Vector/lists/vectorIOList.H b/src/OpenFOAM/primitives/Vector/lists/vectorIOList.H
index d64d984f31..7916d46327 100644
--- a/src/OpenFOAM/primitives/Vector/lists/vectorIOList.H
+++ b/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 .
-Typedef
- Foam::vectorIOList
-
-Description
- Vector container classes
-
\*---------------------------------------------------------------------------*/
-#ifndef vectorIOList_H
-#define vectorIOList_H
+#ifndef Foam_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 vectorIOList;
}
diff --git a/src/OpenFOAM/primitives/Vector/lists/vectorIndList.H b/src/OpenFOAM/primitives/Vector/lists/vectorIndList.H
index 16e24a46b1..fec49c71a4 100644
--- a/src/OpenFOAM/primitives/Vector/lists/vectorIndList.H
+++ b/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 .
-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 vectorIndList;
+
+ //! UIndirectList of vector
typedef UIndirectList vectorUIndList;
}
diff --git a/src/OpenFOAM/primitives/Vector/lists/vectorList.H b/src/OpenFOAM/primitives/Vector/lists/vectorList.H
index 5dcdc26e04..122aa44fef 100644
--- a/src/OpenFOAM/primitives/Vector/lists/vectorList.H
+++ b/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 .
-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
-#define vectorList_H
+#ifndef Foam_vectorList_H
+#define Foam_vectorList_H
#include "vector.H"
#include "List.H"
@@ -60,10 +36,10 @@ Description
namespace Foam
{
- typedef UList vectorUList;
- typedef List vectorList;
- typedef SubList vectorSubList;
- typedef List vectorListList;
+ typedef List vectorList; //!< List of vector
+ typedef SubList vectorSubList; //!< SubList of vector
+ typedef UList vectorUList; //!< UList of vector
+ typedef List vectorListList; //!< List of vectorList
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/Vector/lists/vectorListIOList.H b/src/OpenFOAM/primitives/Vector/lists/vectorListIOList.H
index 146f05afab..9dd4fbc5d1 100644
--- a/src/OpenFOAM/primitives/Vector/lists/vectorListIOList.H
+++ b/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 .
-Typedef
- Foam::vectorListIOList
-
-Description
- Lists of vectors container class
-
\*---------------------------------------------------------------------------*/
-#ifndef vectorListIOList_H
-#define vectorListIOList_H
+#ifndef Foam_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 vectorListIOList;
+
+ //! Compact IO for a List of vectorList
typedef CompactIOList vectorListCompactIOList;
}
diff --git a/src/OpenFOAM/primitives/bools/lists/boolList.H b/src/OpenFOAM/primitives/bools/lists/boolList.H
index 80129c7d5d..d01b3aaea9 100644
--- a/src/OpenFOAM/primitives/bools/lists/boolList.H
+++ b/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 .
-Typedef
- Foam::boolListList
-
-Description
- A List of boolList.
-
\*---------------------------------------------------------------------------*/
-#ifndef boolList_H
-#define boolList_H
+#ifndef Foam_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> boolListList;
}
diff --git a/src/OpenFOAM/primitives/chars/lists/charList.H b/src/OpenFOAM/primitives/chars/lists/charList.H
index cc13e3fa69..9233bd7490 100644
--- a/src/OpenFOAM/primitives/chars/lists/charList.H
+++ b/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 .
-Typedef
- Foam::charListList
-
-Description
- A List of charList.
-
\*---------------------------------------------------------------------------*/
-#ifndef charList_H
-#define charList_H
+#ifndef Foam_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 charListList;
}
diff --git a/src/OpenFOAM/primitives/ints/lists/labelIOList.H b/src/OpenFOAM/primitives/ints/lists/labelIOList.H
index f406ac1ee9..62f5e39782 100644
--- a/src/OpenFOAM/primitives/ints/lists/labelIOList.H
+++ b/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 .
-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 labelIOList;
}
diff --git a/src/OpenFOAM/primitives/ints/lists/labelIndList.H b/src/OpenFOAM/primitives/ints/lists/labelIndList.H
index da2bfb50a6..4794916a12 100644
--- a/src/OpenFOAM/primitives/ints/lists/labelIndList.H
+++ b/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 .
-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 labelIndList;
- // labelUIndList is defined in UIndirectList itself
+
+ // labelUIndList = defined in IndirectList.H
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/ints/lists/labelList.H b/src/OpenFOAM/primitives/ints/lists/labelList.H
index 7a38e83969..81aa1de8fd 100644
--- a/src/OpenFOAM/primitives/ints/lists/labelList.H
+++ b/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 .
-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 labelListList;
+
+ //! List of labelListList
typedef List labelListListList;
diff --git a/src/OpenFOAM/primitives/ints/lists/labelListIOList.H b/src/OpenFOAM/primitives/ints/lists/labelListIOList.H
index 0a9b4868ff..e8f9180f23 100644
--- a/src/OpenFOAM/primitives/ints/lists/labelListIOList.H
+++ b/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 .
-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 labelListIOList;
+
+ //! Compact IO for a List of labelList
typedef CompactIOList labelListCompactIOList;
}
diff --git a/src/OpenFOAM/primitives/strings/lists/fileNameList.H b/src/OpenFOAM/primitives/strings/lists/fileNameList.H
index d9c91b72da..3353f97801 100644
--- a/src/OpenFOAM/primitives/strings/lists/fileNameList.H
+++ b/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 .
-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
-#define fileNameList_H
+#ifndef Foam_fileNameList_H
+#define Foam_fileNameList_H
#include "fileName.H"
#include "List.H"
@@ -54,9 +36,9 @@ Description
namespace Foam
{
- typedef UList fileNameUList;
- typedef List fileNameList;
- typedef SubList fileNameSubList;
+ typedef List fileNameList; //!< List of fileName
+ typedef SubList fileNameSubList; //!< SubList of fileName
+ typedef UList fileNameUList; //!< UList of fileName
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/strings/lists/stringList.H b/src/OpenFOAM/primitives/strings/lists/stringList.H
index 0e7f3615c2..6359a8fe54 100644
--- a/src/OpenFOAM/primitives/strings/lists/stringList.H
+++ b/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 .
-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 stringUList;
- typedef List stringList;
- typedef SubList stringSubList;
+ typedef List stringList; //!< List of string
+ typedef SubList stringSubList; //!< SubList of string
+ typedef UList stringUList; //!< UList of string
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/strings/lists/wordList.H b/src/OpenFOAM/primitives/strings/lists/wordList.H
index 747260e55a..d0b34b39ef 100644
--- a/src/OpenFOAM/primitives/strings/lists/wordList.H
+++ b/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 .
-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 wordUList;
- typedef List wordList;
- typedef SubList wordSubList;
+ typedef List wordList; //!< List of word
+ typedef SubList wordSubList; //!< SubList of word
+ typedef UList wordUList; //!< UList of word
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/strings/lists/wordReList.H b/src/OpenFOAM/primitives/strings/lists/wordReList.H
deleted file mode 100644
index 6435a8271f..0000000000
--- a/src/OpenFOAM/primitives/strings/lists/wordReList.H
+++ /dev/null
@@ -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 .
-
-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 wordReUList;
- typedef List wordReList;
-}
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-#endif
-
-// ************************************************************************* //
diff --git a/src/OpenFOAM/primitives/strings/string/stringIOList.H b/src/OpenFOAM/primitives/strings/string/stringIOList.H
index 7ed7473a3d..b1f87ce0d7 100644
--- a/src/OpenFOAM/primitives/strings/string/stringIOList.H
+++ b/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 .
-Typedef
- Foam::stringIOList
-
-Description
- IO of a list of strings
-
\*---------------------------------------------------------------------------*/
-#ifndef stringIOList_H
-#define stringIOList_H
+#ifndef Foam_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 stringIOList;
+
+ //! IO for a List of stringList
typedef IOList stringListIOList;
}
diff --git a/src/OpenFOAM/primitives/strings/word/wordIOList.H b/src/OpenFOAM/primitives/strings/word/wordIOList.H
index da723ffc69..fb56291848 100644
--- a/src/OpenFOAM/primitives/strings/word/wordIOList.H
+++ b/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 .
-Typedef
- Foam::wordIOList
-
-Description
- IO of a list of words
-
\*---------------------------------------------------------------------------*/
-#ifndef wordIOList_H
-#define wordIOList_H
+#ifndef Foam_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 wordIOList;
+
+ //! IO for a List of wordList
typedef IOList wordListIOList;
//- Print a List of wordList as a table
diff --git a/src/OpenFOAM/primitives/strings/wordRes/wordRes.H b/src/OpenFOAM/primitives/strings/wordRes/wordRes.H
index 4eb983f7e6..de7c5d56aa 100644
--- a/src/OpenFOAM/primitives/strings/wordRes/wordRes.H
+++ b/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 wordReList; //!< List of wordRe (word or regex)
+typedef UList wordReUList; //!< UList of wordRe (word or regex)
+
+
/*---------------------------------------------------------------------------*\
Class wordRes Declaration
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/primitives/tuples/labelPair.H b/src/OpenFOAM/primitives/tuples/labelPair.H
index 4559806088..2a4a4d0360 100644
--- a/src/OpenFOAM/primitives/tuples/labelPair.H
+++ b/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 .
-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
-#define labelPair_H
+#ifndef Foam_labelPair_H
+#define Foam_labelPair_H
+#include "Pair.H"
#include "List.H"
#include "SubList.H"
-#include "Pair.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
- typedef Pair labelPairPair;
- typedef List labelPairList;
- typedef UList labelPairUList;
- typedef SubList labelPairSubList;
+ typedef Pair labelPairPair; //!< Pair of labelPair
+ typedef List labelPairList; //!< List of labelPair
+ typedef UList labelPairUList; //!< UList of labelPair
+
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/OpenFOAM/primitives/tuples/wordPair.H b/src/OpenFOAM/primitives/tuples/wordPair.H
index 5110355bc0..59fe244c90 100644
--- a/src/OpenFOAM/primitives/tuples/wordPair.H
+++ b/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 .
-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
-#define wordPair_H
+#ifndef Foam_wordPair_H
+#define Foam_wordPair_H
+#include "Pair.H"
#include "List.H"
#include "SubList.H"
-#include "Pair.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
- typedef Pair wordPairPair;
- typedef List wordPairList;
- typedef UList wordPairUList;
- typedef SubList wordPairSubList;
+ typedef Pair wordPairPair; //!< Pair of wordPair
+ typedef List wordPairList; //!< List of wordPair
+ typedef UList wordPairUList; //!< UList of wordPair
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/dynamicMesh/polyMeshAdder/faceCoupleInfo.H b/src/dynamicMesh/polyMeshAdder/faceCoupleInfo.H
index 721dd6b453..5424b736b2 100644
--- a/src/dynamicMesh/polyMeshAdder/faceCoupleInfo.H
+++ b/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> 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 cutEdgeToPoints_;
// Private Member Functions
@@ -499,13 +498,11 @@ public:
return slaveToCutPoints_;
}
- //- From two cut points (original edge) to list of inserted
- // points
- const edgeLookup& cutEdgeToPoints() const
+ //- From two cut points (original edge) to list of inserted points
+ const EdgeMap& cutEdgeToPoints() const noexcept
{
return cutEdgeToPoints_;
}
-
};
diff --git a/src/dynamicMesh/polyMeshAdder/polyMeshAdder.C b/src/dynamicMesh/polyMeshAdder/polyMeshAdder.C
index 1a4d0e48c8..503475c616 100644
--- a/src/dynamicMesh/polyMeshAdder/polyMeshAdder.C
+++ b/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& cutEdgeToPoints,
const Map& 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& cutEdgeToPoints
+ = coupleInfo.cutEdgeToPoints();
// Get map of master face (in mesh labels) that are in cut. These faces
// do not need to be renumbered.
diff --git a/src/dynamicMesh/polyMeshAdder/polyMeshAdder.H b/src/dynamicMesh/polyMeshAdder/polyMeshAdder.H
index 2dc1253bc0..3182ad1801 100644
--- a/src/dynamicMesh/polyMeshAdder/polyMeshAdder.H
+++ b/src/dynamicMesh/polyMeshAdder/polyMeshAdder.H
@@ -38,8 +38,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
-#ifndef polyMeshAdder_H
-#define polyMeshAdder_H
+#ifndef Foam_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& cutEdgeToPoints,
const Map& meshToMaster,
const labelList& masterToCutPoints,
const face& masterFace,
diff --git a/src/meshTools/multiWorld/multiWorldConnectionsObject.H b/src/meshTools/multiWorld/multiWorldConnectionsObject.H
index 76cf3f505a..d0c0bb7616 100644
--- a/src/meshTools/multiWorld/multiWorldConnectionsObject.H
+++ b/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"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/surfMesh/surfZone/surfZoneList.H b/src/surfMesh/surfZone/surfZoneList.H
index c4346e9605..7442d2ff70 100644
--- a/src/surfMesh/surfZone/surfZoneList.H
+++ b/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 .
-Typedef
- Foam::surfZoneList
-
-Description
-
\*---------------------------------------------------------------------------*/
-#ifndef surfZoneList_H
-#define surfZoneList_H
+#ifndef Foam_surfZoneList_H
+#define Foam_surfZoneList_H
#include "surfZone.H"
#include "List.H"
@@ -41,14 +36,8 @@ Description
namespace Foam
{
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-typedef List surfZoneList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
+ typedef List surfZoneList; //!< List of surfZone
+}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
diff --git a/src/surfMesh/triSurface/patches/surfacePatchList.H b/src/surfMesh/triSurface/patches/surfacePatchList.H
index d25f2ede35..c9c9142434 100644
--- a/src/surfMesh/triSurface/patches/surfacePatchList.H
+++ b/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 .
-Typedef
- Foam::surfacePatchList
-
-Description
- A List of surfacePatch.
-
\*---------------------------------------------------------------------------*/
-#ifndef surfacePatchList_H
-#define surfacePatchList_H
+#ifndef Foam_surfacePatchList_H
+#define Foam_surfacePatchList_H
#include "surfacePatch.H"
#include "List.H"
@@ -41,14 +35,8 @@ Description
namespace Foam
{
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-typedef List surfacePatchList;
-
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
+ typedef List surfacePatchList; //!< List of surfacePatch
+}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
| | | | | | | | | |