From 9ac7982d640dac26beceed49cc8b19fe5ecdcf0e Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Tue, 14 Nov 2023 15:19:09 +0000
Subject: [PATCH] ENH: mapFields FO - continuation of commit 46faebf783

- cuttingPatches now automatically constructed when createPatchMap is true
---
 .../field/mapFields/mapFields.C               | 61 +++++++++++++------
 .../field/mapFields/mapFields.H               | 20 ++++--
 2 files changed, 55 insertions(+), 26 deletions(-)

diff --git a/src/functionObjects/field/mapFields/mapFields.C b/src/functionObjects/field/mapFields/mapFields.C
index af8f232140..de58cce7f9 100644
--- a/src/functionObjects/field/mapFields/mapFields.C
+++ b/src/functionObjects/field/mapFields/mapFields.C
@@ -135,38 +135,59 @@ void Foam::functionObjects::mapFields::createInterpolation
 
         const polyBoundaryMesh& pbm = mesh_.boundaryMesh();
         const polyBoundaryMesh& pbmT = mapRegion.boundaryMesh();
+        DynamicList<label> cuttingIndices;
 
         if (createPatchMap)
         {
-            Info<< "    Creating patchMap" << endl;
+            Info<< "    Creating patchMap and cuttingPatches" << endl;
+
+            if (dict.found("cuttingPatches"))
+            {
+                WarningInFunction
+                    << "Ignoring user supplied cuttingPatches when "
+                    << "createPatchMap option is active"
+                    << endl;
+            }
 
             forAll(pbmT, patchiT)
             {
-                const polyPatch& pp = pbmT[patchiT];
+                const polyPatch& ppT = pbmT[patchiT];
 
-                if (!polyPatch::constraintType(pp.type()))
+                if (!polyPatch::constraintType(ppT.type()))
                 {
-                    const word& patchName = pp.name();
-                    const label patchi = pbm.findPatchID(patchName);
-                    const label patchSize =
-                        returnReduce(pp.size(), sumOp<label>());
+                    const word& patchNameT = ppT.name();
+                    const label patchi = pbm.findPatchID(patchNameT);
 
-                    if (patchi != -1 && patchSize > 0)
+                    if (patchi == -1)
                     {
-                        Info<< "        Adding patch:" << pp.name() << endl;
-                        patchMap.set(patchName, patchName);
+                        Info<< "        Adding to cuttingPatches: "
+                            << ppT.name() << endl;
+
+                        cuttingIndices.push_back(ppT.index());
+                    }
+                    else
+                    {
+                        if (returnReduce(ppT.size(), sumOp<label>()) > 0)
+                        {
+                            Info<< "        Adding to patchMap: " << ppT.name()
+                                << endl;
+
+                            patchMap.set(patchNameT, patchNameT);
+                        }
                     }
                 }
             }
         }
         else
         {
+            // Read patch map
             patchMap = HashTable<word>(ePtr->stream());
+
+            // Read cutting patches using wordRe's
+            const wordRes cuttingPatchRes = dict.get<wordRes>("cuttingPatches");
+            cuttingIndices.push_back(pbmT.indices(cuttingPatchRes));
         }
 
-        // Cutting patches specified using wordRe's
-        const wordRes cuttingPatchRes = dict.get<wordRes>("cuttingPatches");
-        const labelList cuttingIndices = pbmT.indices(cuttingPatchRes);
         const wordList cuttingPatches(pbmT.names(), cuttingIndices);
 
         // Checks
@@ -174,16 +195,16 @@ void Foam::functionObjects::mapFields::createInterpolation
             // Find patch names that exist on target mesh that are not included
             // in the patchMap
             wordHashSet unknownPatchNames;
-            for (const auto& pp : pbmT)
+            for (const auto& ppT : pbmT)
             {
                 if
                 (
-                    !polyPatch::constraintType(pp.type())
-                 && !patchMap.found(pp.name())
-                 && returnReduce(pp.size(), sumOp<label>()) > 0
+                    !polyPatch::constraintType(ppT.type())
+                 && !patchMap.found(ppT.name())
+                 && returnReduce(ppT.size(), sumOp<label>()) > 0
                 )
                 {
-                    unknownPatchNames.insert(pp.name());
+                    unknownPatchNames.insert(ppT.name());
                 }
             }
 
@@ -195,8 +216,8 @@ void Foam::functionObjects::mapFields::createInterpolation
 
                 if (patchMap.found(patchName))
                 {
-                    Info<< "        Removing cutting patch:" << patchName
-                        << endl;
+                    Info<< "        Removing cutting patch from patchMap: "
+                        << patchName << endl;
 
                     patchMap.erase(patchName);
                 }
diff --git a/src/functionObjects/field/mapFields/mapFields.H b/src/functionObjects/field/mapFields/mapFields.H
index 873ab0899b..9391f71552 100644
--- a/src/functionObjects/field/mapFields/mapFields.H
+++ b/src/functionObjects/field/mapFields/mapFields.H
@@ -5,7 +5,7 @@
     \\  /    A nd           | www.openfoam.com
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
-    Copyright (C) 2016-2020 OpenCFD Ltd.
+    Copyright (C) 2016-2023 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -61,9 +61,15 @@ Usage
 
         // Optional entries (runtime modifiable)
         // patchMapMethod  direct;  // AMI-related entry
-        // enabled if consistent=false
-        // patchMap        (<patchSrc> <patchTgt>);
-        // cuttingPatches  (<patchTgt1> <patchTgt2> ... <patchTgtN>);
+
+        // When consistent=false
+
+            // Manual: createPatchMap false;
+            // patchMap        (<patchSrc> <patchTgt>);
+            // cuttingPatches  (<patchTgt1> <patchTgt2> ... <patchTgtN>);
+
+            // Automatic: createPatchMap true;
+            // Creates the patchMap and cuttingPatches automatically
 
         // Optional (inherited) entries
         ...
@@ -80,8 +86,10 @@ Usage
       mapMethod    | Mapping method                     | word |  yes  | -
       consistent   | Mapping meshes have consistent boundaries | bool  | yes | -
       patchMapMethod | Patch mapping method for AMI cases | word |  no  | -
-      patchMap   | Coincident source/target patches in two cases <!--
-             --> | wordHashTable | no | -
+      createPatchMap | Automatically create patchMap and cuttingPatches|  <!--
+                 --> | bool | no | -
+      patchMap     | Mapping between coincident source and target patches <!--
+               --> | wordHashTable | no | -
       cuttingPatches | Target patches cutting the source domain <!--
                  --> | wordList | no | -
     \endtable