Add channel-transport transport OpenFOAM

.gitignore

@@ -67,10 +67,9 @@ postProcessing/
 *.foam
 *.OpenFOAM
 dynamicCode
-Make/*
-!Make/files
-!Make/options
-lnInclude/
+**/Make/*
+!**/Make/files
+!**/Make/options
 
 # CalculiX
 spooles.out

changelog-entries/551.md

@@ -0,0 +1 @@
+- Added OpenFOAM variant of the transport participant to the channel-transport tutorial.

channel-transport/README.md

@@ -45,6 +45,8 @@ Transport participant:
 
 * Nutils with support for [adaptive mesh refinement](https://precice.org/couple-your-code-moving-or-changing-meshes.html#pseudo-reference-domain). For more information, have a look at the [Nutils adapter documentation](https://precice.org/adapter-nutils.html). This solver requires a preCICE release with [remeshing support](couple-your-code-moving-or-changing-meshes.html#remeshing-using-precice).
 
+* OpenFOAM. This case uses a modified version of scalarTransportFoam, which recomputes `phi` after the preCICE adapter reads the velocity field. Find it in the `solver-openfoam` folder. Read more details in the [OpenFOAM adapter](https://precice.org/adapter-openfoam-overview.html).
+
 ## Running the simulation
 
 For the fluid solver, use Nutils for ease of installation and OpenFOAM for speed.

channel-transport/metadata.yaml

@@ -7,20 +7,26 @@ participants:
   - Transport
 
 cases:
+  fluid-nutils:
+    participant: Fluid
+    directory: ./fluid-nutils
+    run: ./run.sh
+    component: nutils-adapter
+
   fluid-openfoam:
     participant: Fluid
     directory: ./fluid-openfoam
     run: ./run.sh
     component: openfoam-adapter
 
-  fluid-nutils:
-    participant: Fluid
-    directory: ./fluid-nutils
+  transport-nutils:
+    participant: Transport
+    directory: ./transport-nutils
     run: ./run.sh
     component: nutils-adapter
 
-  transport-nutils:
+  transport-openfoam:
     participant: Transport
-    directory: ./transport-nutils
+    directory: ./transport-openfoam
     run: ./run.sh
-    component: nutils-adapter
+    component: openfoam-adapter

channel-transport/solver-openfoam/.clang-format

@@ -0,0 +1,175 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+#
+# Proposed clang-format-11 style for OpenFOAM, trying to follow the OpenFOAM style guide:
+#   https://develop.openfoam.com/Development/openfoam/-/wikis/coding/style/style
+# Configuration developed for the OpenFOAM-preCICE adapter code:
+#   https://github.com/precice/openfoam-adapter
+# Contribute to the discussion at the respective OpenFOAM issue:
+#   https://develop.openfoam.com/Development/openfoam/-/issues/1634
+#
+# Keep `public:` at the first indentation level
+AccessModifierOffset: -4
+# Undocumented guideline: align arguments after an open bracket.
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: false
+AlignConsecutiveAssignments: false
+AlignConsecutiveBitFields: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+# Align operands after operators (+,*,<<) (see BreakBeforeBinaryOperators)
+AlignOperands: AlignAfterOperator
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Always
+AllowShortLoopsOnASingleLine: false
+# Guideline: Splitting return type and function name
+# (this guideline is apparently not strictly followed in OpenFOAM)
+# AlwaysBreakAfterReturnType: All
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+# Covered by "BreakBeforeBraces"
+BraceWrapping:
+  AfterCaseLabel:  true
+  AfterClass:      true
+  AfterControlStatement: Always
+  AfterEnum:       true
+  AfterFunction:   true
+  AfterNamespace:  true
+  AfterObjCDeclaration: true
+  AfterStruct:     true
+  AfterUnion:      true
+  AfterExternBlock: true
+  BeforeCatch:     true
+  BeforeElse:      true
+  BeforeLambdaBody: true
+  BeforeWhile:     true
+  IndentBraces:    true
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+# Guideline (almost): Splitting long lines at an = sign. Indent after split.
+# Guideline (almost): Splitting formulae over several lines.
+BreakBeforeBinaryOperators: NonAssignment
+# Always break before braces: if, for, functions, classes, etc.
+BreakBeforeBraces: Allman
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+# Guideline (almost): Splitting logical tests over several lines.
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+# Undocumented guideline (almost): Have the initializer : in a new line.
+BreakConstructorInitializers: BeforeColon
+BreakStringLiterals: true
+# Here we could set the 80 charactes limit, but that would lead to more aggressive changes.
+ColumnLimit:     0
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 0
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+# Undocumented guideline: add line after "public:" etc (since clang-format 12)
+# EmptyLineAfterAccessModifier: Always
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: false
+# Guideline: Macro loops are like for loops, but without a space.
+ForEachMacros:
+  - forAllIters
+  - forAllConstIters
+  - forAllReverseIters
+  - forAllConstReverseIters
+  - forAll
+  - forAllReverse
+  - forAllIter
+  - forAllConstIter
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+# Guideline: The normal indentation is 4 spaces per logical level.
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+# Required to not change code following the guidelines
+# "Leave two empty lines between sections" and
+# "Use two empty lines between functions"
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: None
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+ReflowComments:  true
+# Do not change the order of include statements (could be catastrophic for OpenFOAM)
+SortIncludes:    false
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+# No "template <T>" (guideline already used, but not documented)
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+# No a{1} (no guideline)
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+# Guideline: Spaces in "if ()", "for ()", but not "forAll ()".
+SpaceBeforeParens: ControlStatementsExceptForEachMacros
+# Guideline: Range-based for should have a space surrounding the ':'.
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInConditionalStatement: false
+# No "arr[3] = [ 1, 2, 3 ]" (no guideline).
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+# Treat the code as C++11 or later
+Standard:        Latest
+StatementMacros:
+TabWidth:        4
+UseCRLF:         false
+# Guideline: No tab characters - only use spaces for indentation.
+UseTab:          Never
+WhitespaceSensitiveMacros:
+...
+

channel-transport/solver-openfoam/Make/files

@@ -0,0 +1,3 @@
+dynamicScalarTransportFoam.C
+
+EXE = $(FOAM_USER_APPBIN)/dynamicScalarTransportFoam

channel-transport/solver-openfoam/Make/options

@@ -0,0 +1,10 @@
+EXE_INC = \
+    -I$(LIB_SRC)/finiteVolume/lnInclude \
+    -I$(LIB_SRC)/meshTools/lnInclude \
+    -I$(LIB_SRC)/sampling/lnInclude
+
+EXE_LIBS = \
+    -lfiniteVolume \
+    -lfvOptions \
+    -lmeshTools \
+    -lsampling

channel-transport/solver-openfoam/clean.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+set -e -u
+
+wclean

channel-transport/solver-openfoam/createFields.H

@@ -0,0 +1,43 @@
+Info << "Reading field T\n"
+     << endl;
+
+volScalarField T(
+    IOobject(
+        "T",
+        runTime.timeName(),
+        mesh,
+        IOobject::MUST_READ,
+        IOobject::AUTO_WRITE),
+    mesh);
+
+Info << "Reading field U\n"
+     << endl;
+
+volVectorField U(
+    IOobject(
+        "U",
+        runTime.timeName(),
+        mesh,
+        IOobject::MUST_READ,
+        IOobject::AUTO_WRITE),
+    mesh);
+
+Info << "Reading transportProperties\n"
+     << endl;
+
+IOdictionary transportProperties(
+    IOobject(
+        "transportProperties",
+        runTime.constant(),
+        mesh,
+        IOobject::MUST_READ_IF_MODIFIED,
+        IOobject::NO_WRITE));
+
+Info << "Reading diffusivity DT\n"
+     << endl;
+
+dimensionedScalar DT("DT", dimViscosity, transportProperties);
+
+#include "createPhi.H"
+
+#include "createFvOptions.H"

channel-transport/solver-openfoam/dynamicScalarTransportFoam.C

@@ -0,0 +1,63 @@
+//
+// This file is based on the OpenFOAM example application scalarTransportFoam
+//
+// GitLab link: https://gitlab.com/openfoam/core/openfoam/-/tree/master/applications/solvers/basic/scalarTransportFoam
+//
+// This modified version doesn't expect a static velocity field U, instead, it repomputes it every time step.
+// Therefore it allows the preCICE adapter to provide the velocities.
+
+#include "fvCFD.H"
+#include "fvOptions.H"
+#include "simpleControl.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+int main(int argc, char* argv[])
+{
+    argList::addNote(
+        "Dynamic scalar transport equation solver.");
+
+#include "addCheckCaseOptions.H"
+#include "setRootCaseLists.H"
+#include "createTime.H"
+#include "createMesh.H"
+
+    simpleControl simple(mesh);
+
+#include "createFields.H"
+
+    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+    Info << "\nCalculating scalar transport\n"
+         << endl;
+
+    while (simple.loop())
+    {
+        Info << "Time = " << runTime.timeName() << nl << endl;
+
+        Info << "Recompute phi" << endl;
+        fvOptions.correct(U);
+        phi = fvc::flux(U);
+#include "CourantNo.H"
+
+        while (simple.correctNonOrthogonal())
+        {
+            fvScalarMatrix TEqn(
+                fvm::ddt(T) + fvm::div(phi, T) - fvm::laplacian(DT, T) == fvOptions(T));
+
+            TEqn.relax();
+            fvOptions.constrain(TEqn);
+            TEqn.solve();
+            fvOptions.correct(T);
+        }
+
+        runTime.write();
+    }
+
+    Info << "End\n"
+         << endl;
+
+    return 0;
+}
+
+// ************************************************************************* //

channel-transport/transport-openfoam/.gitignore

@@ -0,0 +1 @@
+0/