From 64f47452771a4db2e0f9f898bebe0c8bb969d944 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Thu, 21 Jul 2022 15:33:05 +0200 Subject: [PATCH] STYLE: various 'defineTemplate2...' macros are redundant - they are/were identical to versions without an embedded '2' --- applications/test/dimField/Test-dimField.C | 2 +- applications/test/fvc2D/Test-fvc2D.C | 2 +- applications/test/volField/Test-volField.C | 2 +- src/OpenFOAM/db/typeInfo/className.H | 26 ++++----- src/OpenFOAM/db/typeInfo/typeInfo.H | 4 +- .../GeometricFields/pointFields/pointFields.C | 28 ++++------ src/OpenFOAM/global/debug/debug.H | 4 +- src/OpenFOAM/global/debug/defineDebugSwitch.H | 56 +++++++++---------- src/OpenFOAM/global/debug/simpleRegIOobject.H | 4 +- src/finiteArea/fields/areaFields/areaFields.C | 21 +++---- src/finiteArea/fields/edgeFields/edgeFields.C | 17 ++---- .../fields/surfaceFields/surfaceFields.C | 37 ++---------- src/finiteVolume/fields/volFields/volFields.C | 29 ++++------ 13 files changed, 94 insertions(+), 138 deletions(-) diff --git a/applications/test/dimField/Test-dimField.C b/applications/test/dimField/Test-dimField.C index bc0c261782..7144ce45d8 100644 --- a/applications/test/dimField/Test-dimField.C +++ b/applications/test/dimField/Test-dimField.C @@ -42,7 +42,7 @@ namespace Foam // Something like an internal state field. Probably only dimensionless typedef DimensionedField dimUint8Field; - defineTemplate2TypeNameAndDebug(dimUint8Field, 0); + defineTemplateTypeNameAndDebug(dimUint8Field, 0); } // End namespace Foam #endif diff --git a/applications/test/fvc2D/Test-fvc2D.C b/applications/test/fvc2D/Test-fvc2D.C index fb9053bdda..aea43f20c4 100644 --- a/applications/test/fvc2D/Test-fvc2D.C +++ b/applications/test/fvc2D/Test-fvc2D.C @@ -39,7 +39,7 @@ namespace Foam { typedef GeometricField volVector2DField; - defineTemplate2TypeNameAndDebug(volVector2DField::Internal, 0); + defineTemplateTypeNameAndDebug(volVector2DField::Internal, 0); defineTemplateTypeNameAndDebug(volVector2DField, 0); typedef fvPatchField fvPatchVector2DField; diff --git a/applications/test/volField/Test-volField.C b/applications/test/volField/Test-volField.C index 95307ceed4..80960234ab 100644 --- a/applications/test/volField/Test-volField.C +++ b/applications/test/volField/Test-volField.C @@ -42,7 +42,7 @@ namespace Foam // - still needs some basic boundary conditions!! typedef GeometricField volUint8Field; - defineTemplate2TypeNameAndDebug(volUint8Field, 0); + defineTemplateTypeNameAndDebug(volUint8Field, 0); } // End namespace Foam #endif diff --git a/src/OpenFOAM/db/typeInfo/className.H b/src/OpenFOAM/db/typeInfo/className.H index 18fea9887c..0fdd8cb3ff 100644 --- a/src/OpenFOAM/db/typeInfo/className.H +++ b/src/OpenFOAM/db/typeInfo/className.H @@ -6,6 +6,7 @@ \\/ M anipulation | ------------------------------------------------------------------------------- Copyright (C) 2011-2016 OpenFOAM Foundation + Copyright (C) 2022 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -28,8 +29,8 @@ Description \*---------------------------------------------------------------------------*/ -#ifndef className_H -#define className_H +#ifndef Foam_className_H +#define Foam_className_H #include "defineDebugSwitch.H" @@ -100,10 +101,6 @@ public: \ #define defineTemplateTypeNameWithName(Type, Name) \ template<> \ defineTypeNameWithName(Type, Name) -//- Define the typeName as \a Name for template sub-classes -#define defineTemplate2TypeNameWithName(Type, Name) \ - template<> \ - defineTypeNameWithName(Type, Name) //- Define the typeName for template classes, useful with typedefs #define defineTemplateTypeName(Type) \ @@ -139,17 +136,20 @@ public: \ // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -// For templated sub-classes +// Old names -//- Define the typeName and debug information, lookup as \a Name +// Same as defineTemplateTypeNameWithName +#define defineTemplate2TypeNameWithName(Type, Name) \ + defineTemplateTypeNameWithName(Type, Name) + +// Same as defineTemplateTypeNameAndDebugWithName #define defineTemplate2TypeNameAndDebugWithName(Type, Name, DebugSwitch) \ - defineTemplate2TypeNameWithName(Type, Name); \ - defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch) + defineTemplateTypeNameWithName(Type, Name); \ + defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch) -//- Define the typeName and debug information for templates, useful -// with typedefs +// Same as defineTemplateTypeNameAndDebug #define defineTemplate2TypeNameAndDebug(Type, DebugSwitch) \ - defineTemplate2TypeNameAndDebugWithName(Type, #Type, DebugSwitch) + defineTemplateTypeNameAndDebug(Type, DebugSwitch) // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/OpenFOAM/db/typeInfo/typeInfo.H b/src/OpenFOAM/db/typeInfo/typeInfo.H index c1ab0d4c13..86b99b6ccc 100644 --- a/src/OpenFOAM/db/typeInfo/typeInfo.H +++ b/src/OpenFOAM/db/typeInfo/typeInfo.H @@ -53,8 +53,8 @@ Description \*---------------------------------------------------------------------------*/ -#ifndef typeInfo_H -#define typeInfo_H +#ifndef Foam_typeInfo_H +#define Foam_typeInfo_H #include "error.H" #include "className.H" diff --git a/src/OpenFOAM/fields/GeometricFields/pointFields/pointFields.C b/src/OpenFOAM/fields/GeometricFields/pointFields/pointFields.C index 7701ff24f3..9d2d592175 100644 --- a/src/OpenFOAM/fields/GeometricFields/pointFields/pointFields.C +++ b/src/OpenFOAM/fields/GeometricFields/pointFields/pointFields.C @@ -32,26 +32,18 @@ License namespace Foam { - defineTemplate2TypeNameAndDebug(pointScalarField::Internal, 0); - defineTemplate2TypeNameAndDebug(pointVectorField::Internal, 0); - defineTemplate2TypeNameAndDebug - ( - pointSphericalTensorField::Internal, - 0 - ); - defineTemplate2TypeNameAndDebug - ( - pointSymmTensorField::Internal, - 0 - ); - defineTemplate2TypeNameAndDebug(pointTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(pointScalarField::Internal, 0); +defineTemplateTypeNameAndDebug(pointVectorField::Internal, 0); +defineTemplateTypeNameAndDebug(pointSphericalTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(pointSymmTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(pointTensorField::Internal, 0); - defineTemplateTypeNameAndDebug(pointScalarField, 0); - defineTemplateTypeNameAndDebug(pointVectorField, 0); - defineTemplateTypeNameAndDebug(pointSphericalTensorField, 0); - defineTemplateTypeNameAndDebug(pointSymmTensorField, 0); - defineTemplateTypeNameAndDebug(pointTensorField, 0); +defineTemplateTypeNameAndDebug(pointScalarField, 0); +defineTemplateTypeNameAndDebug(pointVectorField, 0); +defineTemplateTypeNameAndDebug(pointSphericalTensorField, 0); +defineTemplateTypeNameAndDebug(pointSymmTensorField, 0); +defineTemplateTypeNameAndDebug(pointTensorField, 0); } // End namespace Foam diff --git a/src/OpenFOAM/global/debug/debug.H b/src/OpenFOAM/global/debug/debug.H index f99046f444..3e931becc2 100644 --- a/src/OpenFOAM/global/debug/debug.H +++ b/src/OpenFOAM/global/debug/debug.H @@ -35,8 +35,8 @@ SourceFiles \*---------------------------------------------------------------------------*/ -#ifndef debug_H -#define debug_H +#ifndef Foam_debug_H +#define Foam_debug_H // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/OpenFOAM/global/debug/defineDebugSwitch.H b/src/OpenFOAM/global/debug/defineDebugSwitch.H index 16482db155..06bb9979b6 100644 --- a/src/OpenFOAM/global/debug/defineDebugSwitch.H +++ b/src/OpenFOAM/global/debug/defineDebugSwitch.H @@ -29,8 +29,8 @@ Description \*---------------------------------------------------------------------------*/ -#ifndef defineDebugSwitch_H -#define defineDebugSwitch_H +#ifndef Foam_defineDebugSwitch_H +#define Foam_defineDebugSwitch_H #include "simpleRegIOobject.H" #include "debug.H" @@ -52,12 +52,7 @@ public: //- The unique RegisterDebugSwitch object static const RegisterDebugSwitch registerDebugSwitch; - //- No copy construct - RegisterDebugSwitch(const RegisterDebugSwitch&) = delete; - - //- No copy assignment - void operator=(const RegisterDebugSwitch&) = delete; - + //- Construct with given registered name explicit RegisterDebugSwitch(const char* name) : ::Foam::simpleRegIOobject(::Foam::debug::addDebugObject, name) @@ -65,15 +60,18 @@ public: virtual ~RegisterDebugSwitch() = default; - virtual void readData(Istream& is) + virtual void readData(::Foam::Istream& is) { is >> Type::debug; } - virtual void writeData(Ostream& os) const + virtual void writeData(::Foam::Ostream& os) const { os << Type::debug; } + + RegisterDebugSwitch(const RegisterDebugSwitch&) = delete; + void operator=(const RegisterDebugSwitch&) = delete; }; } // End namespace Foam @@ -81,20 +79,23 @@ public: // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // -#define registerTemplateDebugSwitchWithName(Type,Name) \ - template<> \ - const Foam::RegisterDebugSwitch \ +//- Define the debug information, lookup as \a Name +#define registerTemplateDebugSwitchWithName(Type, Name) \ + \ + template<> const Foam::RegisterDebugSwitch \ Foam::RegisterDebugSwitch::registerDebugSwitch(Name) //- Define the debug information, lookup as \a Name -#define registerDebugSwitchWithName(Type,Tag,Name) \ +#define registerDebugSwitchWithName(Type, Tag, Name) \ + \ class add##Tag##ToDebug \ : \ public ::Foam::simpleRegIOobject \ { \ public: \ \ + /* Construct with given registered name */ \ explicit add##Tag##ToDebug(const char* name) \ : \ ::Foam::simpleRegIOobject(::Foam::debug::addDebugObject, name) \ @@ -129,14 +130,7 @@ public: //- Define the debug information for templates, lookup as \a Name #define defineTemplateDebugSwitchWithName(Type, Name, Value) \ - template<> \ - defineDebugSwitchWithName(Type, Name, Value); \ - registerTemplateDebugSwitchWithName(Type, Name) - -//- Define the debug information for templates sub-classes, lookup as \a Name -#define defineTemplate2DebugSwitchWithName(Type, Name, Value) \ - template<> \ - defineDebugSwitchWithName(Type, Name, Value); \ + template<> defineDebugSwitchWithName(Type, Name, Value); \ registerTemplateDebugSwitchWithName(Type, Name) //- Define the debug information for templates @@ -149,14 +143,20 @@ public: defineTemplateDebugSwitchWithName(Type, Type::typeName_(), Value) -//- Define the debug information for templates -// Useful with typedefs -#define defineTemplate2DebugSwitch(Type, Value) \ - defineTemplate2DebugSwitchWithName(Type, #Type, Value) +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +// Old names -//- Define the debug information directly for templates +// Same as defineTemplateDebugSwitchWithName +#define defineTemplate2DebugSwitchWithName(Type, Name, Value) \ + defineTemplateDebugSwitchWithName(Type, Name, Value) + +// Same as defineTemplateDebugSwitch +#define defineTemplate2DebugSwitch(Type, Value) \ + defineTemplateDebugSwitch(Type, Value) + +// Same as defineNamedTemplateDebugSwitch #define defineNamedTemplate2DebugSwitch(Type, Value) \ - defineTemplate2DebugSwitchWithName(Type, Type::typeName_(), Value) + defineNamedTemplateDebugSwitch(Type, Value) // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/OpenFOAM/global/debug/simpleRegIOobject.H b/src/OpenFOAM/global/debug/simpleRegIOobject.H index 98f4b470ca..1be6091fda 100644 --- a/src/OpenFOAM/global/debug/simpleRegIOobject.H +++ b/src/OpenFOAM/global/debug/simpleRegIOobject.H @@ -34,8 +34,8 @@ SourceFiles \*---------------------------------------------------------------------------*/ -#ifndef simpleRegIOobject_H -#define simpleRegIOobject_H +#ifndef Foam_simpleRegIOobject_H +#define Foam_simpleRegIOobject_H // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/finiteArea/fields/areaFields/areaFields.C b/src/finiteArea/fields/areaFields/areaFields.C index f522e765f7..08412b1a69 100644 --- a/src/finiteArea/fields/areaFields/areaFields.C +++ b/src/finiteArea/fields/areaFields/areaFields.C @@ -33,17 +33,18 @@ License namespace Foam { - defineTemplate2TypeNameAndDebug(areaScalarField::Internal, 0); - defineTemplate2TypeNameAndDebug(areaVectorField::Internal, 0); - defineTemplate2TypeNameAndDebug(areaSphericalTensorField::Internal, 0); - defineTemplate2TypeNameAndDebug(areaSymmTensorField::Internal, 0); - defineTemplate2TypeNameAndDebug(areaTensorField::Internal, 0); - defineTemplateTypeNameAndDebug(areaScalarField, 0); - defineTemplateTypeNameAndDebug(areaVectorField, 0); - defineTemplateTypeNameAndDebug(areaSphericalTensorField, 0); - defineTemplateTypeNameAndDebug(areaSymmTensorField, 0); - defineTemplateTypeNameAndDebug(areaTensorField, 0); +defineTemplateTypeNameAndDebug(areaScalarField::Internal, 0); +defineTemplateTypeNameAndDebug(areaVectorField::Internal, 0); +defineTemplateTypeNameAndDebug(areaSphericalTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(areaSymmTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(areaTensorField::Internal, 0); + +defineTemplateTypeNameAndDebug(areaScalarField, 0); +defineTemplateTypeNameAndDebug(areaVectorField, 0); +defineTemplateTypeNameAndDebug(areaSphericalTensorField, 0); +defineTemplateTypeNameAndDebug(areaSymmTensorField, 0); +defineTemplateTypeNameAndDebug(areaTensorField, 0); } // End namespace Foam diff --git a/src/finiteArea/fields/edgeFields/edgeFields.C b/src/finiteArea/fields/edgeFields/edgeFields.C index cc9881d905..bcd0451367 100644 --- a/src/finiteArea/fields/edgeFields/edgeFields.C +++ b/src/finiteArea/fields/edgeFields/edgeFields.C @@ -28,18 +28,16 @@ License #include "faMesh.H" #include "edgeFields.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // namespace Foam { -// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // - -defineTemplate2TypeNameAndDebug(edgeScalarField::Internal, 0); -defineTemplate2TypeNameAndDebug(edgeVectorField::Internal, 0); -defineTemplate2TypeNameAndDebug(edgeSphericalTensorField::Internal, 0); -defineTemplate2TypeNameAndDebug(edgeSymmTensorField::Internal, 0); -defineTemplate2TypeNameAndDebug(edgeTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(edgeScalarField::Internal, 0); +defineTemplateTypeNameAndDebug(edgeVectorField::Internal, 0); +defineTemplateTypeNameAndDebug(edgeSphericalTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(edgeSymmTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(edgeTensorField::Internal, 0); defineTemplateTypeNameAndDebug(edgeScalarField, 0); defineTemplateTypeNameAndDebug(edgeVectorField, 0); @@ -47,9 +45,6 @@ defineTemplateTypeNameAndDebug(edgeSphericalTensorField, 0); defineTemplateTypeNameAndDebug(edgeSymmTensorField, 0); defineTemplateTypeNameAndDebug(edgeTensorField, 0); - -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - } // End namespace Foam // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/finiteVolume/fields/surfaceFields/surfaceFields.C b/src/finiteVolume/fields/surfaceFields/surfaceFields.C index a9b3d83580..3771992096 100644 --- a/src/finiteVolume/fields/surfaceFields/surfaceFields.C +++ b/src/finiteVolume/fields/surfaceFields/surfaceFields.C @@ -28,39 +28,16 @@ License #include "surfaceFields.H" -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // namespace Foam { -// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // - -defineTemplate2TypeNameAndDebug -( - surfaceScalarField::Internal, - 0 -); -defineTemplate2TypeNameAndDebug -( - surfaceVectorField::Internal, - 0 -); -defineTemplate2TypeNameAndDebug -( - surfaceSphericalTensorField::Internal, - 0 -); -defineTemplate2TypeNameAndDebug -( - surfaceSymmTensorField::Internal, - 0 -); -defineTemplate2TypeNameAndDebug -( - surfaceTensorField::Internal, - 0 -); - +defineTemplateTypeNameAndDebug(surfaceScalarField::Internal, 0); +defineTemplateTypeNameAndDebug(surfaceVectorField::Internal, 0); +defineTemplateTypeNameAndDebug(surfaceSphericalTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(surfaceSymmTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(surfaceTensorField::Internal, 0); defineTemplateTypeNameAndDebug(surfaceScalarField, 0); defineTemplateTypeNameAndDebug(surfaceVectorField, 0); @@ -68,8 +45,6 @@ defineTemplateTypeNameAndDebug(surfaceSphericalTensorField, 0); defineTemplateTypeNameAndDebug(surfaceSymmTensorField, 0); defineTemplateTypeNameAndDebug(surfaceTensorField, 0); -// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // - } // End namespace Foam diff --git a/src/finiteVolume/fields/volFields/volFields.C b/src/finiteVolume/fields/volFields/volFields.C index 768fe45914..190b7f095a 100644 --- a/src/finiteVolume/fields/volFields/volFields.C +++ b/src/finiteVolume/fields/volFields/volFields.C @@ -32,25 +32,18 @@ License namespace Foam { - defineTemplate2TypeNameAndDebug(volScalarField::Internal, 0); - defineTemplate2TypeNameAndDebug(volVectorField::Internal, 0); - defineTemplate2TypeNameAndDebug - ( - volSphericalTensorField::Internal, - 0 - ); - defineTemplate2TypeNameAndDebug - ( - volSymmTensorField::Internal, - 0 - ); - defineTemplate2TypeNameAndDebug(volTensorField::Internal, 0); - defineTemplateTypeNameAndDebug(volScalarField, 0); - defineTemplateTypeNameAndDebug(volVectorField, 0); - defineTemplateTypeNameAndDebug(volSphericalTensorField, 0); - defineTemplateTypeNameAndDebug(volSymmTensorField, 0); - defineTemplateTypeNameAndDebug(volTensorField, 0); +defineTemplateTypeNameAndDebug(volScalarField::Internal, 0); +defineTemplateTypeNameAndDebug(volVectorField::Internal, 0); +defineTemplateTypeNameAndDebug(volSphericalTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(volSymmTensorField::Internal, 0); +defineTemplateTypeNameAndDebug(volTensorField::Internal, 0); + +defineTemplateTypeNameAndDebug(volScalarField, 0); +defineTemplateTypeNameAndDebug(volVectorField, 0); +defineTemplateTypeNameAndDebug(volSphericalTensorField, 0); +defineTemplateTypeNameAndDebug(volSymmTensorField, 0); +defineTemplateTypeNameAndDebug(volTensorField, 0); } // End namespace Foam