From 2a1d0f36ec1c254ae6fbe4981ae367b95b976430 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Mon, 14 Jan 2019 17:32:07 +0100
Subject: [PATCH] ENH: new foamToVTK output option -processor-fields

- write values of processor boundaries only, for diagnostic purposes.

- parallel only, and non-legacy format only
---
 .../foamToVTK/convertProcessorPatches.H       | 215 ++++++++++++++++++
 .../dataConversion/foamToVTK/foamToVTK.C      |  38 +++-
 2 files changed, 252 insertions(+), 1 deletion(-)
 create mode 100644 applications/utilities/postProcessing/dataConversion/foamToVTK/convertProcessorPatches.H

diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/convertProcessorPatches.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/convertProcessorPatches.H
new file mode 100644
index 0000000000..45ead1d6b7
--- /dev/null
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/convertProcessorPatches.H
@@ -0,0 +1,215 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Description
+    Code chunk for converting volume fields on processor boundaries,
+    included by foamToVTK.
+
+\*---------------------------------------------------------------------------*/
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+// Generate processor/processorN/procBoundary
+
+{
+    using reportFields = foamToVtkReportFields;
+
+    const label nVolFields =
+    (
+        objects.count(stringListOps::foundOp<word>(fieldTypes::volume))
+    );
+
+    reportFields::volume(Info, objects);
+
+    // Setup for the vtm writer.
+
+    fileName vtmOutputBase
+    (
+        outputDir/regionPrefix/vtkName + timeDesc
+    );
+
+    // Naming
+    const auto subDirNaming =
+        [](const label i) -> fileName
+        { return "processor" / ("processor" + Foam::name(i)); };
+
+
+    // Dummy writer.
+    autoPtr<vtk::internalWriter> internalWriter;
+
+    // Setup the patch writers
+    PtrList<vtk::patchWriter> patchWriters;
+
+    const polyBoundaryMesh& patches = mesh.boundaryMesh();
+
+    labelList patchIds =
+        identity
+        (
+            patches.size()-patches.nNonProcessor(),
+            patches.nNonProcessor()
+        );
+
+    forAll(patchIds, i)
+    {
+        if (!isA<processorPolyPatch>(patches[patchIds[i]]))
+        {
+            patchIds.resize(i);
+            break;
+        }
+    }
+
+    patchWriters.resize(patchIds.size());
+
+    label nPatchWriters = 0;
+
+    List<wordList> procPatchNames(Pstream::nProcs());
+
+    procPatchNames[Pstream::myProcNo()].resize(patchIds.size());
+
+    for (const label patchId : patchIds)
+    {
+        const polyPatch& pp = patches[patchId];
+
+        auto writer = autoPtr<vtk::patchWriter>::New
+        (
+            meshProxy.mesh(),
+            labelList(one(), pp.index()),
+            writeOpts,
+            nearCellValue,
+            (
+                vtmOutputBase
+              / subDirNaming(Pstream::myProcNo())
+              / pp.name()
+            ),
+            false  // This MUST be non-parallel (serial only)
+        );
+
+        procPatchNames[Pstream::myProcNo()][nPatchWriters] = pp.name();
+
+        writer->writeTimeValue(timeValue);
+        writer->writeGeometry();
+
+        // Transfer writer to list for later use
+        patchWriters.set(nPatchWriters++, writer);
+    }
+    patchWriters.resize(nPatchWriters);
+
+
+    Pstream::gatherList(procPatchNames);
+
+    // CellData
+    {
+        for (vtk::patchWriter& writer : patchWriters)
+        {
+            writer.beginCellData
+            (
+                1 + (Pstream::parRun() ? 2 : 0)
+              + nVolFields
+            );
+            writer.writePatchIDs();
+            writer.writeProcIDs();
+            writer.writeNeighIDs();
+        }
+
+        writeAllVolFields
+        (
+            internalWriter,
+            patchWriters,
+            meshProxy,
+            objects,
+            true  // syncPar
+        );
+
+        // End CellData is implicit
+    }
+
+
+    // Finish writers
+    if (internalWriter.valid())
+    {
+        internalWriter->close();
+    }
+
+    for (vtk::patchWriter& writer : patchWriters)
+    {
+        writer.close();
+    }
+
+    patchWriters.clear();
+
+
+    // Collective output
+
+    const label nProcPatches = returnReduce(nPatchWriters, sumOp<label>());
+
+    if (Pstream::master() && nProcPatches)
+    {
+        Info<< "Wrote " << nProcPatches << " processor boundaries from "
+            << Pstream::nProcs() << " processes" << nl;
+
+
+        // Collect individual boundaries into a vtm file
+        vtk::vtmWriter vtmBoundaries;
+
+        // Naming for vtm
+        fileName outputName(vtmOutputBase / "processor");
+        outputName.ext(vtmBoundaries.ext());
+
+        vtmBoundaries.setTime(timeValue);
+
+        forAll(procPatchNames, proci)
+        {
+            label n = 0;
+
+            const word blockName("proc" + Foam::name(proci));
+            const fileName dirName = subDirNaming(proci);
+
+            for (const word& patchName : procPatchNames[proci])
+            {
+                if (!n)
+                {
+                    vtmBoundaries.beginBlock(blockName);
+                    ++n;
+                }
+
+                vtmBoundaries.append_vtp
+                (
+                    patchName,
+                    dirName/patchName
+                );
+            }
+
+            if (n)
+            {
+                vtmBoundaries.endBlock();
+            }
+        }
+
+
+        // Emit "processor.vtm" with collection of processor boundaries
+        vtmBoundaries.write(outputName);
+    }
+}
+
+
+// ************************************************************************* //
diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
index 2d727012ce..a526e25726 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
@@ -3,7 +3,7 @@
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
     \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
-     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
+     \\/     M anipulation  | Copyright (C) 2016-2019 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -329,6 +329,12 @@ int main(int argc, char *argv[])
         "Eg, 'T' or '(p T U \"alpha.*\")'"
     );
 
+    argList::addBoolOption
+    (
+        "processor-fields",
+        "Write field values on processor boundaries only",
+        true  // mark as an advanced option
+    );
     argList::addBoolOption
     (
         "surfaceFields",
@@ -450,6 +456,29 @@ int main(int argc, char *argv[])
 
     const vtk::outputOptions writeOpts = getOutputOptions(args);
 
+    bool processorFieldsOnly = false;
+
+    if (args.found("processor-fields"))
+    {
+        if (!Pstream::parRun())
+        {
+            Info<< "Ignoring processor patch writing in serial"
+                << nl << endl;
+        }
+        else if (writeOpts.legacy())
+        {
+            Info<< "Ignoring processor patch writing in legacy format"
+                << nl << endl;
+        }
+        else
+        {
+            processorFieldsOnly = true;
+
+            Info<< "Writing processor patch fields only"
+                << nl << endl;
+        }
+    }
+
     if (nearCellValue)
     {
         Info<< "Using neighbouring cell value instead of patch value"
@@ -741,6 +770,13 @@ int main(int argc, char *argv[])
                 );
             }
 
+            if (processorFieldsOnly)
+            {
+                // Processor-patches only and continue
+                #include "convertProcessorPatches.H"
+                continue;
+            }
+
             // Volume, internal, point fields
             #include "convertVolumeFields.H"