From a03077e15179e192f387545fc6125af2e3ceb149 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Mon, 9 Oct 2023 17:05:30 +0200
Subject: [PATCH] ENH: add IOobjectOption::LEGACY_REGISTER enumeration

- extends the enumeration (NO_REGISTER, REGISTER, LEGACY_REGISTER).
  Can be used to tweak registration preference where required and
  potentially (TDB) to define a different default value in the future
---
 src/OpenFOAM/db/IOobject/IOobject.H      | 6 +++---
 src/OpenFOAM/db/options/IOobjectOption.H | 9 ++++++---
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/src/OpenFOAM/db/IOobject/IOobject.H b/src/OpenFOAM/db/IOobject/IOobject.H
index 44a78b0af1..7379595e15 100644
--- a/src/OpenFOAM/db/IOobject/IOobject.H
+++ b/src/OpenFOAM/db/IOobject/IOobject.H
@@ -393,7 +393,7 @@ public:
             const objectRegistry& registry,
             IOobjectOption::readOption rOpt,
             IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
-            bool registerObject = true,
+            bool registerObject = true,  // == IOobjectOption::LEGACY_REGISTER
             bool globalObject = false
         );
 
@@ -406,7 +406,7 @@ public:
             const objectRegistry& registry,
             IOobjectOption::readOption rOpt,
             IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
-            bool registerObject = true,
+            bool registerObject = true,  // == IOobjectOption::LEGACY_REGISTER
             bool globalObject = false
         );
 
@@ -422,7 +422,7 @@ public:
             const objectRegistry& registry,
             IOobjectOption::readOption rOpt,
             IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
-            bool registerObject = true,
+            bool registerObject = true,  // == IOobjectOption::LEGACY_REGISTER
             bool globalObject = false
         );
 
diff --git a/src/OpenFOAM/db/options/IOobjectOption.H b/src/OpenFOAM/db/options/IOobjectOption.H
index 2e654b5818..be2b2e725f 100644
--- a/src/OpenFOAM/db/options/IOobjectOption.H
+++ b/src/OpenFOAM/db/options/IOobjectOption.H
@@ -99,7 +99,10 @@ public:
             NO_REGISTER = 0,
 
             //! Request registration (bool: true)
-            REGISTER = 1
+            REGISTER = 1,
+
+            //! Legacy/default registration request (bool: true)
+            LEGACY_REGISTER = 2
         };
 
 
@@ -124,7 +127,7 @@ public:
 
     // Constructors
 
-        //- Default construct (NO_READ, NO_WRITE, register, non-global)
+        //- Default construct (NO_READ, NO_WRITE, REGISTER, non-global)
         //- or construct with specified options
         constexpr IOobjectOption
         (
@@ -267,7 +270,7 @@ public:
             return (opt != readOption::NO_READ);
         }
 
-        //- True if any reading may be required(ie, != NO_READ)
+        //- True if any reading may be required (ie, != NO_READ)
         bool isAnyRead() const noexcept
         {
             return (readOpt_ != readOption::NO_READ);