From e8d1fe024fda585e78ef60c9cbe3b33797531d02 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 21 Jun 2018 21:33:50 +0200
Subject: [PATCH] STYLE: remove 'functions' dictionary scope from catalyst
 files

- relocate to controlDict, since more than a single function object
  is often used.
---
 src/catalyst/catalystDict                     | 92 +++++++++----------
 .../sphereTransport/system/catalyst           | 27 +++---
 .../sphereTransport/system/controlDict        |  5 +-
 .../multiRegionHeater/system/catalyst         | 36 ++++----
 .../multiRegionHeater/system/controlDict      |  5 +-
 .../icoFoam/cavity/system/catalyst            | 38 ++++----
 .../icoFoam/cavity/system/controlDict         |  6 +-
 .../simplifiedSiwek/system/catalyst           | 47 +++++-----
 .../simplifiedSiwek/system/controlDict        |  6 +-
 9 files changed, 134 insertions(+), 128 deletions(-)

diff --git a/src/catalyst/catalystDict b/src/catalyst/catalystDict
index ff7bd1f..e07f0b8 100644
--- a/src/catalyst/catalystDict
+++ b/src/catalyst/catalystDict
@@ -1,58 +1,58 @@
 // ParaView Catalyst function object for OpenFOAM (-*- C++ -*-)
 
-functions
+catalyst
 {
-    catalyst
+    type    catalyst;
+    libs    ("libcatalystFoam.so");
+
+    executeControl  timeStep;
+    writeControl    none;
+
+    // ^^^^^
+    // #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+
+
+    // mkdir  "<case>/someDir";
+
+    scripts
+    (
+        // "<etc>/caseDicts/insitu/catalyst/printChannels.py"
+        "<etc>/caseDicts/insitu/catalyst/writeAll.py"
+    );
+
+    inputs
     {
-        type    catalyst;
-        libs    ("libcatalystFoam.so");
-        executeControl  timeStep;
-        writeControl    none;
+        // fvMesh
+        region
+        {
+            type    default;
 
-        // OR #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+            // All regions
+            regions (".*");
 
-        // mkdir  "<case>/someDir";
+            // Selected fields (words or regex)
+            fields  (T U p);
+        }
+
+        // faMesh
+        area
+        {
+            type    area;
 
-        scripts
-        (
-            // "<etc>/caseDicts/insitu/catalyst/printChannels.py"
-            "<etc>/caseDicts/insitu/catalyst/writeAll.py"
-        );
+            // Selected fields (words or regex)
+            fields  ( ".*" );
+        }
 
-        inputs
+        // lagrangian
+        cloud
         {
-            // fvMesh
-            region
-            {
-                type    default;
-
-                // All regions
-                regions (".*");
-
-                // Selected fields (words or regex)
-                fields  (T U p);
-            }
-
-            // faMesh
-            area
-            {
-                type    area;
-
-                // Selected fields (words or regex)
-                fields  ( ".*" );
-            }
-
-            // lagrangian
-            cloud
-            {
-                type    cloud;
-
-                // Selected clouds (words or regex)
-                clouds  ( coalCloud1 limestoneCloud1 );
-
-                // Selected fields (words or regex)
-                fields  ( T U p rho "Y.*" );
-            }
+            type    cloud;
+
+            // Selected clouds (words or regex)
+            clouds  ( coalCloud1 limestoneCloud1 );
+
+            // Selected fields (words or regex)
+            fields  ( T U p rho "Y.*" );
         }
     }
 }
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst
index 66b2730..67e90c7 100644
--- a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst
+++ b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst
@@ -1,23 +1,22 @@
 // ParaView Catalyst function object for OpenFOAM (-*- C++ -*-)
 
-functions
+catalyst
 {
-    catalyst
-    {
-        #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
-        scripts
-        (
-            "<system>/scripts/writeArea.py"
-        );
+    #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+
+    scripts
+    (
+        "<system>/scripts/writeArea.py"
+    );
 
-        inputs
+    inputs
+    {
+        // channel = area
+        area
         {
-            area
-            {
-                type    area;
+            type    area;
 
-                fields  ( ".*" );
-            }
+            fields  ( ".*" );
         }
     }
 }
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/controlDict b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/controlDict
index 2887b91..0741035 100644
--- a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/controlDict
+++ b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/controlDict
@@ -43,6 +43,9 @@ timePrecision       6;
 
 runTimeModifiable   yes;
 
-#include   "catalyst"
+functions
+{
+    #include "catalyst"
+}
 
 // ************************************************************************* //
diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
index 45f1cbd..0823255 100644
--- a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
+++ b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
@@ -1,29 +1,27 @@
 // ParaView Catalyst function object for OpenFOAM (-*- C++ -*-)
 
-functions
+catalyst
 {
-    catalyst
-    {
-        #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+    #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
 
-        scripts
-        (
-            "<system>/scripts/slice1.py"
-            "<system>/scripts/writePatches.py"
-            // "<etc>/caseDicts/insitu/catalyst/printChannels.py"
-            // "<etc>/caseDicts/insitu/catalyst/writeAll.py"
-        );
+    scripts
+    (
+        "<system>/scripts/slice1.py"
+        "<system>/scripts/writePatches.py"
+        // "<etc>/caseDicts/insitu/catalyst/printChannels.py"
+        // "<etc>/caseDicts/insitu/catalyst/writeAll.py"
+    );
 
-        inputs
+    inputs
+    {
+        // channel = region, region/mesh, region/patches
+        region
         {
-            region
-            {
-                // All regions
-                regions (".*");
+            // All regions
+            regions (".*");
 
-                // Selected fields (words or regex)
-                fields  (T U p);
-            }
+            // Selected fields (words or regex)
+            fields  (T U p);
         }
     }
 }
diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/controlDict b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/controlDict
index 3ab1df9..e2b860c 100644
--- a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/controlDict
+++ b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/controlDict
@@ -52,6 +52,9 @@ maxDi           10.0;
 
 adjustTimeStep  yes;
 
-#include "catalyst"
+functions
+{
+    #include "catalyst"
+}
 
 // ************************************************************************* //
diff --git a/tutorials/incompressible/icoFoam/cavity/system/catalyst b/tutorials/incompressible/icoFoam/cavity/system/catalyst
index ebb7762..55aa9b2 100644
--- a/tutorials/incompressible/icoFoam/cavity/system/catalyst
+++ b/tutorials/incompressible/icoFoam/cavity/system/catalyst
@@ -1,31 +1,29 @@
 // ParaView Catalyst function object for OpenFOAM (-*- C++ -*-)
 
-functions
+catalyst
 {
-    catalyst
-    {
-        #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+    #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
 
-        scripts
-        (
-            "<system>/scripts/slice1.py"
-            "<system>/scripts/writeMesh.py"
-        );
+    scripts
+    (
+        "<system>/scripts/slice1.py"
+        "<system>/scripts/writeMesh.py"
+    );
 
-        // Calculate a few iterations before starting processing
-        timeStart 0.05;
+    // Calculate a few iterations before starting processing
+    timeStart 0.05;
 
-        // For testing: force endTime of catalyst and simulation
-        // timeEnd   0.1;
-        // "/endTime"    0.15;
+    // For testing: force endTime of catalyst and simulation
+    // timeEnd   0.1;
+    // "/endTime"    0.15;
 
-        inputs
+    inputs
+    {
+        // channel = region, region/mesh, region/patches
+        region
         {
-            region
-            {
-                // Selected fields (words or regex)
-                fields  (U p);
-            }
+            // Selected fields (words or regex)
+            fields  (U p);
         }
     }
 }
diff --git a/tutorials/incompressible/icoFoam/cavity/system/controlDict b/tutorials/incompressible/icoFoam/cavity/system/controlDict
index 121fc68..2c89a6a 100644
--- a/tutorials/incompressible/icoFoam/cavity/system/controlDict
+++ b/tutorials/incompressible/icoFoam/cavity/system/controlDict
@@ -45,7 +45,9 @@ timePrecision   6;
 
 runTimeModifiable true;
 
-#include "catalyst"
-
+functions
+{
+    #include "catalyst"
+}
 
 // ************************************************************************* //
diff --git a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalyst b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalyst
index 3a3aba3..48246a8 100644
--- a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalyst
+++ b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalyst
@@ -1,37 +1,36 @@
 // ParaView Catalyst function object for OpenFOAM (-*- C++ -*-)
 
-functions
+catalyst
 {
-    catalyst
-    {
-        #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
+    #includeEtc "caseDicts/insitu/catalyst/catalyst.cfg"
 
-        scripts
-        (
-            "<system>/scripts/writeCloud.py"
-            "<system>/scripts/writePatches.py"
-        );
+    scripts
+    (
+        "<system>/scripts/writeCloud.py"
+        "<system>/scripts/writePatches.py"
+    );
 
-        inputs
+    inputs
+    {
+        // channel = region, region/mesh, region/patches
+        region
         {
-            region
-            {
-                type    default;
+            type    default;
 
-                // Selected fields (words or regex)
-                fields  ( T U p rho );
-            }
+            // Selected fields (words or regex)
+            fields  ( T U p rho );
+        }
 
-            cloud
-            {
-                type    cloud;
+        // channel = cloud
+        cloud
+        {
+            type    cloud;
 
-                // Selected clouds (words or regex)
-                clouds  ( coalCloud1 limestoneCloud1 );
+            // Selected clouds (words or regex)
+            clouds  ( coalCloud1 limestoneCloud1 );
 
-                // Selected fields (words or regex)
-                fields  ( T U p rho "Y.*" );
-            }
+            // Selected fields (words or regex)
+            fields  ( T U p rho "Y.*" );
         }
     }
 }
diff --git a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/controlDict b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/controlDict
index 224ef16..ec0d86f 100644
--- a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/controlDict
+++ b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/controlDict
@@ -51,6 +51,10 @@ maxCo           1.0;
 
 maxDeltaT       1;
 
-#include "catalyst"
+
+functions
+{
+    #include "catalyst"
+}
 
 // ************************************************************************* //
-- 
GitLab