From f0b118cfa03503c51862c7f0bef626b934eaf33a Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Tue, 10 Apr 2018 15:23:08 +0200
Subject: [PATCH] TUT: provide example using timeStart to delay starting of
 catalyst

- note that the timeEnd keyword does stop the execution of the
  function object, but does not close the connection or free up
  resources

- restructured/renamed the various cfg files in anticipation of
  relocating them to the main OpenFOAM etc/caseDicts directory in the
  future.
---
 etc/README                                       |  2 ++
 .../system/catalystArea.cfg => etc/area.cfg      | 14 +++++---------
 .../system/catalystCloud.cfg => etc/cloud.cfg    | 14 +++++---------
 .../system/catalyst.cfg => etc/default.cfg       | 14 +++-----------
 .../sphereTransport/system/area.cfg              | 16 ++++++++++++++++
 .../sphereTransport/system/catalystArea          |  3 ++-
 .../multiRegionHeater/system/catalyst            |  1 +
 .../multiRegionHeater/system/catalyst.cfg        | 11 +++--------
 .../icoFoam/cavity/system/catalyst               |  5 +++++
 .../icoFoam/cavity/system/catalyst.cfg           | 15 +++------------
 .../simplifiedSiwek/system/catalystCloud         |  3 ++-
 .../simplifiedSiwek/system/cloud.cfg             | 16 ++++++++++++++++
 12 files changed, 63 insertions(+), 51 deletions(-)
 create mode 100644 etc/README
 rename tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea.cfg => etc/area.cfg (74%)
 rename tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud.cfg => etc/cloud.cfg (74%)
 rename tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst.cfg => etc/default.cfg (75%)
 create mode 100644 tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/area.cfg
 create mode 100644 tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/cloud.cfg

diff --git a/etc/README b/etc/README
new file mode 100644
index 0000000..2d62592
--- /dev/null
+++ b/etc/README
@@ -0,0 +1,2 @@
+Collection of scripts and setups.
+- Some bits may need to migrate to the main OpenFOAM directories
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea.cfg b/etc/area.cfg
similarity index 74%
rename from tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea.cfg
rename to etc/area.cfg
index 469cb18..2f6850f 100644
--- a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea.cfg
+++ b/etc/area.cfg
@@ -5,16 +5,12 @@
 |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
-FoamFile
-{
-    version     2.0;
-    format      ascii;
-    class       dictionary;
-    object      catalystArea.cfg;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+// Insitu processing of finiteArea fields with ParaView Catalyst
 
-#include       "catalyst.cfg"
 type            catalyst::area;
+libs            ("libcatalystFoam.so");
+
+executeControl  timeStep;
+writeControl    none;
 
 // ************************************************************************* //
diff --git a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud.cfg b/etc/cloud.cfg
similarity index 74%
rename from tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud.cfg
rename to etc/cloud.cfg
index 2ddf92f..d860e90 100644
--- a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud.cfg
+++ b/etc/cloud.cfg
@@ -5,16 +5,12 @@
 |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
-FoamFile
-{
-    version     2.0;
-    format      ascii;
-    class       dictionary;
-    object      catalystCloud.cfg;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+// Insitu processing of lagrangian clouds with ParaView Catalyst
 
-#include       "catalyst.cfg"
 type            catalyst::cloud;
+libs            ("libcatalystFoam.so");
+
+executeControl  timeStep;
+writeControl    none;
 
 // ************************************************************************* //
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst.cfg b/etc/default.cfg
similarity index 75%
rename from tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst.cfg
rename to etc/default.cfg
index 73e3b03..e9ace6b 100644
--- a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalyst.cfg
+++ b/etc/default.cfg
@@ -5,20 +5,12 @@
 |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
-FoamFile
-{
-    version     2.0;
-    format      ascii;
-    class       dictionary;
-    object      catalyst.cfg;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+// Insitu processing of finiteVolume fields with ParaView Catalyst
 
 type            catalyst;
 libs            ("libcatalystFoam.so");
-executeControl  timeStep;
 
-// Fallback script(s)
-/// scripts ( );
+executeControl  timeStep;
+writeControl    none;
 
 // ************************************************************************* //
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/area.cfg b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/area.cfg
new file mode 100644
index 0000000..2f6850f
--- /dev/null
+++ b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/area.cfg
@@ -0,0 +1,16 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  plus                                  |
+|   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+// Insitu processing of finiteArea fields with ParaView Catalyst
+
+type            catalyst::area;
+libs            ("libcatalystFoam.so");
+
+executeControl  timeStep;
+writeControl    none;
+
+// ************************************************************************* //
diff --git a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea
index 163db30..1572d92 100644
--- a/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea
+++ b/tutorials/finiteArea/sphereSurfactantFoam/sphereTransport/system/catalystArea
@@ -4,7 +4,8 @@ functions
 {
     catalystArea
     {
-        #include "catalystArea.cfg";
+        #include "area.cfg";
+        // FUTURE: #includeEtc "caseDicts/postProcessing/catalyst/area.cfg"
 
         // Selected fields (words or regex)
         fields  ( ".*" );
diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
index 7a77b55..4f9bc04 100644
--- a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
+++ b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst
@@ -5,6 +5,7 @@ functions
     catalyst
     {
         #include "catalyst.cfg";
+        // FUTURE: #includeEtc "caseDicts/postProcessing/catalyst/default.cfg"
 
         // All regions
         regions  (".*");
diff --git a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst.cfg b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst.cfg
index f4dac85..e9ace6b 100644
--- a/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst.cfg
+++ b/tutorials/heatTransfer/chtMultiRegionFoam/multiRegionHeater/system/catalyst.cfg
@@ -5,17 +5,12 @@
 |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
-FoamFile
-{
-    version     2.0;
-    format      ascii;
-    class       dictionary;
-    object      catalyst.cfg;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+// Insitu processing of finiteVolume fields with ParaView Catalyst
 
 type            catalyst;
 libs            ("libcatalystFoam.so");
+
 executeControl  timeStep;
+writeControl    none;
 
 // ************************************************************************* //
diff --git a/tutorials/incompressible/icoFoam/cavity/system/catalyst b/tutorials/incompressible/icoFoam/cavity/system/catalyst
index 5e44d5e..865e199 100644
--- a/tutorials/incompressible/icoFoam/cavity/system/catalyst
+++ b/tutorials/incompressible/icoFoam/cavity/system/catalyst
@@ -5,6 +5,7 @@ functions
     catalyst
     {
         #include "catalyst.cfg";
+        // FUTURE: #includeEtc "caseDicts/postProcessing/catalyst/default.cfg"
 
         // Regions
         // regions ( );
@@ -17,6 +18,10 @@ functions
             "$FOAM_CASE/system/scripts/slice1.py"
             "$FOAM_CASE/system/scripts/writeVtm.py"
         );
+
+        // Calculate a few iterations before starting processing
+        timeStart 0.05;
+        // timeEnd   0.40
     }
 }
 
diff --git a/tutorials/incompressible/icoFoam/cavity/system/catalyst.cfg b/tutorials/incompressible/icoFoam/cavity/system/catalyst.cfg
index d171523..e9ace6b 100644
--- a/tutorials/incompressible/icoFoam/cavity/system/catalyst.cfg
+++ b/tutorials/incompressible/icoFoam/cavity/system/catalyst.cfg
@@ -5,21 +5,12 @@
 |   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
-FoamFile
-{
-    version     2.0;
-    format      ascii;
-    class       dictionary;
-    object      catalyst.cfg;
-}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+// Insitu processing of finiteVolume fields with ParaView Catalyst
 
 type            catalyst;
 libs            ("libcatalystFoam.so");
-log             false;
-executeControl  timeStep;
 
-// Fallback scripts
-// scripts ( );
+executeControl  timeStep;
+writeControl    none;
 
 // ************************************************************************* //
diff --git a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud
index 867be35..20db93f 100644
--- a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud
+++ b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/catalystCloud
@@ -4,7 +4,8 @@ functions
 {
     catalystCloud1
     {
-        #include "catalystCloud.cfg";
+        #includeEtc "cloud.cfg";
+        // FUTURE: #includeEtc "caseDicts/postProcessing/catalyst/cloud.cfg"
 
         // Selected clouds (words or regex)
         clouds  ( coalCloud1 limestoneCloud1 );
diff --git a/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/cloud.cfg b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/cloud.cfg
new file mode 100644
index 0000000..d860e90
--- /dev/null
+++ b/tutorials/lagrangian/coalChemistryFoam/simplifiedSiwek/system/cloud.cfg
@@ -0,0 +1,16 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  plus                                  |
+|   \\  /    A nd           | Web:      www.OpenFOAM.com                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+// Insitu processing of lagrangian clouds with ParaView Catalyst
+
+type            catalyst::cloud;
+libs            ("libcatalystFoam.so");
+
+executeControl  timeStep;
+writeControl    none;
+
+// ************************************************************************* //
-- 
GitLab