Merge pull request ITHACA-FV#602 from Ruansh233/tutorial_parallelization

giovastabile · web-flow · commit d3083b0e3f62 · 2025-08-28T11:31:03.000+02:00
Tutorial parallelization
diff --git a/applications/POD/perform_POD.C b/applications/POD/perform_POD.C
@@ -84,10 +84,7 @@ int main(int argc, char *argv[])
     {
         pod_exist = false;
         Info << "POD don't exist, performing a POD decomposition" << endl;
-        mkDir("./ITHACAoutput/POD");
-        system("ln -s ../../constant ./ITHACAoutput/POD/constant");
-        system("ln -s ../../0 ./ITHACAoutput/POD/0");
-        system("ln -s ../../system ./ITHACAoutput/POD/system");
+        ITHACAutilities::createSymLink("./ITHACAoutput/POD");
     }
     if(pod_exist == 1)
     {
diff --git a/src/ITHACA_FOMPROBLEMS/steadyNS/steadyNS.C b/src/ITHACA_FOMPROBLEMS/steadyNS/steadyNS.C
@@ -1323,7 +1323,10 @@ Eigen::MatrixXd steadyNS::pressure_BC1(label NUmodes, label NPmodes)
 
             for (label k = 0; k < lpl.boundaryField().size(); k++)
             {
-                s += gSum(lpl.boundaryField()[k]);
+                if (lpl.boundaryField()[k].type() != "processor")
+                {
+                    s += gSum(lpl.boundaryField()[k]);
+                }
             }
 
             BC1_matrix(i, j) = s;
@@ -1366,7 +1369,10 @@ List <Eigen::MatrixXd> steadyNS::pressure_BC2(label NUmodes, label NPmodes)
 
                 for (label k = 0; k < div_m.boundaryField().size(); k++)
                 {
-                    s += gSum(div_m.boundaryField()[k]);
+                    if (div_m.boundaryField()[k].type() != "processor")
+                    {
+                        s += gSum(div_m.boundaryField()[k]);
+                    }
                 }
 
                 BC2_matrix[i](j, k) = s;
@@ -1398,7 +1404,10 @@ Eigen::Tensor<double, 3> steadyNS::pressureBC2(label NUmodes, label NPmodes)
 
                 for (label k = 0; k < div_m.boundaryField().size(); k++)
                 {
-                    s += gSum(div_m.boundaryField()[k]);
+                    if (div_m.boundaryField()[k].type() != "processor")
+                    {
+                        s += gSum(div_m.boundaryField()[k]);
+                    }
                 }
 
                 bc2Tensor(i, j, k) = s;
@@ -1434,7 +1443,10 @@ Eigen::MatrixXd steadyNS::pressure_BC3(label NUmodes, label NPmodes)
             double s = 0;
             for (label k = 0; k < BC5.boundaryField().size(); k++)
             {
-                s += gSum(BC5.boundaryField()[k]);
+                if (BC5.boundaryField()[k].type() != "processor")
+                {
+                    s += gSum(BC5.boundaryField()[k]);
+                }
             }
 
             BC3_matrix(i, j) = s;
@@ -1468,7 +1480,10 @@ Eigen::MatrixXd steadyNS::pressure_BC4(label NUmodes, label NPmodes)
 
             for (label k = 0; k < BC5.boundaryField().size(); k++)
             {
-                s += gSum(BC5.boundaryField()[k]);
+                if (BC5.boundaryField()[k].type() != "processor")
+                {
+                    s += gSum(BC5.boundaryField()[k]);
+                }
             }
 
             BC4_matrix(i, j) = s;
diff --git a/tutorials/CFD/01POD/Allclean b/tutorials/CFD/01POD/Allclean
@@ -6,7 +6,8 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial clean functions
 . $WM_PROJECT_DIR/bin/tools/CleanFunctions
 
-runApplication foamListTimes -rm
+cleanTimeDirectories
+rm -rf processor* &> /dev/null
 
 rm -r ITHACAoutput
 rm log.*
diff --git a/tutorials/CFD/01POD/Allrun_parallel b/tutorials/CFD/01POD/Allrun_parallel
@@ -0,0 +1,9 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+runParallel icoFoam
+runParallel perform_POD
diff --git a/tutorials/CFD/01POD/README.md b/tutorials/CFD/01POD/README.md
@@ -43,3 +43,9 @@ Eventually, instead of the finalTime you could define the number of snapshots
 
     // a fake class just to print out the doxygen documentation
     class fake
+
+## Parallel running
+
+Please modify the setup in __decomposeParDict__ to the number of processors you need.
+
+The case can run in parallel with the script `Allrun_parallel`.
diff --git a/tutorials/CFD/01POD/system/decomposeParDict b/tutorials/CFD/01POD/system/decomposeParDict
@@ -0,0 +1,23 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Version:  6
+     \\/     M anipulation  |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    location    "system";
+    object      decomposeParDict;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+numberOfSubdomains 4;
+
+method          scotch;
+
+
+// ************************************************************************* //
diff --git a/tutorials/CFD/02thermalBlock/02thermalBlock.C b/tutorials/CFD/02thermalBlock/02thermalBlock.C
@@ -79,7 +79,7 @@ class tutorial02: public laplacianProblem
                 {
                     for (label j = 0; j < mu.cols() ; j++)
                     {
-                        // mu_now[i] =
+                        mu_now[j] = mu(i, j);
                         theta[j] = mu(i, j);
                     }
 
diff --git a/tutorials/CFD/02thermalBlock/Allclean b/tutorials/CFD/02thermalBlock/Allclean
@@ -6,6 +6,7 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial clean functions
 . $WM_PROJECT_DIR/bin/tools/CleanFunctions
 
+rm -rf processor* &> /dev/null
 rm -r ITHACAoutput
-rm -r *.foam
+rm -rf *.foam &> /dev/null
 rm log.*
diff --git a/tutorials/CFD/02thermalBlock/Allrun_parallel b/tutorials/CFD/02thermalBlock/Allrun_parallel
@@ -0,0 +1,8 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+runParallel 02thermalBlock -stage online
diff --git a/tutorials/CFD/02thermalBlock/README.md b/tutorials/CFD/02thermalBlock/README.md
@@ -282,3 +282,5 @@ reduced matrices on the whole domain
 The online stage is performed analogously
 
     mpirun -np 4 02thermalBlock -stage online -parallel
+
+Or the users can simple run the script `Allrun_parallel`.
diff --git a/tutorials/CFD/03steadyNS/Allclean b/tutorials/CFD/03steadyNS/Allclean
@@ -6,6 +6,9 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial clean functions
 . $WM_PROJECT_DIR/bin/tools/CleanFunctions
 
+rm -rf processor* &> /dev/null
+rm -rf lift/processor* &> /dev/null
+
 rm -r ITHACAoutput
 rm -r *.foam
 rm log.*
diff --git a/tutorials/CFD/03steadyNS/Allrun_parallel b/tutorials/CFD/03steadyNS/Allrun_parallel
@@ -0,0 +1,10 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+rm -rf log.decomposePar &> /dev/null
+runApplication decomposePar -case lift -time '0:10' -decomposeParDict ../system/decomposeParDict
+runParallel 03steadyNS -stage online
diff --git a/tutorials/CFD/03steadyNS/README.md b/tutorials/CFD/03steadyNS/README.md
@@ -177,7 +177,7 @@ First, the domain is decomposed as indicated in the directory
 
 In the parallel run also the lift field needs to be split with
 
-    decomposePar -time 0,1
+    decomposePar -case lift -time 0,1
 
 Then, the offline solve is performed in parallel, evaluating the modes and the
 reduced matrices on the whole domain
@@ -188,4 +188,6 @@ The online stage is performed analogously
 
     mpirun -np 4 -quiet 03steadyNS -parallel -stage online
 
+Or the users can simple run the script `Allrun_parallel`.
+
 In the case of OF1812 the parallel run is not supported.
diff --git a/tutorials/CFD/04unsteadyNS/Allclean b/tutorials/CFD/04unsteadyNS/Allclean
@@ -6,6 +6,9 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial clean functions
 . $WM_PROJECT_DIR/bin/tools/CleanFunctions
 
+rm -rf processor* &> /dev/null
+rm -rf lift/processor* &> /dev/null
+
 rm -r ITHACAoutput
 rm -r *.foam
 rm log.*
diff --git a/tutorials/CFD/04unsteadyNS/Allrun_parallel b/tutorials/CFD/04unsteadyNS/Allrun_parallel
@@ -0,0 +1,11 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+## use if the Dirichlet is treated with lifting functions
+# rm log.decomposePar
+# runApplication decomposePar -case lift -time '0:10' -decomposeParDict ../system/decomposeParDict
+runParallel 04unsteadyNS
diff --git a/tutorials/CFD/05PODI/Allclean b/tutorials/CFD/05PODI/Allclean
@@ -6,6 +6,9 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial clean functions
 . $WM_PROJECT_DIR/bin/tools/CleanFunctions
 
+rm -rf processor* &> /dev/null
+rm -rf lift/processor* &> /dev/null
+
 rm -r ITHACAoutput
 rm -r *.foam
 rm log.*
diff --git a/tutorials/CFD/05PODI/Allrun b/tutorials/CFD/05PODI/Allrun
@@ -4,4 +4,4 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Source tutorial run functions
 . $WM_PROJECT_DIR/bin/tools/RunFunctions
 
-runApplication 03steadyNS
+runApplication 05PODI
diff --git a/tutorials/CFD/05PODI/Allrun_parallel b/tutorials/CFD/05PODI/Allrun_parallel
@@ -0,0 +1,11 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+## use if the Dirichlet is treated with lifting functions
+rm log.decomposePar
+runApplication decomposePar -case lift -time '0:10' -decomposeParDict ../system/decomposeParDict
+runParallel 05PODI
diff --git a/tutorials/CFD/05PODI/system/decomposeParDict b/tutorials/CFD/05PODI/system/decomposeParDict
@@ -0,0 +1,30 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  4.x                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    object      decomposeParDict;
+}
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+numberOfSubdomains 4;
+
+method          simple;
+// method          ptscotch;
+
+simpleCoeffs
+{
+    n               (4 1 1);
+    delta           0.001;
+}
+
+
+// ************************************************************************* //
diff --git a/tutorials/CFD/06POD_RBF/Allclean b/tutorials/CFD/06POD_RBF/Allclean
@@ -0,0 +1,14 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+# Source tutorial clean functions
+. $WM_PROJECT_DIR/bin/tools/CleanFunctions
+
+rm -rf processor* &> /dev/null
+rm -rf lift/processor* &> /dev/null
+
+rm -r ITHACAoutput
+rm -r *.foam
+rm log.*
diff --git a/tutorials/CFD/06POD_RBF/Allrun b/tutorials/CFD/06POD_RBF/Allrun
@@ -0,0 +1,7 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication 06POD_RBF
diff --git a/tutorials/CFD/06POD_RBF/Allrun_parallel b/tutorials/CFD/06POD_RBF/Allrun_parallel
@@ -0,0 +1,11 @@
+#!/bin/sh
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Source tutorial run functions
+. $WM_PROJECT_DIR/bin/tools/RunFunctions
+
+runApplication decomposePar
+## use if the Dirichlet is treated with lifting functions
+rm log.decomposePar
+runApplication decomposePar -case lift -time '0:10' -decomposeParDict ../system/decomposeParDict
+runParallel 06POD_RBF
diff --git a/tutorials/CFD/06POD_RBF/system/decomposeParDict b/tutorials/CFD/06POD_RBF/system/decomposeParDict
@@ -0,0 +1,30 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  4.x                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    object      decomposeParDict;
+}
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+numberOfSubdomains 4;
+
+method          simple;
+// method          ptscotch;
+
+simpleCoeffs
+{
+    n               (4 1 1);
+    delta           0.001;
+}
+
+
+// ************************************************************************* //

Original file line number	Diff line number	Diff line change
`@@ -84,10 +84,7 @@ int main(int argc, char *argv[])`
`84`	`84`	`{`
`85`	`85`	`pod_exist = false;`
`86`	`86`	`Info << "POD don't exist, performing a POD decomposition" << endl;`
`87`		`- mkDir("./ITHACAoutput/POD");`
`88`		`- system("ln -s ../../constant ./ITHACAoutput/POD/constant");`
`89`		`- system("ln -s ../../0 ./ITHACAoutput/POD/0");`
`90`		`- system("ln -s ../../system ./ITHACAoutput/POD/system");`
	`87`	`+ ITHACAutilities::createSymLink("./ITHACAoutput/POD");`
`91`	`88`	`}`
`92`	`89`	`if(pod_exist == 1)`
`93`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1323,7 +1323,10 @@ Eigen::MatrixXd steadyNS::pressure_BC1(label NUmodes, label NPmodes)`
`1323`	`1323`
`1324`	`1324`	`for (label k = 0; k < lpl.boundaryField().size(); k++)`
`1325`	`1325`	`{`
`1326`		`- s += gSum(lpl.boundaryField()[k]);`
	`1326`	`+ if (lpl.boundaryField()[k].type() != "processor")`
	`1327`	`+ {`
	`1328`	`+ s += gSum(lpl.boundaryField()[k]);`
	`1329`	`+ }`
`1327`	`1330`	`}`
`1328`	`1331`
`1329`	`1332`	`BC1_matrix(i, j) = s;`
`@@ -1366,7 +1369,10 @@ List <Eigen::MatrixXd> steadyNS::pressure_BC2(label NUmodes, label NPmodes)`
`1366`	`1369`
`1367`	`1370`	`for (label k = 0; k < div_m.boundaryField().size(); k++)`
`1368`	`1371`	`{`
`1369`		`- s += gSum(div_m.boundaryField()[k]);`
	`1372`	`+ if (div_m.boundaryField()[k].type() != "processor")`
	`1373`	`+ {`
	`1374`	`+ s += gSum(div_m.boundaryField()[k]);`
	`1375`	`+ }`
`1370`	`1376`	`}`
`1371`	`1377`
`1372`	`1378`	`BC2_matrix[i](j, k) = s;`
`@@ -1398,7 +1404,10 @@ Eigen::Tensor<double, 3> steadyNS::pressureBC2(label NUmodes, label NPmodes)`
`1398`	`1404`
`1399`	`1405`	`for (label k = 0; k < div_m.boundaryField().size(); k++)`
`1400`	`1406`	`{`
`1401`		`- s += gSum(div_m.boundaryField()[k]);`
	`1407`	`+ if (div_m.boundaryField()[k].type() != "processor")`
	`1408`	`+ {`
	`1409`	`+ s += gSum(div_m.boundaryField()[k]);`
	`1410`	`+ }`
`1402`	`1411`	`}`
`1403`	`1412`
`1404`	`1413`	`bc2Tensor(i, j, k) = s;`
`@@ -1434,7 +1443,10 @@ Eigen::MatrixXd steadyNS::pressure_BC3(label NUmodes, label NPmodes)`
`1434`	`1443`	`double s = 0;`
`1435`	`1444`	`for (label k = 0; k < BC5.boundaryField().size(); k++)`
`1436`	`1445`	`{`
`1437`		`- s += gSum(BC5.boundaryField()[k]);`
	`1446`	`+ if (BC5.boundaryField()[k].type() != "processor")`
	`1447`	`+ {`
	`1448`	`+ s += gSum(BC5.boundaryField()[k]);`
	`1449`	`+ }`
`1438`	`1450`	`}`
`1439`	`1451`
`1440`	`1452`	`BC3_matrix(i, j) = s;`
`@@ -1468,7 +1480,10 @@ Eigen::MatrixXd steadyNS::pressure_BC4(label NUmodes, label NPmodes)`
`1468`	`1480`
`1469`	`1481`	`for (label k = 0; k < BC5.boundaryField().size(); k++)`
`1470`	`1482`	`{`
`1471`		`- s += gSum(BC5.boundaryField()[k]);`
	`1483`	`+ if (BC5.boundaryField()[k].type() != "processor")`
	`1484`	`+ {`
	`1485`	`+ s += gSum(BC5.boundaryField()[k]);`
	`1486`	`+ }`
`1472`	`1487`	`}`
`1473`	`1488`
`1474`	`1489`	`BC4_matrix(i, j) = s;`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ class tutorial02: public laplacianProblem`
`79`	`79`	`{`
`80`	`80`	`for (label j = 0; j < mu.cols() ; j++)`
`81`	`81`	`{`
`82`		`- // mu_now[i] =`
	`82`	`+ mu_now[j] = mu(i, j);`
`83`	`83`	`theta[j] = mu(i, j);`
`84`	`84`	`}`
`85`	`85`